Contents
- Setting up an account at Abiro IoT
- Setting things up for using the Yggio API
- Setting up an Yggio channel for use with Abiro IoT
- Setting things up for The Things Network (TTN)
- Setting things up for sending CliqTags forms to Yggio
- General notes
Setting up an account at Abiro IoT
Before you can use Abiro IoT we need some information from you:
- Desired credentials for logging in to Abiro IoT
- Basic contact information about you and your company, so we know who to contact
You can’t set up an account yourself. We only allow access for companies and people we are already in contact with.
Setting things up for using the Yggio API
Before you can use Abiro IoT with Yggio’s API we need some information:
- Your Yggio server’s URL
- Login for an account there, so it’s possible to create a Client App for use with Abiro IoT
Everything in the Yggio submenu can be used provided this is configured.
Setting up an Yggio channel for use with Abiro IoT
Start with defining a unique ID (letters and digits only), preferably a long one, that will be used to filter channel requests.
At your Yggio server
- Click on Devices at the top of the page
- Click on an existing device
- Click on Channels to the left
- Enter:
- Name: AbiroIoT
- Protocol: HTTP
- URL: https://iot.abiro.com/api.php?accountid=[your unique ID]
- Click on Create channel
At Abiro IoT
- Click on Profile
- Enter the same unique ID under Account ID(s)
- Click Save
- Look for reception of data in Visualize (the one in the main menu)
Setting things up for The Things Network (TTN)
What you need is a webhook integration configured in your TTN application.
At TTN
- Click on Applications at the top left
- Click on the application that you want to send data to Abiro IoT
- Make a note of the application’s ID (not the name)
- Go to Integrations / Webhooks
- Click on Add webhook
- Click on Custom webhook
- Enter:
- Webhook ID: abiro-iot
- Webhook format: JSON
- Base URL: https://iot.abiro.com/api.php
- Leave the rest as-is
- Click Save changes
At Abiro IoT
- Click on Profile
- Enter the TTN application’s ID under Account ID(s)
- Click Save
- Look for reception of data in Visualize (the one in the main menu)
Setting things up for sending CliqTags forms to Yggio
At Abiro IoT
- Define an MQTT topic according to the syntax yggio/generic/v2/[sub topic]. sub topic should be a self-describing name without spaces.
- Open the Yggio sub meny.
- Create a Basic Credentials Set (BCS) if it doesn’t already exist. Make a note of the username and password, as they are needed later.
- Create a Reserved MQTT Topic (RMT) with the above topic. It’s recommended to create a number of similar topics, manually or via the bulk function, as you might need them later.
At CliqTags
- Create a site with a Survey page (there’s a template for a site with only a survey), or add such a page to an existing site.
- Add fields to the form and other page details (at least a name).
- Test and iterate the form via View until you are happy with it. Submitted data is stored in Responses for verification.
- Enter a submission link to Yggio in the Script field as follows:
- https://admin.cliqtags.com/mqtt/formmqtt/api.php?server=[your Yggio server]&username=[your BCS username]&password=[your BCS password]&topic=[your RMT]
- View the form and enter sample data and submit.
- When the first form has been submitted, the node is automatically created in Yggio provided all the above preparations were made.
Notes
- Even when forms are sent externally from CliqTags they are also always stored internally in Responses as well.
- Yggio has few options for visualizing text, so whenever possible use numerical data
General notes
- The Account ID(s) field in Profile can have multiple entries separated by comma
- Contact support@abiro.com if something doesn’t work