This tutorial provides a step-by-step guide to integrate AWS IoT (Network Server) with the TagoIO Platform. By following these instructions, you will enable uplink and downlink operations, allowing data exchange between your LoRaWAN devices and the TagoIO application.
Prerequisites
Before proceeding with the integration, ensure you have the following:
- TagoIO Account: An active TagoIO account. If you don’t have one, sign up here.
- AWS Account: An active AWS account with access to AWS IoT Core.
- LoRaWAN Device: A LoRaWAN-compatible device ready for integration.
- Internet Connectivity: Ensure your device and gateway are connected to the internet.
- Region Information: Determine your deployment region (e.g., us-e1, eu-w1). Refer to the TagoIO Network Integration Regions for available regions.
Official Downlink support from TagoIO SDK is not included for this integration. You are going to need to use TagoIO Analysis to manually perform endpoint request to AWS.
Step 1: Create Authorization in TagoIO
-
Access Authorizations:
-
Go to Devices.
-
Click on Authorizations at the top of the page.
-
-
Create a New Authorization:
-
Click the Create Authorization button.
-
Provide a meaningful name for the authorization (e.g., AWS-Integration).
-
Click Save.
-
-
Copy the Authorization Token:
- After creation, copy the authorization token. You will need this in later steps.
Note : you need to create only one Authorization for all your devices.
Step 2: Set Up Integration in AWS Console
Set up AWS IoT Core to forward data from your LoRaWAN devices to TagoIO.
-
Access AWS IoT Core:
-
Log in to your AWS Management Console.
-
Navigate to AWS IoT Core under the Services menu.
-
-
Create a New Rule:
-
In the AWS IoT Core dashboard, select Act from the sidebar.
-
Click on Create to initiate a new rule.
-
-
Define Rule Details:
-
Name: Enter a descriptive name for the rule (e.g., TagoIOIntegrationRule).
-
Description: Provide a brief description.
-
-
Set Rule Query Statement:
-
In the Rule query statement section, define the SQL-like statement to filter incoming MQTT messages.
SELECT * FROM ‘device/+/data’ -
Explanation: This statement forwards all messages from topics matching device/{assetID}/data.
-
Reference: For advanced filtering, consult the AWS IoT Rule SQL Reference.
-
-
Add Action to Forward Data:
-
In the Set one or more actions section, click Add Action.
-
Select Send a message to a downstream HTTPS endpoint and click Configure action.
-
-
Configure HTTPS Endpoint:
-
Endpoint URL: Use the following format, replacing REGION with your deployment region:
https://awsiot.middleware.REGION.tago.io/uplink
Example: https://awsiot.middleware.us-e1.tago.io/uplink -
Confirmation URL:https://awsiot.middleware.REGION.tago.io/
-
-
Headers:
-
Key: authorization
-
Value: Paste the authorization token obtained in Step 1.
{
“authorization”: “123e4567-e89b-12d3-a456-426614174000”
} -
Note: Ensure the endpoint URL matches your deployment region.
-
-
Specify Endpoint Configuration Based on AWS IoT Service:
2.1 AWS IoT LoRaWAN
If you are using AWS IoT LoRaWAN, configure the HTTPS endpoint as follows:
https://awsiot.middleware.REGION.tago.io/uplink
2.2 AWS IoT Core Broker
If you are using AWS IoT Core Broker, determine how to extract the Asset ID for each device:
-
Option 1: Extract from Topic
- Topic Structure: device/{DeviceUID}/data
- HTTPS Endpoint:
https://awsiot.middleware.REGION.tago.io/uplink/${topic(2)}
-
Option 2: Extract from MQTT Client ID
- HTTPS Endpoint:
https://awsiot.middleware.REGION.tago.io/uplink/${clientid()}
Recommendation: Use this method if you’re utilizing AWS IoT LoRaWAN.
- HTTPS Endpoint:
-
Finalize and Create the Rule:
- After configuring the HTTPS endpoint, click Create to finalize the rule.
- Verification: Ensure the rule status is Enabled in the AWS IoT Core dashboard.
Now you can create the rule. After creating the rule, TagoIO will authorize your downstream and you should see “Enabled” in the rule list for your rule at AWS IoT.
Step 3: AWS IoT LoraWAN Additional Steps
With your rule created at Step 2, we are assuming you’re using the endpoint for MQTT ClientID.
- Access your Wireless Connectivity section and click on the Destinations option.
- Click to Add a new destination.
- Enter a Destination name and Destination description of your choice.
- Select Enter a rule name as an option.
- Enter the same rule name from the rule you created at step 2.
- You can skip Rule Configuration as you already did in step 2.
- Set the permissions or create a new service role. It will grant the permissions needed for your device to send data to TagoIO.
- Press Add Destination and you’re done.
Step 4: Add Device in TagoIO
To integrate your device with the TagoIO Platform, follow these guidelines:
-
Ensure Device EUI Consistency:
-
When creating the device in TagoIO, use the exact same Device EUI that is configured in AWS IoT.
-
The Device EUI must match exactly to establish a successful connection between AWS IoT and TagoIO.
-
-
Select the Appropriate Network and Device Type:
-
Choose the AWS IoT Network during the device setup process.
-
Select the correct device type from the available options. If your device is not listed, you can add support through connectors.
-
-
Add Device Support via Connectors (If Necessary):
-
If your device type is not available in the default list, enhance its compatibility by utilizing connectors.
-
For more information on available connectors and how to use them, refer to the Connector Overview.
-
For detailed instructions on adding devices, visit the Adding Devices page.
Finalizing Setup
-
Power On Your Devices:
- Turn on your LoRaWAN device and gateway to initiate data transmission.
-
Verify Data Reception:
-
In TagoIO, navigate to the Device and into the Data tab to confirm that data is being received.
-
Alternatively, use the Live Inspector within your device settings to monitor incoming data in real-time.
-
With data successfully flowing into TagoIO, you can start creating dashboards, add notifications, and create scripts to process your data.
Learn how to perform downlink for LoRaWAN.
