Skip to content

Commit

Permalink
Release script
Browse files Browse the repository at this point in the history
  • Loading branch information
ashvayka committed Jan 17, 2024
1 parent a471c92 commit f3e05bd
Show file tree
Hide file tree
Showing 69 changed files with 87 additions and 87 deletions.
38 changes: 19 additions & 19 deletions _includes/docs/pe/user-guide/integrations/particle.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To do this, we need to the following steps from [official guide](https://docs.pa

After connecting the device, it will become visible on the Particle console. This will allow you to create an integration to receive data on ThingsBoard.

![Devices list](/images/user-guide/integrations/particle/particle-console-device-list.png)
![Devices list](https://img.thingsboard.io/user-guide/integrations/particle/particle-console-device-list.png)

## ThingsBoard Integration Configuration

Expand Down Expand Up @@ -91,7 +91,7 @@ particle login
```
{:.copy-code}

![Login](/images/user-guide/integrations/particle/cli-login.png)
![Login](https://img.thingsboard.io/user-guide/integrations/particle/cli-login.png)

After logging in, you will need to [create an access token](https://docs.particle.io/reference/developer-tools/cli/#particle-token-create).
You can do this using one of the following commands:
Expand All @@ -105,24 +105,24 @@ You can do this using one of the following commands:
particle token create
```
{:.copy-code}
![Login](/images/user-guide/integrations/particle/cli-token-created.png)
![Login](https://img.thingsboard.io/user-guide/integrations/particle/cli-token-created.png)

Save created token, we will need it in the next step.

### Particle Integration Setup

{% assign createIntegrationUsingWizard = '
===
image: /images/user-guide/integrations/particle/tb-create-integration.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/tb-create-integration.png,
title: Go to **Integrations** section and click Add new integration button. Name it **Particle Integration**, and select type **Particle**.
===
image: /images/user-guide/integrations/particle/tb-select-uplink.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/tb-select-uplink.png,
title: Now, you can select the recently created **Uplink data Converter for Particle Integration**. Click **Next**.
===
image: /images/user-guide/integrations/particle/tb-select-downlink.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/tb-select-downlink.png,
title: If you added a downlink converter, select it. Click **Next**.
===
image: /images/user-guide/integrations/particle/tb-create-integration-configuration.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/tb-create-integration-configuration.png,
title: If you added a downlink converter and created a token - toggle **Allow downlink** and paste your access token. Click **Add** to create integration.
'
%}
Expand All @@ -138,16 +138,16 @@ To do this, please follow next steps:

{% assign createParticleCloudIntegration = '
===
image: /images/user-guide/integrations/particle/particle-console-integrations-2.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-console-integrations-2.png,
title: Go to **Integrations** section and click "**Add new integration**" button.
===
image: /images/user-guide/integrations/particle/particle-console-integrations-3.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-console-integrations-3.png,
title: Click on the **Webhook**.
===
image: /images/user-guide/integrations/particle/particle-console-integrations-4.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-console-integrations-4.png,
title: Fill in all required fields. Then click **Create webhook**.
===
image: /images/user-guide/integrations/particle/particle-console-integrations-5.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-console-integrations-5.png,
title: Your integration was created successfully.
'
%}
Expand All @@ -158,25 +158,25 @@ To do this, please follow next steps:

Once integration is created and any message arrives to it - you will be able to see a new device in your **Devices**.

![image](/images/user-guide/integrations/particle/tb-new-device-created.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/tb-new-device-created.png)

### Rule Chain configuration

When integration is configured and ready to use, we need to go to **Rule Chains**, choose **"Root Rule Chain"** and create rule node **Integration Downlink**. Input some name here, choose earlier created Particle integration, and tap **Add**.

![image](/images/user-guide/integrations/particle/tb-create-downlink-rule-node.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/tb-create-downlink-rule-node.png)

After these steps, we need to tap on a right grey square of rule node **message type switch** and drag this square to left side of **Integration Downlink**. In pop-up window, add **"RPC Request to Device"** relation and tap "Add".

![image](/images/user-guide/integrations/particle/tb-root-rule-chain.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/tb-root-rule-chain.png)

Click on check mark in bottom right corner of the screen to save the Root Rule Chain.

### Downlink message to device from dashboard

To process command on device, we will use an example app **Web-Connected LED** from [Particle WebIDE](https://build.particle.io/build).

![Particle WebIDE](/images/user-guide/integrations/particle/particle-webide-example.png)
![Particle WebIDE](https://img.thingsboard.io/user-guide/integrations/particle/particle-webide-example.png)

Click on **Use this example** and thunder icon to flash it to the device.

Expand Down Expand Up @@ -204,16 +204,16 @@ If no - check that your device is connected to Particle and connection is stable

{% assign createParticleDashboard = '
===
image: /images/user-guide/integrations/particle/particle-add-widget-1.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-add-widget-1.png,
title: Go to the "**Dashboards**" page, create a new dashboard and select "**Switch Control**" widget from the "**Control Widgets**" bundle.
===
image: /images/user-guide/integrations/particle/particle-add-widget-2.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-add-widget-2.png,
title: Add new alias with previously created device. Then navigate to the "**Appearance**" tab.
===
image: /images/user-guide/integrations/particle/particle-add-widget-3.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-add-widget-3.png,
title: Change retrieve value to "**Don't retrieve**" and change "***RPC set value method***" to "**led**". Then paste the convert value function copied from the documentation. Click "**Add**", then save dashboard.
===
image: /images/user-guide/integrations/particle/particle-add-widget-5.png,
image: https://img.thingsboard.io/user-guide/integrations/particle/particle-add-widget-5.png,
title: Now toggle the button and LED on your Photon should change it's led state.
'
%}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ echo -e -n '\x53\x4e\x2d\x30\x30\x31\x64\x65\x66\x61\x75\x6c\x74\x32\x35\x2e\x37
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/terminal-coap-binary-payload-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/terminal-coap-binary-payload-1-edge.png)

Now, go to the "**Integrations center**" -> "**Integrations**" and navigate to the "**Events**" tab in your MQTT integration on the **ThingsBoard Edge**. If you have done everything correctly, you will find an uplink message with the status 'OK'.

![image](/images/pe/edge/integrations/coap/integration-events-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/integration-events-coap-1-edge.png)

When you sent the message, a new device was created. The created device with data can be seen in the "**Entities**" section -> "**Devices**" page:

![image](/images/pe/edge/integrations/coap/device-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/device-coap-1-edge.png)

Also, received data can be viewed in the uplink converter. In the 'In' and 'Out' blocks of the "**Events**" tab:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ echo -e -n '{"deviceName": "SN-001", "deviceType": "default", "temperature": 25.
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/terminal-coap-json-payload-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/terminal-coap-json-payload-1-edge.png)

Now, go to the "**Integrations center**" -> "**Integrations**" and navigate to the "**Events**" tab in your MQTT integration on the **ThingsBoard Edge**. If you have done everything correctly, you will find an uplink message with the status 'OK'.

![image](/images/pe/edge/integrations/coap/integration-events-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/integration-events-coap-1-edge.png)

When you sent the message, a new device was created. The created device with data can be seen in the "**Entities**" section -> "**Devices**" page:

![image](/images/pe/edge/integrations/coap/device-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/device-coap-1-edge.png)

Also, received data can be viewed in the uplink converter. In the 'In' and 'Out' blocks of the "**Events**" tab:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ echo -e 'SN-001,default,temperature,25.7,humidity,69' | coap-client -m post $YOU
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/terminal-coap-text-payload-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/terminal-coap-text-payload-1-edge.png)

Now, go to the "**Integrations center**" -> "**Integrations**" and navigate to the "**Events**" tab in your MQTT integration on the **ThingsBoard Edge**. If you have done everything correctly, you will find an uplink message with the status 'OK'.

![image](/images/pe/edge/integrations/coap/integration-events-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/integration-events-coap-1-edge.png)

When you sent the message, a new device was created. The created device with data can be seen in the "**Entities**" section -> "**Devices**" page:

![image](/images/pe/edge/integrations/coap/device-coap-1-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/device-coap-1-edge.png)

Also, received data can be viewed in the uplink converter. In the 'In' and 'Out' blocks of the "**Events**" tab:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/add-coap-integration-template-binary-payload-2-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/add-coap-integration-template-binary-payload-2-edge.png)

If you want to use JavaScript to develop functions, please use [the binary payload script for JS](/docs/pe/edge/user-guide/resources/binary-payload-converter.json){:target="_blank"}.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/add-coap-integration-template-json-payload-2-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/add-coap-integration-template-json-payload-2-edge.png)

