Creating device credentials
The credentials required to create a connection with the MQTT Broker. By clicking on the Device Credentials on the left navigation panel, You will see the Manage Device Credentials . You can create one or more Device credentials as shown in the below. Each Device Username has an associated Password and acts as credentials for your devices. The Device Username and Password should be alphanumeric with minimum 6 characters and should not contain any special characters.
You can also edit or delete an existing credentials.
Use the Device Username and Password while connecting your devices to the broker to send and receive messages. You can use one Username and Password combination to connect multiple devices or create new credentials for every device for better security.
Note : In case if you wish to recover a deleted Device Credentials. Please contact our support. firstname.lastname@example.org
Connecting a device (Sandbox)
Once the devices are registered, use the Sandbox option on the left navigation panel to send topic messages to your devices.
Name of the topic to which the message has to be published. We can have / separate nested levels of topics.
The exact message to be sent to devices. (Akiro does not enforce any structure to the payload. The structure of the payload can be application specific)
The desired QoS value. Takes 0 (AT MOST ONCE),1 (AT LEAST ONCE) or 2 (EXACTLY ONCE). Akiro confirms that the message has been received based on the QOS with acknowledgement service.
The messages sent to that topic will be retained so that the new devices that connect to the same topic receive the retained messages by default.
Ex: (Topic : Onboarding , Message: Welcome to Akiro)
Select from the list of Device Usernames created using which you would like to send the message.
The corresponding password for the selected username The Publish button sends the message. Every message sent using the sandbox generates a unique message ID using which you can search and check the status of the message as explained in the next section.
Testing the connection
Once the device is Connected successfully , The indicator near the Connection turns green. If disconnected it turns red. We can also try sending a message as explained above to ensure the connection is successful.
You can either search based on your registered device Id or message Id using the Search option in the left nav panel.
Get the details of the device’s status, connection type, last connected and disconnected time and whether the connection was a clean session or not. You can also check the messages associated with this device and the corresponding topic details.
We can keep track of messages sent and received between devices if needed by the customer whose details can also be searched and accessed in the below page.
Get the details of the status , corresponding topic, dispatched and expiry time of the message sent against the message Id, When the application is registered for the cloud store.
Status can be of any of the following
DISPATCHED : Message is sent to the specified topic.
RECEIVED : Message is received by a Client.
ACKNOWLEDGED : Message acknowledged by the Client upon receiving
EXPIRED : Message sent to a topic but expired before reaching the desired Client(s).
RETRY_COUNT_EXCEEDED : Message sent to a topic, but Number of retries exceeded while trying to send the message to the client(s).
For QoS > 0, the message status can change from DISPATCHED to any other status based on the receive acknowledgement from the Client.
The time at which the message expires. The expiry interval is a configurable time interval for a message.
Messages sent from the Device
We can also search for the messages that are sent from the device with the message_id if the application is registered for the cloud store. We can even export the messages as csv file
We have a Dashboard that displays the status of the MQTT application. It keeps track of Devices (Online, Offline), Messages (Sent, Received), Topics subscribed by devices, Connection details, Available and used Quota Metrics
- Delivered Messages : No of messages Delivered to the devices.
- Received Messages : No of messages Received from the devices and sandbox.
- Message Size : Total size of the messages exchanged in bytes.
- Online Devices : No of devices currently online and connected.
- Message Quota : Shows the current applicable quota on the number of messages.
- Device Stats : Comparative view to know the distribution of online and offline devices.
- Device Details : 10 most recently connected device list against the last connected time. Click on the device Id to know more details about the device.
- Topic Stats : Topic vs Subscriber count and Message count.
- Device Connection Metrics : A time-line view of the Device connection counts against a configurable week and month granularity.
Device Asset Hierarchy
The Asset Hierarchy panel allows you to add details about the device . When a device is onboarded, we can provide the locality of the device. This page shows the hierarchy of devices based on their location. So it becomes easier to visualize and also perform some tasks based on the location in which the devices from a particular locality are involved. Details about the device will be shown on a click in different viewing sections like Device Connection Details, Device Metrics Details, Device Topic Subscription Details. In the Device Metrics Threshold section, you can add some constraints which will be applied to the chosen device metrics and perform some task based on those constraints.
The device summary page shows a summary of the all created devices. The devices are categorized into 3 categories based on their current state - Online Devices, Offline Devices and Blocked Devices . The categories show the count of devices currently in that state. You can also search for a particular device in the given search bar. On clicking a device, a popup opens which shows a few details of the clicked device like Device Id, Device state (current state) and Last Disconnection.
Security page provides options to manage created devices.
You can Blacklist a device with a blacklist panel available inside the security.The + Add Blacklist Device allows you to add a device needed to be blacklisted where you need to enter the device id at. You can also edit or delete the blocked devices.
You will be able to change the password of your Akiro user , click on your username and use the Change Password option as shown.