Skip to content

Latest commit

 

History

History
119 lines (108 loc) · 6.34 KB

File metadata and controls

119 lines (108 loc) · 6.34 KB
layout title description api-keys configure-chirpstack-integration device uplink-message-in-integration uplink-converter-events solution-templates downlink-rule-chain root-rule-chain add-shared-attribute downlink-events
docwithnav-pe
ChirpStack Integration
ChirpStack Integration Guide
0 1 2
image title
/images/user-guide/integrations/chirpstack/chirpstack-api-key-1.png
Go to the "API keys" page, and click "Add API key";
image title
/images/user-guide/integrations/chirpstack/chirpstack-api-key-2.png
Enter API key name, and click "Submit";
image title
/images/user-guide/integrations/chirpstack/chirpstack-api-key-3.png
API key created. Copy API token.
0 1 2 3 4 5
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-1.png
Go to the "Applications" page in the left menu of the ChirpStack Network server user interface, and click "Add application" button;
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-2.png
Named it and click "Submit" button;
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-3.png
Application created. Now, navigate to the "Integrations" tab;
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-4.png
Find and add a "HTTP" integration by clicking "+" icon;
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-5.png
Fill in the field with the "HTTP endpoint URL" previously copied from the ChirpStack integration in the ThingsBoard. Then, click "Submit" button;
image title
/images/user-guide/integrations/chirpstack/chirpstack-configure-integration-6.png
HTTP integration created.
0
image title
/images/user-guide/integrations/chirpstack/device-created-1-pe.png
When your device sends an uplink message, a new device will appear in the ThingsBoard user interface.
0 1
image title
/images/user-guide/integrations/chirpstack/integration-uplink-message-event-1.png
You will receive an uplink event in the ChirpStack integration.
image title
/images/user-guide/integrations/chirpstack/integration-uplink-message-event-2.png
0 1 2
image title
/images/user-guide/integrations/chirpstack/converter-event-1-pe.png
Received data can be viewed in the uplink converter. In the "In" and "Out" blocks of the "Events" tab;
image title
/images/user-guide/integrations/chirpstack/converter-event-2-pe.png
Incoming data to converter from ChirpStack
image title
/images/user-guide/integrations/chirpstack/converter-event-3-pe.png
Outgoing data from converter.
0
image title
/images/user-guide/integrations/http/http-solution-templates.png
Outgoing data from converter.
0 1 2 3
image title
/images/user-guide/integrations/chirpstack/import-downlink-rule-chain-1.png
Go to the "Rule Chains" page. To import this JSON file, click the + icon in the upper right corner of the screen and select "Import rule chain". Drag the downloaded JSON file into the import rule chain window. Click "Import";
image title
/images/user-guide/integrations/chirpstack/import-downlink-rule-chain-2.png
The "Downlink to Chirpstack" rule chain will open. Double-click on the "integration downlink" node;
image title
/images/user-guide/integrations/chirpstack/import-downlink-rule-chain-4.png
Specify ChirpStack integration in the "Integration" field;
image title
/images/user-guide/integrations/chirpstack/import-downlink-rule-chain-5.png
Save rule chain by pressing on checkmark.
0 1 2 3 4 5
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-1.png
Open the "Root Rule Chain", and find a "check relation presence" node;
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-2.png
Drag it to the rule chain. Name it "Check relation to ChirpStack integration", select the direction - "To originator", specify "ManagedByOriginator" relation type. Specify ChirpStack integration and click "Add";
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-3.png
Tap on a right grey circle of "message type switch" node and drag this circle to the left side of "check relation presence" node. Here, add the "Attributes Updated" link, and click "Add";
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-4.png
Find a "rule chain" node;
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-5.png
Drag it to the rule chain. Name it "Downlink to Chirpstack", specify "Downlink to Chirpstack" rule chain, and click "Add";
image title
/images/user-guide/integrations/chirpstack/edit-root-rule-chain-6.png
Tap on the right grey circle of the "check relation presence" node and drag this circle to left side of “rule chain” node. Here, select the "True" link, and click "Add". Finally, save Root Rule Chain.
0
image title
/images/user-guide/integrations/chirpstack/add-shared-attribute-1.png
Go to the "Devices" page. Select your device and navigate to the "Attributes" tab. Select "Shared attributes" and click on the "plus" icon to add new attribute. Then enter the attribute name and its value (for example, the key name is 'downlink', value: '01040203') and click "Add".
0 1 2
image title
/images/user-guide/integrations/chirpstack/downlink-event-1.png
Received data can be viewed in the downlink converter. In the "In" and "Out" blocks of the "Events" tab;
image title
/images/user-guide/integrations/chirpstack/downlink-event-2.png
Input data to downlink converter;
image title
/images/user-guide/integrations/chirpstack/downlink-event-3.png
Output data from downlink converter.

{% assign docsPrefix = "pe/" %} {% include get-hosts-name.html docsTag="pe" %} {% include docs/pe/user-guide/integrations/chirpstack.md %}