Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _data/pages_info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,9 @@
"/docs/edge/devices-library/guidelines/":
url: "/docs/edge/devices-library/guidelines/"
redirect_from: []
"/docs/edge/devices-library/nvidia-jetson-xavier-nx-developer-kit/":
url: "/docs/edge/devices-library/nvidia-jetson-xavier-nx-developer-kit/"
redirect_from: []
"/docs/edge/devices-library/raspberry-pi-4/":
url: "/docs/edge/devices-library/raspberry-pi-4/"
redirect_from: []
Expand Down Expand Up @@ -3231,6 +3234,9 @@
"/docs/pe/edge/devices-library/guidelines/":
url: "/docs/pe/edge/devices-library/guidelines/"
redirect_from: []
"/docs/pe/edge/devices-library/nvidia-jetson-xavier-nx-developer-kit/":
url: "/docs/pe/edge/devices-library/nvidia-jetson-xavier-nx-developer-kit/"
redirect_from: []
"/docs/pe/edge/devices-library/raspberry-pi-4/":
url: "/docs/pe/edge/devices-library/raspberry-pi-4/"
redirect_from: []
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
In this guide, you will learn how to [install ThingsBoard Edge on a {{deviceName}}](#starting-edge-on-the-raspberry-pi-4), [create a device](#create-device-on-thingsboard-edge),
In this guide, you will learn how to [install ThingsBoard Edge on a {{deviceName}}](#starting-edge-on-device), [create a device](#create-device-on-thingsboard-edge),
[install the required libraries and tools](#install-required-libraries-and-tools).
After this, we will [modify our code and upload it to the device](#connect-device-to-thingsboard-edge),
and [check the results of our coding and check data on ThingsBoard Edge using imported dashboard](#check-data-on-thingsboard-edge).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ Necessary variables for connection:
| Variable name | Default value | Description |
|-|-|
| ACCESS_TOKEN | **TEST_TOKEN** | Your device access token |
| THINGSBOARD_EDGE_SERVER | **{{hostName}}** | The IP address of your Raspberry Pi running Edge |
| THINGSBOARD_EDGE_SERVER | **{{hostName}}** | The IP address of your {{deviceName}} running Edge |

If you are running the script on the same Raspberry Pi where Edge is installed, you can also use `localhost`.
If you are running the script on the same **{{deviceName}}** where Edge is installed, you can also use `localhost`.

{% else %}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
You should have installed thingsboard-python-client-sdk which can be installed using the following command. Still, we recommend installing packages outside the global environment:
To install the `thingsboard-python-client-sdk`, use the command below.
We recommend installing packages outside the global environment:

```bash
pip3 install tb-mqtt-client
```
{:.copy-code}

Also, you should have tools that allow editing code, for example, you can use Nano editor that is going out of the box or install any other code editor you are familiar with.
Also, you should have tools that allow editing code.
For example, you can use the Nano editor, which comes pre-installed, or install any other code editor you prefer.
Original file line number Diff line number Diff line change
@@ -1,47 +1,74 @@

{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
{% assign deviceName = page.title | remove: "How to install ThingsBoard Edge on " | remove: "?" %}
{% assign prerequisites = "
- " | append: deviceName | append: "
- [tb-mqtt-client library](https://pypi.org/project/tb-mqtt-client/){:target='_blank' rel='noopener'}
- [python ≥ 3.7](https://www.python.org/){:target='_blank' rel='noopener'}
- [Adafruit-Blinka](https://pypi.org/project/Adafruit-Blinka/){:target='_blank' rel='noopener'} "
%}
{% else %}
{% assign deviceName = page.title | remove: "How to connect " | remove: "to ThingsBoard?" %}
{% assign prerequisites = "
- " | append: deviceName | append: "
- [tb-mqtt-client library](https://pypi.org/project/tb-mqtt-client/)
- [python ≥ 3.7](https://www.python.org/)
- [Adafruit-Blinka](https://pypi.org/project/Adafruit-Blinka/) "
- [tb-mqtt-client library](https://pypi.org/project/tb-mqtt-client/){:target='_blank' rel='noopener'}
- [python ≥ 3.7](https://www.python.org/){:target='_blank' rel='noopener'}
- [Adafruit-Blinka](https://pypi.org/project/Adafruit-Blinka/){:target='_blank' rel='noopener'} "
%}
{% endif %}

## Introduction

![{{deviceName}}](/images/devices-library/{{page.deviceImageFileName}}){: style="float: left; max-width: 200px; max-height: 200px; margin: 0px 10px 0px 0px"}
The NVIDIA Jetson Xavier NX Developer Kit is a powerful, compact AI computer that delivers up to 21 TOPS of accelerated computing in a small form factor.
It's designed for autonomous machines, industrial robots, and embedded systems that require high-performance AI at the edge.


{% include /docs/devices-library/blocks/basic/introduction-block.md %}

## Create device on ThingsBoard
{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
## Starting Edge on the {{deviceName}} {#starting-edge-on-device}
{% assign userName = "nvidia" %}
{% include /templates/edge/devices-library/install-edge-gw.md %}
{% endif %}

{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
## Create device on ThingsBoard Edge {#create-device-on-thingsboard-edge}
{% else %}
## Create device on ThingsBoard {#create-device-on-thingsboard}
{% endif %}

{% include /docs/devices-library/blocks/basic/thingsboard-create-device-block.md %}

## Install required libraries and tools
## Install required libraries and tools {#install-required-libraries-and-tools}

{% include /docs/devices-library/blocks/single-board-computers/install-required-libraries-and-tools-block.md %}

## Connect device to ThingsBoard
{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
{% assign hostName = "NVIDIA_JETSON_XAVIER_NX_IP_ADDRESS" %}
## Connect device to ThingsBoard Edge {#connect-device-to-thingsboard-edge}
{% else %}
## Connect device to ThingsBoard {#connect-device-to-thingsboard}
{% endif %}

{% include /docs/devices-library/blocks/basic/thingsboard-provide-device-access-token-block.md %}

{% include /docs/devices-library/blocks/single-board-computers/general-code-to-program-block.md %}

## Synchronize device state using client and shared attribute requests
## Synchronize device state using client and shared attribute requests {#synchronize-device-state-using-client-and-shared-attribute-requests}
{% include /docs/devices-library/blocks/single-board-computers/thingsboard-synchronize-device-state-using-attribute-requests-block.md %}

## Check data on ThingsBoard
{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
## Check data on ThingsBoard Edge {#check-data-on-thingsboard-edge}
{% else %}
## Check data on ThingsBoard {#check-data-on-thingsboard}
{% endif %}

{% include /docs/devices-library/blocks/single-board-computers/check-data-on-thingsboard-block.md %}

## Control device using shared attributes
## Control device using shared attributes {#control-device-using-shared-attributes}

{% include /docs/devices-library/blocks/single-board-computers/update-shared-attributes-block.md %}

## Control device using RPC
## Control device using RPC {#control-device-using-rpc}

{% include /docs/devices-library/blocks/single-board-computers/using-rpc-block.md %}

Expand Down
2 changes: 1 addition & 1 deletion _includes/docs/devices-library/guides/raspberry-pi-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ productivity and database hosting.
{% include /docs/devices-library/blocks/basic/introduction-block.md %}

{% if page.docsPrefix == "pe/edge/" or page.docsPrefix == "edge/" %}
## Starting Edge on the {{deviceName}} {#starting-edge-on-the-raspberry-pi-4}
## Starting Edge on the {{deviceName}} {#starting-edge-on-device}
{% assign userName = "pi" %}
{% include /templates/edge/devices-library/install-edge-gw.md %}
{% endif %}
Expand Down
37 changes: 2 additions & 35 deletions _includes/templates/edge/devices-library/install-edge-gw.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,7 @@
To proceed with the **Edge installation** on the **{{deviceName}}**, you need to initiate an **SSH (Secure Shell)** connection.

{% if page.url contains "raspberry-pi" %}

For security reasons, **SSH** is disabled by default on all **Raspberry Pi** devices.
You need to enable it to continue.
If you have a monitor and keyboard connected, you can enable **SSH** during storage device setup, via the GUI, or in the Terminal.

To enable **SSH** in the Terminal, run:

```bash
sudo raspi-config
```
{: .copy-code}

On the **Raspberry Pi Software Configuration Tool (raspi-config)** page:

{% assign raspi-config = '
===
image: /images/devices-library/edge/paspberry-pi/1-raspi-config-interface-options.webp,
title: Go to **Interface Options** and press **Enter** to select it.
===
image: /images/devices-library/edge/paspberry-pi/2-raspi-config-enable-ssh.webp,
title: Select the **"Enable/disable remote command line access using SSH"** option and press Enter.
===
image: /images/devices-library/edge/paspberry-pi/3-raspi-config-confirm-enable-ssh.webp,
title: Select **Yes** to confirm that the SSH server is to be enabled
===
image: /images/devices-library/edge/paspberry-pi/4-raspi-config-ssh-server-enabled-ok.webp,
title: A confirmation message should appear indicating that the **SSH server is enabled**.
===
image: /images/devices-library/edge/paspberry-pi/5-raspi-config-finish.webp,
title: Select **Finish** and close the program.
'
%}

{% include images-gallery.liquid showListImageTitles="true" imageCollection=raspi-config %}

{% include /templates/edge/devices-library/rpi-enable-ssh.md %}
{% endif %}

To initiate an **SSH (Secure Shell)** connection to the **{{deviceName}}**, open the Terminal and run the following command:
Expand All @@ -49,6 +15,7 @@ ssh {{userName}}@ip_address #Enter the actual IP address

**ip_address:** Replace "_ip_address_" with the actual IP address of the **{{deviceName}}**.<br>
**Password:** The Terminal will request the password. {% if page.url contains "raspberry-pi" %}_The default password is `raspberry`._{% endif %}
{% if page.url contains "nvidia" %}_The default password is `nvidia`._{% endif %}

Once connected, follow the installation instructions below. Start by creating a new directory:

Expand Down
34 changes: 34 additions & 0 deletions _includes/templates/edge/devices-library/rpi-enable-ssh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

For security reasons, **SSH** is disabled by default on all **Raspberry Pi** devices.
You need to enable it to continue.
If you have a monitor and keyboard connected, you can enable **SSH** during storage device setup, via the GUI, or in the Terminal.

To enable **SSH** in the Terminal, run:

```bash
sudo raspi-config
```
{: .copy-code}

On the **Raspberry Pi Software Configuration Tool (raspi-config)** page:

{% assign raspi-config = '
===
image: /images/devices-library/edge/paspberry-pi/1-raspi-config-interface-options.webp,
title: Go to **Interface Options** and press **Enter** to select it.
===
image: /images/devices-library/edge/paspberry-pi/2-raspi-config-enable-ssh.webp,
title: Select the **"Enable/disable remote command line access using SSH"** option and press Enter.
===
image: /images/devices-library/edge/paspberry-pi/3-raspi-config-confirm-enable-ssh.webp,
title: Select **Yes** to confirm that the SSH server is to be enabled
===
image: /images/devices-library/edge/paspberry-pi/4-raspi-config-ssh-server-enabled-ok.webp,
title: A confirmation message should appear indicating that the **SSH server is enabled**.
===
image: /images/devices-library/edge/paspberry-pi/5-raspi-config-finish.webp,
title: Select **Finish** and close the program.
'
%}

{% include images-gallery.liquid showListImageTitles="true" imageCollection=raspi-config %}
17 changes: 17 additions & 0 deletions docs/edge/devices-library/nvidia-jetson-xavier-nx-developer-kit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: devices-library-article
title: How to install ThingsBoard Edge on NVIDIA Jetson Xavier NX Developer Kit?
category: Single-board computers
chip: NVIDIA CUDA
connectivity: Ethernet, WIFI, Bluetooth
vendor: NVIDIA
deviceImageFileName: nvidia-jetson-xavier-nx-developer-kit.png
docsPrefix: edge/
---


* TOC
{:toc}

{% include get-hosts-name.html %}
{% include /docs/devices-library/guides/nvidia-jetson-xavier-nx-developer-kit.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
docsTag: "edge-pe"
layout: devices-library-article
title: How to install ThingsBoard Edge on NVIDIA Jetson Xavier NX Developer Kit?
category: Single-board computers
chip: NVIDIA CUDA
connectivity: Ethernet, WIFI, Bluetooth
vendor: NVIDIA
deviceImageFileName: nvidia-jetson-xavier-nx-developer-kit.png
docsPrefix: pe/edge/
---


* TOC
{:toc}

{% include get-hosts-name.html docsPrefix=page.docsPrefix %}
{% include /docs/devices-library/guides/nvidia-jetson-xavier-nx-developer-kit.md %}
Binary file modified images/edge/user-guide/edge-install/1-instance-section-pe.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.