Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
IoT Bridge for SiteWise is configured with a configuration file on the filesystem of the EC2 instance. If you are unfamiliar with how to access the instance see this page for access instructions. Also note, after modifying the configuration the application must be restarted. This can be done with the following command.
Code Block | ||
---|---|---|
| ||
sudo /etc/init.d/ssbsystemctl restart ibas |
The path to the configuration file is:
/opt/ib/conf/ibibas.properties
Once you open the file, you will see the following options.
Code Block | ||
---|---|---|
| ||
# The IBAS instance friendly name. If ommitted, it will become 'IBAS-ec2-instance-id' #ibas_instance_name = # The AWS region the target SiteWise instance is in - if commented out, the region will default to the region the IoT Bridge for AWS EC2 instance is in #aws_sitewise_region = us-east-1 # The MQTT Server URL mqtt_server_url = ssl://REPLACE_WITH_MQTT _SERVER_ENDPOINT:8883 # The MQTT Server name mqtt_server_name = My MQTT Server # The MQTT username (if required by the MQTT Server) #mqtt_username = # The MQTT password (if required by the MQTT Server) #mqtt_password = # The MQTT keep-alive timeout in seconds mqtt#mqtt_keepalive_timeout = 30 # The path to the TLS Certificate Authority certificate chain #mqtt_ca_cert_chain_path = /opt/ibas/conf/certs/ # The path to the TLS certificate #mqtt_client_cert_path = /opt/ibas/conf/certs/ # The path to the TLS private key #mqtt_client_private_key_path = /opt/ibas/conf/certs/ # The TLS private key password #mqtt_client_private_key_password = # Whether or not to verify the hostname against the server certificate #mqtt_verify_hostname = false # The Sparkplug sequence reordering timeout in milliseconds #sequence_reordering_timeout = 5000 # Whether or not to block auto-rebirth requests #block_auto_rebirth = false # The primary host ID if this is the acting primary host #primary_host_id = # The MQTT Client ID # - It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated #client_id = # Whether or not to enable notifications on measurements in SiteWise sitewise_enable_notifications = false # Age of data in the past (in seconds) that can be inserted into SiteWise sitewise_oldest_data_limit = 604800 # Age of data in the future (in seconds) that can be inserted into SiteWise sitewise_newest_data_limit = 300 # Whether or not to force updates of UDT Definitions -> SiteWise Models on Sparkplug NBIRTH messages sitewise_force_model_updates = false # AWS Tags for Create and Describe of AssetModels # aws_sitewise_create_asset_model_tag = default_model_key, default_model_value # aws_sitewise_create_asset_model_tag.G1 = G1, G1_model_key, G1_model_value # AWS Tags for Create and Describe of Assets # aws_sitewise_create_asset_tag = default_asset_key, default_asset_value # aws_sitewise_create_asset_tag.G1 = G1, G1_asset_key, G1_asset_value # Whether or not to create and update IBAS infomational tracking metrics # ibas_metrics_enabled = true # The Sparkplug Group ID to use for IBAS asset names ibas_metrics_sparkplug_group_id = IBAS Metrics |
If you are using AWS IoT Core then your configuration file should look similar to the one below.
Code Block | ||
---|---|---|
| ||
# The MQTT Server URL mqtt_server_url = ssl://b9ffnzzzzzzzz-ats.iot.us-east-1.amazonaws.com:8883 # The MQTT Server name mqtt_server_name = AWS IoT Core # The MQTT username (if required by the MQTT Server) # NOT USED FOR AWS IOT #mqtt_username = admin # The MQTT password (if required by the MQTT Server) # NOT USED FOR AWS IOT #mqtt_password = changeme # The MQTT keep-alive timeout in seconds mqtt_keepalive_timeout = 30 # The path to the TLS Certificate Authority certificate chain mqtt_ca_cert_chain_path = /opt/ssbibas/conf/certs/AmazonRootCA1.pem # The path to the TLS certificate - this is provisioned in the AWS IoT Console mqtt_client_cert_path = /opt/ssbibas/conf/certs/72d382zzzz.cert.pem # The path to the TLS private key - this is provisioned in the AWS IoT Console mqtt_client_private_key_path = /opt/ssbibas/conf/certs/72d382zzzz.private.key # The TLS private key password # NOT USED FOR AWS IOT #mqtt_client_private_key_password = # Whether or not to verify the hostname against the server certificate #mqtt_verify_hostname = false # Whether or not to block auto-rebirth requests #block_auto_rebirth = false # The primary host ID if this is the acting primary host # NOT POSSIBLE FOR AWS IOT #primary_host_id = # The MQTT Client ID # It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated # NOT USED FOR AWS IOT #client_id = |
If you are using Cirrus Link's Chariot MQTT Server using a real signed TLS certification then your configuration file should look similar to the one below.
Code Block | ||
---|---|---|
| ||
# The IBAS instance friendly name. If ommitted, it will become 'IBAS-ec2-instance-id' ibas_instance_name = MYBAS # The AWS region the target SiteWise instance is in - if commented out, the region will default to the region the IoT Bridge for AWS EC2 instance is in #aws_sitewise_region = us-east-1 # The MQTT Server URL mqtt_server_url = ssl://chariot.mycompany.com:8883 # The MQTT Server name mqtt_server_name = Chariot MQTT Server # The MQTT username (if required by the MQTT Server) # THIS IS PROVISIONED IN CHARIOT MQTT SERVER mqtt_username = admin # The MQTT password (if required by the MQTT Server) # THIS IS PROVISIONED IN CHARIOT MQTT SERVER mqtt_password = changemechange # The MQTT keep-alive timeout in seconds mqtt_keepalive_timeout = 30 # The path to the TLS Certificate Authority certificate chain # GENERALLY NOT REQUIRED IF USING A REAL SIGNED TLS CERTIFICATE #mqtt_ca_cert_chain_path = /opt/ibas/conf/certs/ # The path to the TLS certificate - this is provisioned in the AWS IoT Console # NOT USED WITH CHARIOT #mqtt_client_cert_path = /opt/ibas/conf/certs/ # The path to the TLS private key - this is provisioned in the AWS IoT Console # NOT USED WITH CHARIOT #mqtt_client_private_key_path = /opt/ibas/conf/certs/ # The TLS private key password # NOT USED WITH CHARIOT #mqtt_client_private_key_password = # Whether or not to verify the hostname against the server certificate mqtt_verify_hostname = true # The RECOMMENDEDSparkplug sequence FORreordering CHARIOTtimeout MQTTin SERVERmilliseconds mqtt#sequence_verifyreordering_hostnametimeout = true5000 # Whether or not to block auto-rebirth requests #block_auto_rebirth = false # The primary host ID if this is the acting primary host # NOT POSSIBLE FOR AWS IOT #primaryprimary_host_id = IamHost # The MQTT Client ID # - It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated #client_id = # Whether or not to enable notifications on measurements in SiteWise sitewise_enable_notifications = false # NOT USED FOR AWS IOT #client_id = Age of data in the past (in seconds) that can be inserted into SiteWise sitewise_oldest_data_limit = 604800 # Age of data in the future (in seconds) that can be inserted into SiteWise sitewise_newest_data_limit = 300 # Whether or not to force updates of UDT Definitions -> SiteWise Models on Sparkplug NBIRTH messages sitewise_force_model_updates = true # AWS Tags for Create and Describe of AssetModels # aws_sitewise_create_asset_model_tag = default_model_key, default_model_value # aws_sitewise_create_asset_model_tag.G1 = G1, G1_model_key, G1_model_value # AWS Tags for Create and Describe of Assets # aws_sitewise_create_asset_tag = default_asset_key, default_asset_value # aws_sitewise_create_asset_tag.G1 = G1, G1_asset_key, G1_asset_value # Whether or not to create and update IBAS infomational tracking metrics ibas_metrics_enabled = true # The Sparkplug Group ID to use for IBAS asset names ibas_metrics_sparkplug_group_id = IBAS Metrics |