If you want to use JavaScript to develop functions, please use [the JSON payload script for JS](/docs/pe/edge/user-guide/resources/json-payload-converter.json){:target="_blank"}.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/coap/add-coap-integration-template-text-payload-edge-2.png)
![image](https://img.thingsboard.io/pe/edge/integrations/coap/add-coap-integration-template-text-payload-edge-2.png)

If you want to use JavaScript to develop functions, please use [the text payload script for JS](/docs/pe/edge/user-guide/resources/text-payload-converter.json){:target="_blank"}.
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/mqtt/add-mqtt-integration-template-3-java-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/mqtt/add-mqtt-integration-template-3-java-edge.png)
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/mqtt/add-mqtt-integration-template-3-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/mqtt/add-mqtt-integration-template-3-edge.png)
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/mqtt/add-mqtt-integration-template-2-java-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/mqtt/add-mqtt-integration-template-2-java-edge.png)
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ return result;
```
{: .copy-code}

![image](/images/pe/edge/integrations/mqtt/add-mqtt-integration-template-2-edge.png)
![image](https://img.thingsboard.io/pe/edge/integrations/mqtt/add-mqtt-integration-template-2-edge.png)
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ return result;
```
{: .copy-code.expandable-10}

![image](/images/user-guide/integrations/particle/particle-create-downlink-js.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/particle-create-downlink-js.png)
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ return result;
```
{: .copy-code.expandable-10}

![image](/images/user-guide/integrations/particle/particle-create-downlink-tbel.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/particle-create-downlink-tbel.png)
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ function decodeToJson(payload) {
```
{: .copy-code.expandable-10}

![image](/images/user-guide/integrations/particle/particle-create-uplink-converter-js.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/particle-create-uplink-converter-js.png)
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ if (data.coreid != "api") {
```
{: .copy-code.expandable-10}

![image](/images/user-guide/integrations/particle/particle-create-uplink-converter-tbel.png)
![image](https://img.thingsboard.io/user-guide/integrations/particle/particle-create-uplink-converter-tbel.png)
Loading

0 comments on commit f3e05bd

Please sign in to comment.