Receiving Actions

introduction actions docid\ sxdqnjtvau iphckojgz3 or commands can be received from bytebeam by subscribing to the actions mqtt topic /tenants/{tenant id}/devices/{device id}/actions replace {tenant id} with your project name and {device id} with the device id you can find these in the json file downloaded in the section on connect to bytebeam cloud docid\ jr6sxray6ci0j3yj9ihh to trigger an action from the cloud follow the guides on creating new action types docid\ qpcsie hkxdpje0aj8z1j and triggering an action docid 86fvurndejzm5yviyriqb let us assume an action called print has been created that prints the payload once the action is triggered you will receive a message on mqtt { "name" "print", "id" "3620695", "payload" "hello world!", } in the above json id is a unique identifier generated each time an action is triggered from the cloud payload is the text payload that was entered on the cloud we need to send a response back to the cloud to indicate progress of executing the command the response needs to be published on the below topic /tenants/{tenant id}/devices/{device id}/action/status and the payload will look like this \[{ "timestamp" 1710774583249, "state" "completed", "errors" \[], "id" "3620695", "progress" 100 }] in the above action response id needs to be the same id that was received from bytebeam state can be any text to indicuate current status a long running command might have multiple states for eg an ota action might have states "downloading", "updating ecu 1", "updating ecu 2" so on so forth as statuses "failed" and "completed" are special terminal states that indicate that the action is complete errors is an array of strings and is looked at only if the state is sent as "failed" the ui displays these errors progress is a number from 1 to 100 and indicates the progress within a given state for eg if state is "downloading" and progress is 50 it means 50% of downlaod is complete progress is ignored if state is "completed" or "failed" receiving actions using mqttx open mqttx and click on the + new subscription button enter the topic (replace tenant and device id) and set qos to 1 hit confirm you should see the subscription now from the device management screen on your project trigger the print command this will open up a dialog as shown below enter payload and click on "yes" you will see the action get created with status as "initiated" on mqttx you should now receive a message like below notice the id in the payload matches the id on the you see on the ui ignore the additional field kind that field has been deprecated you can send progress back as shown below do not forget to set the id to what was received in the message by you and also change demo and device id 2 to your tenant and device id you should now be able to see the action as completed on the ui implementing actions in your client you can implement the below logic for implementing actions on startup subscribe to the actions topic when you receive a message from the cloud on the actions topic then send action status as "received" to notify the client that the action has received this is optional but a good practice parse it as json extract the name, id and payload fields execute the action based on the name and payload for long running actions periodically send status on the action status topic send "completed" or "failed" status at the end of the action