Versions Compared

Old Version 1

changes.mady.by.user user-227b9

Saved on

compared with

New Version 2

changes.mady.by.user Christophe Holc

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

IoTHub Connector it is the component which is responsible for managing connection, sending and receiving messages from Azure IoTHub in a Niagara station.

Implementation

This component is a RealTimeConnector, this page will only contain information specific to this component


Implementation

...

  • Drag and drop the

...

  • RealTimeConnector  to Services > Btib Service > External Connectors > Realtime Connectors.

...

 Properties

...

  • Fill the IoTHubConnectionString slot with the value copied during Step 1 Set up IoTHub on Azure.
  • Enable the connector. It is also possible to ping the Connector to check if it works.

 Properties

  • IoT Hub Connection String : The connection string used to access iot hub.
  • Declare Points As Modules : create an iot hub module for each point.
  • IoT Hub Size : The size tier of your iot hub instance.
  • Number Of Unit : The number of iot hub units.

 Advanced Config

  • Device Tags Destination: The destination where device tags will be sent during the initialization.
  • Point Tags Destination: The destination where point tags will be sent during the initialization.
  • Point Status Destination: The destination where the point status message will be sent.
  • Point Value Destination: The destination where the point value message will be sent.
  • Reference Destination: The destination where the reference message will be sent.
  • Alarm Destination: The destination where the alarm messages will be sent via the alarm recipient associated to this connector.
  • Default Variables: The default variables to be used by the messages template.
  • Custom Variables: Set of user defined variables to be used by the messages template.
  • Point Status Message Template: The status message template used to construct the message to be sent by the connector.
  • Point Value Message Template: The value message template used to construct the message to be sent by the connector.
  • Commands Policy: The commands policy either single or multi message.
  • Message Type: The type of the message (Default: POINT_ACTION).
  • Command Set Object: The json format that contains the commands if the command policy is multi message.
  • Command Device Id: The sformat path to extract the device id from the external  message.
  • Command Point Id: The sformat path to extract the point id from the external  message.
  • Command Action: The sformat path to extract the command action from the external  message.
  • Command Value: The sformat path to extract the value from the external  message.
  • Command Duration: The sformat path to extract the command duration in seconds from the external  message.
  • Start Date: Start timestamp of the history (Optional).
  • End Date: the end date for the history (Optional).
  • Delta: Apply delta for the history (Default: false).
  • History Message Variable: Set of predefined variables to use in the history message template.
  • History Message Template: The template message to use for the history message.
  • Alarm UUID: The sformat path to extract the uuid.
  • Invalid Value Policy: What to do when an invalid value detected.
  • Json Message Policy: The policy to use for value that contains json text

Actions

  • Ping : Ping the iot hub service.

Fault Causes

  • Unable to connect : verify the you copied the correct connection string, try to ping.