node-red-contrib-shure-ad4 v0.1.0

node-red-contrib-shure-ad4

This Node-RED module allows you to send and receive messages to and from Shure wireless microphone receivers of the Axient® Digital product line. It has currently only been tested with the AD4Q receiver but should also work with the AD4D receiver.

Shure AD4 Receiver Config Node

Name Used for display purposes in the editor and in the message topic (see AD4 response node and AD4 sample node for details on the message topic).

Host The IP address or hostname of your Shure AD4 device.

Meter rate (ms) The AD4 receivers can send metering data in intervals between 100 and 65535 milliseconds. Use the AD4 sample node to receive them. Set it to 0 to disable it (default).

Shure AD4 Request Node

Use the request node to send messages to a receiver. There are three options to pass the necessary data to the node.

Option 1 – Object in the msg.payload

Pass an object with the following structure as payload to the node:

{
    commandType: "SET",  // GET or SET
    command: "FLASH", // See commands section for details on the commands.
    channel: "1", // Optional, depending on the command.
    value: "ON" // Optional, depending on the command.
}

Option 2 – Topic

Pass a topic (msg.topic) with the following structure to the node. The value goes into the msg.payload.

For commands with channel: [COMMAND_TYPE]/[COMMAND]/[CHANNEL]

For commands without channel: [COMMAND_TYPE]/[COMMAND]

Example:

msg.topic = “SET/FLASH/1”;
msg.payload = “ON”;

Option 3 – Node properties

You can also set the necessary information in the node properties. Command type and Command are required. Channel is optional. The value has to be in the msg.payload.

Shure AD4 Response Node

Use the response node to receive REP messages sent by a receiver. The node sends a msg with a topic in the following format and the value or object as msg.payload.

[RECEIVER_NAME]/REP/[COMMAND]/[CHANNEL]

E.g.: Receiver-1/REP/FLASH/1 with payload "ON".

If you set the node property Topic prefix the topic format is as follows:

[TOPIC_PREFIX]/[RECEIVER_NAME]/REP/[COMMAND]/[CHANNEL]

You can use the Command and Channel properties of the node to filter for a specific command and/or channel.

Shure AD4 Sample Node

The sample node is used to receive sample messages, which are sent periodically by the receiver. You can set the interval in the receiver config node (Meter rate (ms) property). A sample message from a receiver contains several values. You can choose between two ways in which the node will handle these values by changing the Mode property of the node. With the option “One msg per value” the node sends a msg for each value. The values can be filtered via the Commands property of the node. The msg is structured as follows:

[TOPIC_PREFIX]/[RECEIVER_NAME]/SAMPLE/[COMMAND]/[CHANNEL]

With the option "One msg with all values" the node sends a single msg object including all values as an object in the payload. The Commands filter property has no effect in this mode. The object is structured as follows:

{
    	"raw": "< SAMPLE 3 ALL 255 000 005 020 XX 00 005 00 006 >",
        "host": "192.168.178.188",
        "name": "Node name",
    	"commandType": "SAMPLE",
    	"channel": 3,
    	"qual": 255,
    	"audBitmap": 0,
    	"audPeak": 5,
    	"audRms": 20,
    	"rfAntStats": "XX",
    	"rfBitmapA": 0,
    	"rfRssiA": 5,
    	"rfBitmapB": 0,
    	"rfRssiB": 6
}

The topic is set to [TOPIC_PREFIX]/[RECEIVER_NAME]/SAMPLE/ALL/[CHANNEL].

Commands

Details on the commands can be found on the Shure website:

https://www.shure.com/de-DE/produkte/funkmikrofon-systeme/axient_digital/ad4q

https://d24z4d3zypmncx.cloudfront.net/Pubs/AD4D/Axient_Digital_network_string_commands.pdf