Skip to content

Using Settings Configuration API

Jump to bottom
Corey Thompson edited this page Jan 21, 2023 · 2 revisions

Publishing commands

Commands are requests for action to occur on another client. Command topics follow the pattern below:

cmd/[app]/[device]/[parameter-name]/[request-type]

#V2 As an example, the topic below contains a request to configure the acceleration time for VFD1:

cmd/vfdctl/vfd1/acceltime/coilWrite

The message body should contain a json object with a "value" key and an integer value:

{"value":40}

cmd/vfdctl/vfd1/acceltime/registerWrite

The message body should contain a json object with a "value" key and an integer value:

{"value":40}

#V1 As an example, the topic below contains a request to configure the acceleration time for VFD1:

cmd/vfdctl/vfd1/acceltime/config

The message body should contain a json object with a "value" key and an integer value:

{"value":40}

Publishing the sample object to the sample topic is expected to set the acceleration time of VFD1 to 40 seconds.

Example of reading telemetry and publishing commands

Important Resources

Platform updates

Please make sure to bookmark the following pages, as they will provide you with important details on API outages, updates, and other news relevant to developers on the platform. Check out our releases to find the latest binaries and a history of all released binaries. Visit the Tulsa Software Repositories to find related open-source codebases. In case of any document conflicts, assume the Vfdctl readme is most accurate.

MQTT reference material

MQTT is extremely flexible and not as rigidly enforced as communications such as RPC or REST communications. This leaves lots of room for one-off implementations if systems are not intentionally designed. For our communications architecture, we have based our topic and payload structures off of the AWS best practices to ensure ultimate usability.

  • Even if not using AWS IoT cloud communications, their MQTT communication patterns are widely applicable
  • A good client GUI like MQTTX or MQTT Explorer makes troubleshooting your system much easier but any app supporting MQTT 3.1.1 communications will suffice
  • Using a IoT Rules Engine such as Node Red, AWS IoT Core, etc is essential to utilizing data with minimal coupling and maximal scalability

Still have questions?

For the questions not covered here or to learn what we're currently working on, visit the Tulsa Software slack channel to review topics, ask questions and learn from others.

Clone this wiki locally