+

node-red-contrib-orion

Node-RED nodes to talk to Orion.

Orion is an Advanced Communication Platform for instant team communications across any device, on any network, without boundaries. The primary Orion Application is Push-To-Talk, where users can speak-to and be heard-by groups using the Orion Smartphone Applications for iOS and Android, and using specialized devices such as the Orion Onyx.

In addition to speaking to people, users can speak to 'things'. Using Orion's Voice Superpowers users can build Bots that respond to voice commands, user actions, and other knowledge about the user's state (location, geo-fencing, etc).

Orion is Push-to-Talk with SUPERPOWERS!

Orion Aster

The Open Source node-red-contrib-orion Project is intended for use by developers and end-users who wish to install and run their own Node-RED instance.

For Orion Pro users, Orion offers Aster, a hosted version of Node-RED with node-red-contrib-orion pre-installed. For more information please contact Orion Sales.

Install

Run the following command in your Node-RED user directory - typically ~/.node-red

$ npm install node-red-contrib-orion

Requirements

To use these nodes you must have an Orion account.

We recommend starting off by creating an Orion Organization so you can manage multiple accounts.

You can also sign up from the free Orion App on your iOS or Android Smartphone.

Once you have an account, you will need to use the Orion Management Console to get the various keys you will need to configure nodes.

Usage

Provides several nodes for receiving, transmitting, decoding & encoding messages, as well as a node for retrieving user & group info from Orion.

Encode, Decode and Lookup Nodes act as Transforms, and are intended to be used in-line (or piped) between Terminal Nodes. That is, they'll accept input msgs, and append new fields to the msg on output.

Input/Receive (Orion RX)

Orion input node, used to receive Events from a specified Orion Group.

There are several Event Types, but the two significant ones are 'User Status' and 'PTT'.

Output/Transmit (Orion TX)

Orion Output Node, used to send Events to a specified Orion Group or User.

Decoding Orion Audio (Orion Decode)

Orion uses a proprietary framing for PTT Media. To decode these messages use the Orion Decode node.

By connecting the output of the Receive Node to the input of the Decode node, media will be decoded to media_wav. From there you can use the resulting WAV file as an input to any other node, for example, IBM Watson Speech-to-Text.

Encoding Orion Audio (Orion Encode)

Input & Output Node for encoding WAV to Orion's Audio format. Supports encoding either a binary buffer or a file at a specified URL.

Looking Up Users & Groups (Orion Lookup)

Input & Output Node for looking-up Orion User & Group information.

Configure

For Orion RX, Orion TX, and Orion Lookup Nodes, you'll need to create at least one Orion Config configuration. When you first add one of these Nodes to a Flow, you'll see that the config is blank:

Click the Edit/Pencil next to Add new orion_config... and enter your Orion Login and Group information, then click Save:

Examples

See examples/ for many examples!

Support

For help with this or other Orion products, please see Orion Labs Support or email us at [email protected]

Copyright & License

Copyright 2020 Orion Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.