Versions Compared

Key

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

...

  • Store & Forward Enabled
    • Whether to enable Store & Forward capabilities for this endpoint
  • Store & Forward Type
    • The type of the Store & Forward mechanism
  • Message Capacity
    • The Maximum number of messages to store before dropping the oldest historical messages
  • Flush Period
    • The period of time to wait (in milliseconds) between sending when flushing messages

...

Advanced

  • Keep Alive
    • The MQTT keep alive timeout in seconds
  • Max Message Size
    • The maximum message size in bytes that any message can be when pushing to IoT Hub.
  • Session Expiration
    • How long in seconds to specify for session token timeouts when not using certificate based authentication
  • Content Type
    • The content type to include in the topic to Azure IoT Hub

      • NONE (default) - No content type header will be included with the message
      • APPLICATION_JSON - The applicaton/json header will be included with the message and make the body of the message available for routing if content encoding is also not 'NONE'
    • See this tutorial for more details
  • Content Encoding
    • The content encoding to include in the topic to Azure IoT Hub
      • NONE (default) - No content encoding header will be included with the message
      • UTF_8 - The 'utf-8' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
      • UTF_16 - The 'utf-16' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
      • UTF_32 - The 'utf-32' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
    • See this tutorial for more details
  • Azure Date/Time Format
    • The date/time format to use when pushing messages to IoT Hub
      • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
      • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
    • See this tutorial for more details


Clicking on the "Create new Azure IoT Hub Setting..." link will bring up the following form for adding a new Azure IoT Hub endpoint.

...

  • Setting Name
    • This is a friendly name of the Azure Event Hub used to easily identify it.  This must also be unique.
  • Enabled
    • Whether or not pushing to this Event Hub is enabled or not.
  • Password/Connection String
    • This is the Azure Event Hub connection string used to connect. 
    • NOTES: Be sure to provide the connection string for the EventHub itself and not the EventHub Namespace. They both have connection strings, but the one for the EventHub will be of the form -

      Endpoint=<YOUR_ENDPOINT>;SharedAccessKeyName=<YOUR_KEYNAME>;SharedAccessKey=<YOUR_KEY>=;EntityPath=<YOUR_EVENTHUB_ENTITYPATH>

      The Namespace connection string will not contain the entity path.

  • Set
    • The Set to associate this Azure IoT Hub connection with.
  • Certificates
    • The server certificates to use if required.

Store & Forward

  • Store & Forward Enabled
    • Whether to enable Store & Forward capbilities for this endpoint
  • Store & Forward Type
    • The type of the Store & Forward mechanism
  • Message Capacity
    • The Maximum number of messages to store before dropping the oldest historical messages
  • Flush Period
    • The period of time to wait (in milliseconds) between sending when flushing messages

Advanced

  • Max Message Size
    • The maximum message size before outbound messages will be divided into chunks smaller than the max message size

...