Retrieve Device Identification Info Node

The “Retrieve Device Identification Info” node can be used to retrieve information about a Catenis device, including the Catenis Node (Hub or Gateway) it belongs to, client Id it belongs to and the device name.

Image of the Retrieve Device Identification Info Node

Node Properties Panel Field Description

Node property configuration slide-out panel (this panel is accessed by double-clicking on the node).

Properties Configuration Panel of the Retrieve Device Identification Info Node

Node-RED Specific Fields

  1. Name Field:  Add a descriptive name of your choice that will help differentiate this node from others of the same type on the Node-RED workspace (not required).
  2. Connection Field: This drop-down selection is required.  Set a previously configured Catenis connection (virtual device). If you need to configure a new virtual device click the pencil button to the right of the field and follow the direction on setting up a new virtual device that can be found here.

Catenis Flow Setting Fields

  1. Device Id: Enter the device Id of the Catenis device you wish to retrieve information for. This does not have to be the same device you used to configure the node in field #2.
  2. Product Unique ID: If you have associated a unique name to your device (in your Catenis Administrative interface) and prefer to use the unique name instead of a device ID tick off this box and enter the unique name you call your device in the Device field instead of the device ID.

How to use

  1. Drag and drop this node from the Catenis Flow pallet area to the Node-RED workspace. Double-click it to display its properties slide out panel.
  2. On the “Device” drop-down field of the properties slide out panel, choose the Catenis virtual device you previously configured. The virtual device is a configuration node containing the Catenis Virtual device information (device ID and API Secret key). If you do not have a virtual device configured see section titled: “Configure your first virtual device on Node-RED”. 
  3. Add the node’s configuration information based on your needs to each field of the properties slide out panel.  Please refer to the description of each field under the section named “Node Properties Panel Field Description” on proper usage.
  4. Wire this node to a debug node. 
  5. Next, drag and drop an “inject” node to the Node-RED workspace.
  6. Wire the “inject” node to the  “retrieve device identification info” node, then double click the “inject” node to open its properties slide out panel. 
  7. Alter the information in the “inject” node’s properties slide out panel by selecting the drop-down “Payload” field and choose the “JSON” Type. An Ellipse button “…” will appear to the right of the field. Click this ellipse button to display a JSON edit box. 
  8. Enter the JSON information you wish to pass as input to the Catenis Node (an example JSON input is below). After entering your JSON text entry click the red Done button. Then click the Done button again to exit the properties dialogue box.
  9. Click the red Deploy button on the upper right hand side of the Node-RED dashboard to deploy this flow.
  10. Now let’s test the flow: Click the button on the left attached to the inject node to send the input from the inject node to the flow.

Example JSON Object that can be passed to this node

    "deviceId": "ddgZmDceYGbKqaKm8zt”,
    "isProdUniqueId": false

Note: Inputs injected into this node via a JSON object containing alternate node properties will override the properties set on this node's slide-out properties panel. In addition, you will also need to enter the device ID of your own device in JSON Object as input

Example Flow - Import Into Node-Red to Get Started

[{"id":"e9539066.e1a03","type":"debug","z":"6f16b06b.17d1","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","x":790,"y":160,"wires":[]},{"id":"80c15e0d.87b8d","type":"retrieve device identification info","z":"6f16b06b.17d1","name":"","device":"","deviceId":"device ID number that you want information on","isProdUniqueId":false,"x":490,"y":160,"wires":[["e9539066.e1a03"]]},{"id":"e48fb51a.560f78","type":"inject","z":"6f16b06b.17d1","name":"","topic":"","payload":"{\"deviceId\":\"Enter your device ID here\",\"isProdUniqueId\":false}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":150,"y":160,"wires":[["80c15e0d.87b8d"]]},{"id":"de681f74.6f24d","type":"comment","z":"6f16b06b.17d1","name":"Set virtual device for this Catenis node","info":"All Catenis nodes require that you set the proper virtual device on its slideout property panel on the device field.\n\nNot setting the device properly will result in a \"TypeError: Cannot read property 'ctnApiClient' of null\" ","x":484,"y":121,"wires":[]},{"id":"a0c4810f.1ded7","type":"comment","z":"6f16b06b.17d1","name":"Double click for instructions","info":"On the JSON field, you need to set your deviceId which you want to retrieve device identification information on.\n\nNote: Inputs injected into this node via a JSON object containing alternate node properties will override the properties set on this node's slide out properties panel.\n\n","x":150,"y":200,"wires":[]}]

Note: After importing this flow you will need to set the Catenis Flow node(s) in this flow to use a previously configured virtual devices. Instructions on how to set up your virtual device on Node-RED can be found here:

Related Articles

How can we make things Better for you?
  • Accepted file types: jpg, gif, png, pdf.
  • This field is for validation purposes and should be left unchanged.