diff --git a/content/arduino-cloud/01.guides/00.overview/overview.md b/content/arduino-cloud/01.guides/00.overview/overview.md index b86ad4e8fd..9a532443b8 100644 --- a/content/arduino-cloud/01.guides/00.overview/overview.md +++ b/content/arduino-cloud/01.guides/00.overview/overview.md @@ -5,7 +5,7 @@ tags: [Arduino Cloud, Getting Started] author: 'Karl Söderby' --- -The [Arduino Cloud](https://app.arduino.cc/) is a platform for developing Arduino projects and connecting them to the world. It supports secure connections with boards via [Wi-Fi®](/arduino-cloud/hardware/wifi), [LoRa®](/arduino-cloud/hardware/lora), [Ethernet](/arduino-cloud/hardware/ethernet) and [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular), and lets you create a system for sending any variable information you can think of from one board to another within minutes of unboxing them. +The [Arduino Cloud](https://app.arduino.cc/) is a platform for developing Arduino projects and connecting them to the world. It supports secure connections with boards via [Wi-Fi®](/arduino-cloud/hardware/wifi), [LoRa®-enabled devices](/arduino-cloud/hardware/lora), [Ethernet](/arduino-cloud/hardware/ethernet) and [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular), and lets you create a system for sending any variable information you can think of from one board to another within minutes of unboxing them. The Arduino Cloud platform includes: - an **Integrated Development Environment (IDE)** for programming your boards, @@ -46,7 +46,7 @@ Compatibility with the Arduino Cloud is divided into two categories: For more information and list of supported boards, see the links below: - [Wi-Fi®](/arduino-cloud/hardware/wifi) -- [LoRa®](/arduino-cloud/hardware/lora) +- [LoRa®-enabled devices](/arduino-cloud/hardware/lora) - [Ethernet](/arduino-cloud/hardware/ethernet) - [Cellular (GSM/NB-IoT)](/arduino-cloud/hardware/cellular). @@ -147,4 +147,8 @@ Make sure to explore the various features of the Arduino Cloud through the links - [**Over-The-Air (OTA) Uploads**](/arduino-cloud/features/ota-getting-started) - upload code to devices not connected to your computer. - [**Webhooks**](/arduino-cloud/features/webhooks) - integrate your project with another service, such as IFTTT. - [**Amazon Alexa Support**](/arduino-cloud/guides/alexa) - make your project voice controlled with the Amazon Alexa integration. -- [**Dashboard Sharing**](/arduino-cloud/features/sharing-dashboards) - share your data with other people around the world. \ No newline at end of file +- [**Dashboard Sharing**](/arduino-cloud/features/sharing-dashboards) - share your data with other people around the world. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md b/content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md index 18525d7dfd..ab0d5c718f 100644 --- a/content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md +++ b/content/arduino-cloud/01.guides/02.arduino-c/arduino-c.md @@ -24,7 +24,7 @@ For this guide, you will need to have a registered account at Arduino. Register You will also need a supported board: - [Official Arduino Wi-Fi® boards](/arduino-cloud/hardware/wifi) - [ESP32 / ESP8266 boards](/arduino-cloud/hardware/wifi#configure-esp-boards) -- [Official LoRaWAN® boards](/arduino-cloud/hardware/lora) +- [Official boards compatible with LoRa®-based networks](/arduino-cloud/hardware/lora) - [Official Ethernet setups](/arduino-cloud/hardware/ethernet) - [Official cellular boards (GSM/NB-IoT)](/arduino-cloud/hardware/cellular) @@ -124,4 +124,8 @@ To control the state of the `test` variable, we can setup a **dashboard** and a ![Dashboard in the Arduino Cloud.](assets/dashboard.png) -***You can find more details in the [dashboards documentation](/arduino-cloud/cloud-interface/dashboard-widgets).*** \ No newline at end of file +***You can find more details in the [dashboards documentation](/arduino-cloud/cloud-interface/dashboard-widgets).*** + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/arduino-cloud/02.hardware/01.devices/devices.md b/content/arduino-cloud/02.hardware/01.devices/devices.md index 8b2d81e26a..2503b7d606 100644 --- a/content/arduino-cloud/02.hardware/01.devices/devices.md +++ b/content/arduino-cloud/02.hardware/01.devices/devices.md @@ -10,18 +10,18 @@ The Arduino Cloud supports a range of official and third-party boards which are Currently, the following device types are supported: - Wi-Fi® with encryption through on-board crypto chip - Wi-Fi® through ESP32 with user credentials -- LoRaWAN® +- LoRa®-enabled devices - Ethernet - Cellular (GSM / NB-IoT) - Manual (Python, MicroPython, JavaScript) -| **Type** | **Arduino Boards** | -|----------------|---------------------| -| **[WiFi](/arduino-cloud/hardware/wifi/)** | [MKR 1000](https://store.arduino.cc/arduino-mkr1000-wifi), [MKR WiFi 1010](https://store.arduino.cc/arduino-mkr-wifi-1010), [Nano 33 IoT](https://store.arduino.cc/arduino-nano-33-iot), [Portenta H7](https://store.arduino.cc/portenta-h7), [Nano RP2040 Connect](https://store.arduino.cc/products/arduino-nano-rp2040-connect), [Nicla Vision](https://store.arduino.cc/products/nicla-vision), [OPTA WiFi](https://store.arduino.cc/products/opta-wifi), [GIGA R1 WiFi](https://store.arduino.cc/products/giga-r1-wifi), [Portenta C33](https://store.arduino.cc/products/portenta-c33), [UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi), [Nano ESP32](https://store.arduino.cc/products/nano-esp32), [ESP8266](https://github.com/esp8266/Arduino/releases/tag/2.5.0), [ESP32](https://github.com/espressif/arduino-esp32/releases/tag/2.0.5) | -| **[GSM](/arduino-cloud/hardware/cellular/)** | [MKR GSM 1400](https://store.arduino.cc/arduino-mkr-gsm-1400-1415) | -| **[5G](/arduino-cloud/hardware/cellular/)** | [MKR NB 1500](https://store.arduino.cc/arduino-mkr-nb-1500-1413) | -| **[LoRa](/arduino-cloud/hardware/lora/)** | [MKR WAN 1300/1310](https://store.arduino.cc/mkr-wan-1310) | -| **[Ethernet](/arduino-cloud/hardware/ethernet/)** | [Portenta H7](https://store.arduino.cc/products/portenta-h7) + [Vision Shield Ethernet](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet), [Max Carrier](https://store.arduino.cc/products/portenta-max-carrier), [Breakout](https://store.arduino.cc/products/arduino-portenta-breakout), [Portenta Machine Control](https://store.arduino.cc/products/arduino-portenta-machine-control), [OPTA WiFi](https://store.arduino.cc/products/opta-wifi), [OPTA RS485](https://store.arduino.cc/products/opta-rs485), [OPTA Lite](https://store.arduino.cc/products/opta-lite), [Portenta C33](https://store.arduino.cc/products/portenta-c33) + [Vision Shield Ethernet](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet) | +| **Type** | **Arduino Boards** | +|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[WiFi](/arduino-cloud/hardware/wifi/)** | [MKR 1000](https://store.arduino.cc/arduino-mkr1000-wifi), [MKR WiFi 1010](https://store.arduino.cc/arduino-mkr-wifi-1010), [Nano 33 IoT](https://store.arduino.cc/arduino-nano-33-iot), [Portenta H7](https://store.arduino.cc/portenta-h7), [Nano RP2040 Connect](https://store.arduino.cc/products/arduino-nano-rp2040-connect), [Nicla Vision](https://store.arduino.cc/products/nicla-vision), [OPTA WiFi](https://store.arduino.cc/products/opta-wifi), [GIGA R1 WiFi](https://store.arduino.cc/products/giga-r1-wifi), [Portenta C33](https://store.arduino.cc/products/portenta-c33), [UNO R4 WiFi](https://store.arduino.cc/products/uno-r4-wifi), [Nano ESP32](https://store.arduino.cc/products/nano-esp32), [ESP8266](https://github.com/esp8266/Arduino/releases/tag/2.5.0), [ESP32](https://github.com/espressif/arduino-esp32/releases/tag/2.0.5) | +| **[GSM](/arduino-cloud/hardware/cellular/)** | [MKR GSM 1400](https://store.arduino.cc/arduino-mkr-gsm-1400-1415) | +| **[5G](/arduino-cloud/hardware/cellular/)** | [MKR NB 1500](https://store.arduino.cc/arduino-mkr-nb-1500-1413) | +| **[LoRa®-enabled Devices](/arduino-cloud/hardware/lora/)** | [MKR WAN 1300/1310](https://store.arduino.cc/mkr-wan-1310) | +| **[Ethernet](/arduino-cloud/hardware/ethernet/)** | [Portenta H7](https://store.arduino.cc/products/portenta-h7) + [Vision Shield Ethernet](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet), [Max Carrier](https://store.arduino.cc/products/portenta-max-carrier), [Breakout](https://store.arduino.cc/products/arduino-portenta-breakout), [Portenta Machine Control](https://store.arduino.cc/products/arduino-portenta-machine-control), [OPTA WiFi](https://store.arduino.cc/products/opta-wifi), [OPTA RS485](https://store.arduino.cc/products/opta-rs485), [OPTA Lite](https://store.arduino.cc/products/opta-lite), [Portenta C33](https://store.arduino.cc/products/portenta-c33) + [Vision Shield Ethernet](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet) | ***Check the GitHub repository [here](https://github.com/arduino-libraries/ArduinoIoTCloud?tab=readme-ov-file#what).*** @@ -50,13 +50,13 @@ Wi-Fi devices require you to enter valid credentials for the Wi-Fi network you a ***Read more and see the list of all compatible Wi-Fi® boards in the [Arduino Cloud Wi-Fi documentation](/arduino-cloud/hardware/wifi).*** -### Official LoRaWAN® Boards +### Official LoRa®-enabled Devices -LoRaWAN® boards also have a crypto chip on board but connect to the Arduino Cloud through nearby LoRaWAN® gateways. LoRaWAN® devices are designed to use minimal power and transmit over longer ranges, hence the name: -- **LoRa®** - long-range technology used for transmission of data using minimal amounts of power for long distances. -- **LoRaWAN®** - a network of gateways connected to the Internet that can receive and send data to LoRa® devices. +LoRa®-enabled devices also have a crypto chip on board but connect to the Arduino Cloud through nearby LoRa gateways. LoRa-enabled Devices are designed to use minimal power and transmit over longer ranges, hence the name: +- **LoRa® technology** - long-range technology used for transmission of data using minimal amounts of power for long distances. +- **LoRa®-based network** - a network of gateways connected to the Internet that can receive and send data to LoRa devices. -***Read more and see the list of all compatible LoRa® boards in the [Arduino Cloud LoRaWAN® documentation](/arduino-cloud/hardware/lora).*** +***Read more and see the list of all compatible LoRa®-enabled Devices in [this documentation](/arduino-cloud/hardware/lora).*** ### ESP32 / ESP8266 (Wi-Fi®) @@ -98,7 +98,7 @@ A device's information can be accessed directly in the Arduino Cloud under **"De - **ID** - your device's ID, mainly needed for manual device connection. - **Type** - name / type of board, e.g. MKR WiFi 1010. -- **Connection Type** - e.g. Wi-Fi®, LoRaWAN®. +- **Connection Type** - e.g. Wi-Fi®, LoRa®-based network. - **FQBN** - fully qualified board name, used for compilation for a specific board, e.g. `arduino:samd:mkrwifi1010`. - **Serial Number** - when configuring an official board, the serial number will be registered. - **Connectivity Module Firmware** - for Wi-Fi® boards only, the current firmware on the board's radio module. @@ -111,4 +111,8 @@ A device's information can be accessed directly in the Arduino Cloud under **"De All hardware devices connecting to the Arduino Cloud use the following libraries: - [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) - main library for Arduino Cloud, including methods for sending and receiving data, handling callbacks etc. Either via TCP/IP or LPWAN. -- [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) - library for handling connection methods to the Arduino Cloud (Wi-Fi®, LoRaWAN®, Ethernet, NB-IoT, GSM). +- [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) - library for handling connection methods to the Arduino Cloud (Wi-Fi®, LoRa®-based network, Ethernet, NB-IoT, GSM). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/arduino-cloud/02.hardware/03.lora/lora.md b/content/arduino-cloud/02.hardware/03.lora/lora.md index ca51494192..418df8d3df 100644 --- a/content/arduino-cloud/02.hardware/03.lora/lora.md +++ b/content/arduino-cloud/02.hardware/03.lora/lora.md @@ -1,9 +1,8 @@ --- -title: 'LoRaWAN®' -description: 'Connect your LoRaWAN® devices to the Arduino Cloud platform via The Things Network.' +title: 'LoRa® and The Things Stack' +description: 'Connect your devices compatible with long-range wireless networks to the Arduino Cloud platform via The Things Stack.' tags: - - LoRa® - - LoRaWAN® + - LoRa - 'The Things Industries' - 'Arduino Cloud' author: 'Karl Söderby' @@ -13,12 +12,12 @@ hardware: - hardware/01.mkr/01.boards/mkr-wan-1310 --- -Some Arduino boards support a connections to the Arduino Cloud via LoRaWAN® ([The Things Stack](https://www.thethingsindustries.com/stack/)). +Some Arduino boards support a connection to the Arduino Cloud via **long-range wireless networks**, using [The Things Stack](https://www.thethingsindustries.com/stack/), a LoRa®-based network server. In this document you will find: - List of supported devices. -- Configure a LoRaWAN® device in the Arduino Cloud. +- Configure a device compatible with LoRa® networks in the Arduino Cloud. - Register an account on The Things Console. - Create a simple testing program for the end device. - View data from the device in the Arduino Cloud. @@ -28,40 +27,40 @@ In this document you will find: ***Check the GitHub repository [here](https://github.com/arduino-libraries/ArduinoIoTCloud?tab=readme-ov-file#what).*** -The following boards connect to the Arduino Cloud via [The Things Stack](https://www.thethingsindustries.com/stack/), a LoRaWAN® Network Server connected to thousands of public LoRa® gateways. +The following boards connect to the Arduino Cloud via [The Things Stack](https://www.thethingsindustries.com/stack/), a LoRa®-based network server connected to thousands of public LoRa gateways. - [MKR WAN 1300](https://store.arduino.cc/arduino-mkr-wan-1300-lora-connectivity-1414) - [MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) ## The Things Stack - -If you are interested in building cheap, long-range & low-power devices, you will be excited to hear that Arduino Cloud is interfaced with [The Things Stack](https://www.thethingsindustries.com/stack/ ) network (TTS). When configuring a LoRaWAN® device (MKR WAN 1300/1310), you will also automatically register your device on the "The Things Stack" platform. - -So, what does that mean for you? It means that you can connect to any of the **22 000+ public gateways** making up the network. With coverage in most parts of the world, LoRa® technology has become increasingly more popular, as it continues to chirp payloads using the license-free frequency bands! Your end devices (such as the MKR WAN 1310), can be set up in remote locations (or cities, of course), where there's no internet connection. These devices can then send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. Data can also be sent the other way, from the Arduino Cloud to the end device via TTS. - + +If you are interested in building low-cost, low-power, and long-range devices, you will be excited to hear that Arduino Cloud interfaces with [The Things Stack](https://www.thethingsindustries.com/stack/) (TTS). When configuring a device such as the MKR WAN 1300/1310, it will automatically be registered on The Things Stack platform. + +So, what does that mean for you? It means that you can connect to any of the **22,000+ public gateways** making up the network. With coverage in most parts of the world, LoRa® technology has become increasingly popular. Your end devices (such as the MKR WAN 1310) can be set up in remote locations (or cities) without an internet connection. These devices can then send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. Data can also be sent in the opposite direction, from the Arduino Cloud to the end device via TTS. + In this tutorial, we will walk you through the steps needed to successfully provision devices that use the Arduino Cloud & The Things Network, from unboxing your device to viewing data on a dashboard! - -***Please note that when working with LoRaWAN® devices, data rates are very limited. Messages sent from devices should be limited to once every several minutes. Methods for implementing this are described further down in this article. To read more about limitations when using the LoRaWAN® network, please visit [The Things Network Limitations article](https://www.thethingsnetwork.org/docs/lorawan/limitations/ ).*** + +***When working with long-range wireless networks, data rates are limited. Messages sent from devices should be restricted to once every several minutes. For more information on network limitations, visit [The Things Network Limitations](https://www.thethingsnetwork.org/docs/lorawan/limitations/).*** ### Terminology Run-Trough - **LoRa®** - short for **Lo**ng **Ra**nge, is a modulation technique used to send and receive data over low-power, wide-area networks (LPWAN). -- **LoRaWAN®** - can be defined as the networking protocol. The architecture of the network consists of different gateways that relay messages from low-power devices over long ranges, to central network servers. -- **LoRa® gateway** - a network router able to send and receive LoRa RF packets and forward them on the internet. -- **MKR WAN 1300/1310** - development boards that have a LoRa® module capable of sending and receiving packets of data. -- **End device/node** - end device/node is a term used for deployed devices such as the MKR WAN 1310, that for example are reading and processing sensor data. -- **The Things Network (TTN)** - a nonprofit association, making the TTS Community Edition available as a public LoRaWAN® network service for free. -- **The Things Stack Network (TTS)** - a Cloud platform used by TTN and TTI for their LoRaWAN® connectivity networks. -- **The Things Industries (TTI)** - a company that runs and manages The Things Network and offers private LoRaWAN network and support for enterprise customers. -- **The Things Stack console (TTC)** - a service that allows you to register devices and handle incoming or outgoing data. +- **LoRa®-based network** - a type of network that uses LoRa modulation for communication between end devices and gateways. +- **LoRa® gateway** - a network router able to send and receive LoRa RF packets and forward them to the internet. +- **MKR WAN 1300/1310** - development boards that feature a LoRa module capable of sending and receiving packets of data. +- **End device/node** - a term used for deployed devices such as the MKR WAN 1310, which read and process sensor data. +- **The Things Network (TTN)** - a nonprofit association providing a public LoRa®-based network service. +- **The Things Stack Network (TTS)** - a cloud platform used by TTN and TTI for network infrastructure. +- **The Things Industries (TTI)** - a company that runs and manages The Things Network and offers private network services. +- **The Things Stack Console (TTC)** - a service that allows you to register devices and handle incoming or outgoing data. - **Device EUI** - a code to identify your device. - **App EUI** - a code to identify your application. - **App KEY** - a key used for encryption and decryption of a payload. -- **Frequency Band (e.g. 868 MHz, 915 MHz)** - LoRa only operates on specific, license-free frequencies which differ from region to region. For example, the band used in Europe is 868 MHz, while North America uses the 915 MHz band. +- **Frequency Band (e.g., 868 MHz, 915 MHz)** - LoRa® operates on license-free frequencies, which differ by region. ### Related Resources -If you want to learn more about Arduino and LoRa®, you can check out the resources below: +If you want to learn more about Arduino and LoRa®, check out these resources: - [MKR WAN 1300 documentation page.](/hardware/mkr-wan-1300) - [MKR WAN 1310 documentation page](/hardware/mkr-wan-1310) @@ -164,8 +163,7 @@ In this step, we will complete the registration so we can access the **The Thing **8.** You are now in the application overview. Here you will find a lot of useful information, such as **DevEUI, AppEUI & AppKey**, and see the live data that is sent to and from your device. You do not need to make any changes here, but it acts as a great troubleshooting tool to check if your device is working. -### TTI Email Expiration - +### TTI Email Expiration After some time, the automatic email sent out by TTI will expire. If the link is expired and you wish to access the Things Stack Network, you can click on the **"Forgot Password"** link which will restart the activation. @@ -317,4 +315,9 @@ See the link below for more resources on adding gateways to the Things Stack net - [Adding Gateways | The Things Industries](https://www.thethingsindustries.com/docs/gateways/adding-gateways/ ) - [Recommended Gateways | YouTube](https://www.youtube.com/watch?v=h_6dIte_IxI&ab_channel=TheThingsNetwork ) + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. + \ No newline at end of file diff --git a/content/arduino-cloud/03.cloud-interface/00.sketches/sketches.md b/content/arduino-cloud/03.cloud-interface/00.sketches/sketches.md index 25ac653d71..be58d1a2fd 100644 --- a/content/arduino-cloud/03.cloud-interface/00.sketches/sketches.md +++ b/content/arduino-cloud/03.cloud-interface/00.sketches/sketches.md @@ -67,7 +67,7 @@ Sketches with an attached Thing are more complex and are generated automatically The sketch file is generated with a set of additional Cloud-specific methods included, the essentials being: - `initProperties()` - initializes properties/variables from your Thing. -- `ArduinoCloud.begin()` starts the library with the preferred connection (e.g. Wi-Fi® or LoRaWAN®). +- `ArduinoCloud.begin()` starts the library with the preferred connection (e.g. Wi-Fi® or LoRa®-based networks). - `ArduinoCloud.update()` - synchronizes all data between the board and the Arduino Cloud. In addition, any variable created with a read/write permission will also generate a callback function that executes whenever the variable's value changes. @@ -108,7 +108,7 @@ void onTestChange(){ The `thingProperties.h` file is a non-editable file that updates based on changes made in your Thing. For example: - Creating a variable will add it to this file, along with parameters such as permission, update policy, variable type etc. -- Changing from a Wi-Fi® device to a LoRa® device will update the **connection method** stored in this file, +- Changing from a Wi-Fi® device to a LoRa®-enabled device will update the **connection method** stored in this file, The file cannot be edited in the Arduino Cloud as it is in sync with the platform and changes frequently. @@ -227,4 +227,8 @@ The [Arduino Create Agent](https://github.com/arduino/arduino-create-agent) is a Downloading and installing the Arduino Create Agent plugin can be done following [this quick and easy process](https://create.arduino.cc/getting-started/plugin/welcome). -The full documentation of the [Arduino Create Agent is available here](https://github.com/arduino/arduino-create-agent#readme) for more advanced usage. \ No newline at end of file +The full documentation of the [Arduino Create Agent is available here](https://github.com/arduino/arduino-create-agent#readme) for more advanced usage. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/arduino-cloud/03.cloud-interface/01.things/things.md b/content/arduino-cloud/03.cloud-interface/01.things/things.md index 15b563816e..e8e9d3abb0 100644 --- a/content/arduino-cloud/03.cloud-interface/01.things/things.md +++ b/content/arduino-cloud/03.cloud-interface/01.things/things.md @@ -58,7 +58,7 @@ In the device section, you can select either a previously configured device, or You can connect one of the following devices: - [Arduino Wi-Fi® devices](/arduino-cloud/hardware/wifi) - official Arduino devices with a Wi-Fi® enabled module. -- [Arduino LoRaWAN® devices](/arduino-cloud/hardware/lora) - official Arduino devices with a LoRaWAN® module. +- [Arduino LoRa®-enabled devices](/arduino-cloud/hardware/lora) - official Arduino devices with a LoRa® technology. - [Third-party ESP32/ESP8266 devices](/arduino-cloud/hardware/wifi) - third party devices with an ESP32/ESP8266 SoC. - [Manual devices](/arduino-cloud/hardware/devices#manual-devices) - a virtual device using MicroPython, Python or JavaScript. These devices do not have a sketch associated. @@ -68,7 +68,7 @@ The status of your device is also displayed in this section (online/offline). ## Network -In the network section, you configure the credentials for your network, such as your Wi-Fi® network, secret key (for ESP32 boards) and other credentials e.g. LoRaWAN® & cellular. The network details are securely stored. +In the network section, you configure the credentials for your network, such as your Wi-Fi® network, secret key (for ESP32 boards) and other credentials e.g. LoRa®-based networks & cellular. The network details are securely stored. ![Network configuration.](assets/network-creds.png) @@ -133,3 +133,7 @@ For example: This is implemented so that the connection and synchronization between the board and Cloud is handled automatically, meaning you do not need to do any networking code when using the Arduino / C++ language. ***Please note that if you are using an offline environment, [Arduino IDE](/software/ide-v2), changes will only be made in the Cloud environment and will manually need to be adjusted. If you plan on using the offline IDE, you make use of the [sketch synchronisation](/software/ide-v2/tutorials/ide-v2-cloud-sketch-sync) feature that allows you to push/pull your Cloud sketches from the offline IDE.*** + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/arduino-cloud/07.api/03.c-library/c-library.md b/content/arduino-cloud/07.api/03.c-library/c-library.md index 0ea88989dc..6764f94f3c 100644 --- a/content/arduino-cloud/07.api/03.c-library/c-library.md +++ b/content/arduino-cloud/07.api/03.c-library/c-library.md @@ -5,11 +5,11 @@ author: Karl Söderby tags: [C++, Arduino] --- -The default Arduino / C++ library for the Arduino Cloud is the [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) library. This library depends on the [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) library which provides connection via various wireless protocols (Wi-Fi®, LoRaWAN®, NB-IoT, GSM, Ethernet). +The default Arduino / C++ library for the Arduino Cloud is the [ArduinoIoTCloud](https://github.com/arduino-libraries/ArduinoIoTCloud) library. This library depends on the [Arduino_ConnectionHandler](https://github.com/arduino-libraries/Arduino_ConnectionHandler) library which provides connection via various wireless protocols (Wi-Fi®, LoRa® technology, NB-IoT, GSM, Ethernet). The library is integrated into the Arduino Cloud platform, where [Automatic Sketch Generation](/arduino-cloud/cloud-interface/sketches#iot-sketches) converts your Thing configurations into a set files that relies on aforementioned libraries. -The **ArduinoIoTCloud** library supports either connection via **TCP/IP** or **LoRaWAN®**. Depending on the device you compile for, the library automatically chooses the right configuration. +The **ArduinoIoTCloud** library supports either connection via **TCP/IP** or using **LoRa® technology**. Depending on the device you compile for, the library automatically chooses the right configuration. ## GitHub @@ -18,7 +18,7 @@ To view the source code and report issues, follow the links below to the GitHub ## Connection Methods -The ArduinoIoTCloud library supports both connection via TCP/IP and via LoRaWAN®, which is enabled via the `ArduinoIoTCloudTCP` and `ArduinoIoTCloudLPWAN` classes. Depending on what [device you configure](/arduino-cloud/hardware/devices), the library will automatically choose the right class, which will externally be available in your sketch file as `ArduinoCloud` class. +The ArduinoIoTCloud library supports both connection via TCP/IP and via LoRa®-based networks, which is enabled via the `ArduinoIoTCloudTCP` and `ArduinoIoTCloudLPWAN` classes. Depending on what [device you configure](/arduino-cloud/hardware/devices), the library will automatically choose the right class, which will externally be available in your sketch file as `ArduinoCloud` class. ### TCP / MQTT @@ -26,9 +26,9 @@ When connecting via [TCP/IP](https://en.wikipedia.org/wiki/Internet_protocol_sui - [ArduinoIoTCloudTCP.cpp](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudTCP.cpp) - [ArduinoIoTCloudTCP.h](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudTCP.h) -### LoRaWAN® +### LoRa®-Based Network -When connecting via LoRaWAN®, data is sent via [The Things Network](https://www.thethingsnetwork.org/), which is integrated with the Arduino Cloud. This support is enabled in the following files: +When connecting via LoRa®-based network, data is sent via [The Things Network](https://www.thethingsnetwork.org/), which is integrated with the Arduino Cloud. This support is enabled in the following files: - [ArduinoIoTCloudLPWAN.cpp](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudLPWAN.cpp) - [ArduinoIoTCloudLPWAN.h](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/master/src/ArduinoIoTCloudLPWAN.h) @@ -82,4 +82,8 @@ function whenever the `CONNECT` event occurs. The example below demonstrates how to use events & callbacks in the Arduino Cloud. - \ No newline at end of file + + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/arduino-cloud/08.arduino-cloud-cli/07.getting-started/arduino-cloud-cli.md b/content/arduino-cloud/08.arduino-cloud-cli/07.getting-started/arduino-cloud-cli.md index 00fbc67301..ac74bcbcdd 100644 --- a/content/arduino-cloud/08.arduino-cloud-cli/07.getting-started/arduino-cloud-cli.md +++ b/content/arduino-cloud/08.arduino-cloud-cli/07.getting-started/arduino-cloud-cli.md @@ -126,15 +126,15 @@ Here's follows the FQBN's list of the supported devices: * `arduino:samd:mkrgsm1400` [Arduino MKR GSM 1400](https://docs.arduino.cc/hardware/mkr-gsm-1400) * `arduino:samd:mkrnb1500` [Arduino MKR NB 1500](https://docs.arduino.cc/hardware/mkr-nb-1500) -### LoRaWAN® Devices +### LoRa®-Enabled Devices -To configure LoRaWAN® devices, use the additional `create-lora` and the `--frequency-plan` flag. This +To configure LoRa®-enabled devices, use the additional `create-lora` and the `--frequency-plan` flag. This ``` arduino-cloud-cli device create-lora --name --frequency-plan --port --fqbn ``` -LoRaWAN® devices that are supported: +LoRa®-enabled devices that are supported: * `arduino:samd:mkrwan1310` * `arduino:samd:mkrwan1300` @@ -457,3 +457,6 @@ To recap, this tool can be used to: - List all available components from the Cloud (like `thing list`). - Tag your devices & Things with the `--tags =` command. +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/arduino-cloud/09.business/09.arduino-cloud-for-business/content.md b/content/arduino-cloud/09.business/09.arduino-cloud-for-business/content.md index e23a086d9e..9d332204b0 100644 --- a/content/arduino-cloud/09.business/09.arduino-cloud-for-business/content.md +++ b/content/arduino-cloud/09.business/09.arduino-cloud-for-business/content.md @@ -233,7 +233,7 @@ The Arduino Cloud for Business allows for device management with Over-The-Air up ### Compatible Hardware -The Arduino Cloud for Business is compatible with multiple Arduino boards or devices based on the ESP32 / ESP8266 microcontrollers. The Arduino Cloud currently supports devices connected via Wi-Fi®, Ethernet, LoRaWAN® (via The Things Network), and cellular connectivity. +The Arduino Cloud for Business is compatible with multiple Arduino boards or devices based on the ESP32 / ESP8266 microcontrollers. The Arduino Cloud currently supports devices connected via Wi-Fi®, Ethernet, LoRa®-based networks (via The Things Network), and cellular connectivity. To check the full list of compatible Hardware, have a look at [this tutorial](https://docs.arduino.cc/arduino-cloud/guides/overview). @@ -490,3 +490,7 @@ You are just a few easy steps from deploying your very own IoT project. Having a What will you create? [Start your Cloud journey now](https://cloud.arduino.cc/plans#business). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/arduino-cloud/10.education/00.arduino-cloud-for-education/content.md b/content/arduino-cloud/10.education/00.arduino-cloud-for-education/content.md index 888a7706b8..972c29c7a0 100644 --- a/content/arduino-cloud/10.education/00.arduino-cloud-for-education/content.md +++ b/content/arduino-cloud/10.education/00.arduino-cloud-for-education/content.md @@ -96,7 +96,7 @@ The Arduino Cloud supports a range of official and third-party boards which are ![Device tab in the Cloud homepage](assets/device-list.png) -The Arduino Cloud currently supports devices connected via Wi-Fi®, Ethernet, LoRaWAN® (via The Things Network), and cellular connectivity. You can check the [full list of compatible hardware here](https://support.arduino.cc/hc/en-us/articles/360016077320-What-devices-can-be-used-with-Arduino-IoT-Cloud-). +The Arduino Cloud currently supports devices connected via Wi-Fi®, Ethernet, LoRa®-based networks (via The Things Network), and cellular connectivity. You can check the [full list of compatible hardware here](https://support.arduino.cc/hc/en-us/articles/360016077320-What-devices-can-be-used-with-Arduino-IoT-Cloud-). ### Things @@ -214,3 +214,7 @@ If you are a enthusiast and would like to explore more about our Cloud platform, - [Dashboards & Widgets](https://docs.arduino.cc/arduino-cloud/cloud-interface/dashboard-widgets) - [Cloud Remote App](https://docs.arduino.cc/arduino-cloud/iot-remote-app/getting-started) - [Setup a Shared Space for your class](https://docs.arduino.cc/arduino-cloud/education/shared-spaces) + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/features.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/features.md index aa3ea34aaf..8884be2814 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/features.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/features.md @@ -4,9 +4,9 @@ The MKR WAN 1300 brings LoRa® connectivity to your projects. Using the popular - + -Use LoRaWAN® in remote places to send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. +Use LoRa® technology in remote places to send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. @@ -16,7 +16,7 @@ Use LoRaWAN® in remote places to send data to nearby gateways connected to the -Use the LoRa® wireless protocol to implement your own networks, or connect to various LoRaWAN® networks, such as [The Things Network](https://www.thethingsnetwork.org/). +Use the LoRa® wireless protocol to implement your own networks or connect to public networks such as [The Things Network](https://www.thethingsnetwork.org/). @@ -26,7 +26,7 @@ Use the LoRa® wireless protocol to implement your own networks, or connect to v -Set up two Arduino MKR WAn 1300 to host a remote LED control. Learn more about board-to-board communication and using LoRa® in your projects. +Set up two Arduino MKR WAN 1300 to host a remote LED control system. Learn more about board-to-board communication and using LoRa® technology in your projects. @@ -34,4 +34,4 @@ Set up two Arduino MKR WAn 1300 to host a remote LED control. Learn more about b - \ No newline at end of file + diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/product.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/product.md index dd58884feb..5439b7748e 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/product.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/product.md @@ -11,5 +11,4 @@ productCode: '129' sku: [ABX00017] --- - -The Arduino MKR WAN 1300 was the first LoRa® board released by Arduino, as a practical and cost effective solution with minimal power requirements. This open source board can connect to the Arduino Cloud, your own LoRa® network using the Arduino LoRa® PRO Gateway, existing LoRaWAN® infrastructure like The Things Network, or even other boards using the direct connectivity mode. \ No newline at end of file +The Arduino MKR WAN 1300 was the first LoRa® board released by Arduino, offering a practical and cost-effective solution with minimal power requirements. This open source board can connect to the Arduino Cloud, your own LoRa-based network using the Arduino LoRa® PRO Gateway, existing public networks such as The Things Network (TTN) or even other boards using direct connectivity mode. \ No newline at end of file diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-button-press/lora-button-press.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-button-press/lora-button-press.md index b4006c6807..48e7f77f3d 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-button-press/lora-button-press.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-button-press/lora-button-press.md @@ -2,7 +2,7 @@ title: "LoRa® LED Control with MKR WAN 1300" difficulty: intermediate compatible-products: [mkr-wan-1300] -description: 'Learn how to connect two boards using LoRa®, and how to control an LED remotely from another board.' +description: 'Learn how to connect two boards using LoRa® technology and control an LED remotely from another board.' tags: - IoT - LoRa® @@ -57,7 +57,7 @@ ___ ## Let's Start -In this tutorial, we will achieve a basic trigger over the LoRa® network. When we press a button on one of the MKR WAN 1300 boards, an LED will light up on another. This is quite a simple setup, but it can be useful for long range, low power communication! +In this tutorial, we will achieve a basic trigger using the LoRa® technology. When we press a button on one of the MKR WAN 1300 boards, an LED will light up on another. This is quite a simple setup, but it can be useful for long range, low power communication! But let's take a look at what we need to include in the code. As we are using two different boards, we will also need to create two separate sketches. @@ -363,5 +363,9 @@ If the code is not working, there are some common issues we might need to troubl ## Conclusion -This tutorial demonstrates a simple, yet powerful communication setup, featuring two MKR WAN 1300 boards and how to remotely control an LED using LoRa®. +This tutorial demonstrates a simple, yet powerful communication setup, featuring two MKR WAN 1300 boards and how to remotely control an LED using LoRa® technology. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-message/lora-message.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-message/lora-message.md index f7a4d40cdd..19152b4ed3 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-message/lora-message.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-message/lora-message.md @@ -1,5 +1,5 @@ --- -title: "LoRa® Message Service with MKR WAN 1300" +title: "LoRa®-Based Messaging with MKR WAN 1300" difficulty: intermediate compatible-products: [mkr-wan-1300] description: 'Learn how to use the Serial Monitor to send messages between two MKR WAN 1300 boards using LoRa® technology.' @@ -19,7 +19,7 @@ software: - web-editor --- -In this tutorial, we will use two MKR WAN 1300's to set up a simple message service over the LoRa® network. This communication will be achieved through the Serial Monitor, where you can send and receive messages directly. +In this tutorial, we will use two MKR WAN 1300's to set up a simple message service over a LoRa®-based communication channel. This communication will be achieved through the Serial Monitor, where you can send and receive messages directly. We will use the **LoRa** library to for the communication, and we will not use any external services. Additionally, we will also create specific addresses for each board. This will help ensure that the messages that we send and receive are only displayed on the corresponding devices. @@ -48,7 +48,7 @@ ___ ## Let's Start -In this tutorial, we will create a message service that utilizes the LoRa® network. In our other tutorials for the MKR WAN 1300 board, we have typically set up one board as a sender, and one as a receiver. Now, we will instead set them up as **both sender and receiver**. This will allow us to both send and receive packets simultaneously, which works very similar to any messenger service you might be used to! +In this tutorial, we will create a message service that uses a LoRa®-based communication channel. In our other tutorials for the MKR WAN 1300 board, we have typically set up one board as a sender, and one as a receiver. Now, we will instead set them up as **both sender and receiver**. This will allow us to both send and receive packets simultaneously, which works very similar to any messenger service you might be used to! To do this, we basically only need to create one sketch that we will upload to each of the MKR WAN 1300 boards, with only some minor adjustments made in the code for each. @@ -146,7 +146,7 @@ Whenever the `onReceive()` function is called upon, it first checks whether a pa But if a packet comes in, there are two major things that happen. First, we read the packet, using the command `int recipient = LoRa.read();`, which contains the `localAddress` (sent from the other board). We then create a string called `incoming`, which we then store the incoming message in. -We then compare `recipient` to `localAddress` and `0xFF`, and if it doesn't match, we print "This message is not for me" in the Serial Monitor. As there are many people using the LoRa® network, we might intercept other messages, and if we do, that is the message we will see instead. +We then compare `recipient` to `localAddress` and `0xFF`, and if it doesn't match, we print "This message is not for me" in the Serial Monitor. As there are many people using the LoRa®-based network, we might intercept other messages, and if we do, that is the message we will see instead. Finally, we print the message stored in the `incoming` string in the Serial Monitor, along with RSSI. @@ -349,9 +349,9 @@ void loop() { ## Upload Sketch and Testing the Program -Once we are finished with the code, we can upload the sketches to each board. At this point, we will need **two computers**, as we are going to write messages between them. When the code has been uploaded, **open the Serial Monitor on each computer**. +Once we are finished with the code, we can upload the sketches to each board. At this point, we will need **two computers**, as we are going to exchange messages between them. When the code has been uploaded, **open the Serial Monitor on each computer**. -If everything goes right, we should be able to write messages over the LoRa® network. This is done by simply typing a message in the Serial Monitor of either device, and hit "enter" once finished. This will store the entered message in a string called `message`. In the code, we also created a packet and printed `message` to it. This is done automatically after we have hit "enter", and should now be sent to the other device. +If everything goes right, we should be able to write messages over the LoRa®-based network. This is done by simply typing a message in the Serial Monitor of either device, and hit "enter" once finished. This will store the entered message in a string called `message`. In the code, we also created a packet and printed `message` to it. This is done automatically after we have hit "enter", and should now be sent to the other device. >**Important:** the Serial Monitor needs to be open for both devices in order to send and receive messages. If we send a message from **Device #1**, we will need to have the Serial Monitor open on **Device #2**. @@ -383,4 +383,9 @@ If the code is not working, there are some common issues we might need to troubl ## Conclusion -In this tutorial, we have created a messaging over LoRa® application, using two MKR WAN 1300 boards and two antennas. In the right conditions, these boards can send messages over very long distances, and can be an ideal solution for remote places where internet access is limited. +In this tutorial, we have created a LoRa®-based messaging service application, using two MKR WAN 1300 boards and two antennas. In the right conditions, these boards can send messages over very long distances, and can be an ideal solution for remote places where internet access is limited. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. + diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-send-and-receive/lora-send-and-receive.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-send-and-receive/lora-send-and-receive.md index 84969db954..39a2f3f6d2 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-send-and-receive/lora-send-and-receive.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-send-and-receive/lora-send-and-receive.md @@ -1,5 +1,5 @@ --- -title: "Send Data Using LoRa® with MKR WAN 1300" +title: "Send Data Using LoRa® Technology with MKR WAN 1300" difficulty: intermediate compatible-products: [mkr-wan-1300] description: 'Learn how to setup a continuous stream of data between two devices using LoRa® technology.' @@ -19,7 +19,7 @@ software: - web-editor --- -The Arduino MKR WAN 1300 is an excellent entry point to get started with low-powered, wide-area networks (LPWAN). In this tutorial, we will go through some of the core concepts such as long range (LoRa®) and the LoRaWAN® protocol. +The Arduino MKR WAN 1300 is an excellent entry point to get started with low-power, wide-area networks (LPWAN). In this tutorial, we will explore some of the core concepts behind LoRa® technology and set up direct communication between two MKR WAN 1300 boards. We will create a basic sketch that will allow communication between two **MKR WAN 1300** boards. The communication will be established firstly through the radio module on the board, where we will also attach an antenna to each board. @@ -27,17 +27,13 @@ We will create a basic sketch that will allow communication between two **MKR WA There are many different terms to be familiar with in the world of LoRa® technology, so let's go through some of them! -### LoRa® +### LoRa® Technology -LoRa® is short for long range modulation technique based on a technology called chirp spread spectrum (CSS). It is designed to carry out long-range transmissions with minimal power consumption. LoRa® defines as the "lower layer" or **"physical layer"**, according to the **OSI model**. The physical layer is defined by hardware, signals and frequencies. +LoRa® is short for long range modulation technique based on a technology called chirp spread spectrum (CSS). It is designed to carry out long-range transmissions with minimal power consumption. LoRa defines as the "lower layer" or **"physical layer"**, according to the **OSI model**. The physical layer is defined by hardware, signals and frequencies. LoRa® uses different radio frequencies depending on where you are located in the world. The most common are Europe (868 MHz) and North America & Australia (915 MHz), but it differs from country to country. You can also read more about a [country's unique radio frequency](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country/). -LoRa® is also often used to describe hardware devices supported by LoRa®, e.g. modules or gateways. The Arduino MKR WAN 1300 has a LoRa® module called **Murata CMWX1ZZABZ**. - -### LoRaWAN® - -LoRaWAN® can be defined as the networking protocol used in an Low-Power, Wide-Area networks (LPWAN). The architecture of the network consists of different gateways that relay messages from low-power devices over long ranges, to central network servers. The protocol is defined as the **upper networking layers**. +LoRa® is also often used to describe hardware devices supported by LoRa, e.g. modules or gateways. The Arduino MKR WAN 1300 has a LPWAN module called **Murata CMWX1ZZABZ**. ### The Benefits of LoRa® @@ -57,7 +53,7 @@ ___ - 2x Micro USB cable . - Arduino IDE (offline and online versions available). - Arduino SAMD Board Package installed ([follow this link for instructions](/software/ide-v2/tutorials/ide-v2-board-manager)). -- LoRa library installed (see the [github repository](https://github.com/sandeepmistry/arduino-LoRa)). +- `LoRa` library installed (see the [github repository](https://github.com/sandeepmistry/arduino-LoRa)). ### Circuit @@ -188,7 +184,6 @@ void loop() { ``` -{/* Here we link the full program from create */} ## Complete Code If you choose to skip the code building section, the complete code can be found below: @@ -281,8 +276,11 @@ If the code is not working, there are some common issues we might need to troubl - We have not opened the Serial Monitor. - We are using the same computer for both boards without a serial interfacing program. - ## Conclusion -In this tutorial, we have introduced some fundamental concepts around LoRa®, where we have setup a basic communication line between two boards using the LoRa® network. With this basic framework, you can go on to combine this tutorial with sensors and other software libraries, so that you can create your own long-range, low-powered devices! +In this tutorial, we have introduced some fundamental concepts around LoRa® technology, where we have setup a basic communication line between two boards using the LoRa® technology-based communication. With this basic framework, you can go on to combine this tutorial with sensors and other software libraries, so that you can create your own long-range, low-powered devices! + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-sensor-data/lora-sensor-data.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-sensor-data/lora-sensor-data.md index 033e4cc304..0861ecfa69 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-sensor-data/lora-sensor-data.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/lora-sensor-data/lora-sensor-data.md @@ -88,7 +88,7 @@ int counter = 0; In the `setup()` we will begin serial communication, where we will use the command `while(!Serial);` to prevent the program from running until we open the Serial Monitor. -We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6. +We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for communication based on LoRa® technology. If we are located in North America, we need to change this to 915E6. As we are using the MKR ENV shield, we also need to initialize the **Arduino_MKRENV** library by using the line `if (!ENV.begin())` followed by an error message in case it failed to initialize. @@ -298,7 +298,10 @@ If the code is not working, there are some common issues we might need to troubl - We have not opened the Serial Monitor. - We are using the same computer for both boards without a serial interfacing program. - ## Conclusion This tutorial demonstrates a simple communication between two MKR WAN 1300 boards and a MKR ENV shield, using LoRa® technology. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/the-things-network/the-things-network.md b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/the-things-network/the-things-network.md index 374a6fc511..7d041cdf9e 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/the-things-network/the-things-network.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1300/tutorials/the-things-network/the-things-network.md @@ -24,9 +24,9 @@ software: In this tutorial, we will go through how to set up the MKR WAN 1300 board to work with The Things Network (TTN). -It is a good idea to already look at the limitations of using LoRa®. As with any technology, there advantages and disadvantages, and with LoRa®, there's also some limitations of how much data we can send. You can read more about this through the link below: +It is a good idea to already look at the limitations of using LoRa® technology. As with any technology, there advantages and disadvantages, and with LoRa, there's also some limitations of how much data we can send. You can read more about this through the link below: -- [Limitations of LoRaWAN®](https://www.thethingsnetwork.org/docs/lorawan/limitations/) +- [Limitations of LoRa®-based networks](https://www.thethingsnetwork.org/docs/lorawan/limitations/) ## Goals @@ -48,14 +48,14 @@ The goals of this project are: - 1x micro USB cable. -## LoRaWAN® +## LoRa®-Based Network -LoRaWAN®, stands for **Long Range Wide Area Network**, which is becoming increasingly popular in the Internet of Things-sphere, due to its capability of sending data over larger distances using minimal battery power and ensuring that data and credentials remain secure. There are also other acronyms that are associated with LoRaWAN® such as: +LoRa®-based network is becoming increasingly popular in the Internet of Things-sphere, due to its capability of sending data over larger distances using minimal battery power and ensuring that data and credentials remain secure. There are also other acronyms that are associated with LoRa-based Network such as: -- LoRa® which stands for Long Range +- LoRa® technology which stands for Long Range - LP WAN which stands for Low Power Wide Area Network -LoRa® devices come with lower data rates, with longer intervals than i.e. a device connected through WiFi. This is due to the low-power consumption and long range that LoRa® technology puts emphasis on. +LoRa® devices come with lower data rates, with longer intervals than i.e. a device connected through WiFi. This is due to the low-power consumption and long range that LoRa technology puts emphasis on. While the data rate may be a restriction, let’s have a look at some of the amazing features LoRa® technology comes with: @@ -65,7 +65,7 @@ While the data rate may be a restriction, let’s have a look at some of the ama - **Security:** The MKR WAN 1300 board comes with the crypto chip (ECC-508), which allows us to store data and credentials securely. -In this tutorial, we will be covering the basics of setting up a MKRWAN series device to connect to the LoRa® network, through something called The Things Network (TTN). We can start by looking at [this map](https://www.thethingsnetwork.org/map) to see if we are within reach of a gateway. +In this tutorial, we will be covering the basics of setting up a MKRWAN series device to connect to the LoRa®-based network, through something called The Things Network (TTN). We can start by looking at [this map](https://www.thethingsnetwork.org/map) to see if we are within reach of a gateway. ### Circuit @@ -179,5 +179,8 @@ This will decode the incoming message and add the text "payload: yourmessage" at In this tutorial, we have looked at how to connect our MKR WAN 1300 board to the The Things Network (TTN). We have retrieved the device EUI, used it to register the device in the TTN console, and programmed the board using the data provided by TTN. -As long as we are in range of a TTN gateway, we can now send data over the LoRa® network which can be viewed from anywhere in the world (as long as we have an Internet connection). +As long as we are in range of a TTN gateway, we can now send data over the LoRa®-based network which can be viewed from anywhere in the world (as long as we have an Internet connection). +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/features.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/features.md index a875da8664..fa86077c47 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/features.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/features.md @@ -4,9 +4,9 @@ The MKR WAN 1310 brings LoRa® connectivity to your projects. Using the popular - + -Use LoRaWAN® in remote places to send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. +Use LoRa® technology in remote places to send data to nearby gateways connected to the TTS service, which in turn forwards the data to the Arduino Cloud. @@ -17,7 +17,7 @@ Use LoRaWAN® in remote places to send data to nearby gateways connected to the -Use the LoRa® wireless protocol to implement your own networks, or connect to various LoRaWAN® networks, such as [The Things Network](https://www.thethingsnetwork.org/). +Use the LoRa® wireless protocol to implement your own networks or connect to public networks such as [The Things Network](https://www.thethingsnetwork.org/). @@ -27,7 +27,7 @@ Use the LoRa® wireless protocol to implement your own networks, or connect to v -Set up two Arduino MKR WAn 1300 to host a remote LED control. Learn more about board-to-board communication and using LoRa® in your projects. +Set up two Arduino MKR WAN 1310 to host a remote LED control system. Learn more about board-to-board communication and using LoRa® technology in your projects. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/product.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/product.md index d93d072167..bf58ff7321 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/product.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/product.md @@ -11,4 +11,4 @@ productCode: '030' sku: [ABX00029] --- -The Arduino MKR WAN 1310 provides a practical and cost effective solution to add LoRa® connectivity to projects requiring low power. This open source board can connect to the Arduino Cloud, your own LoRa® network using the Arduino LoRa® PRO Gateway, existing LoRaWAN® infrastructure like The Things Network, or even other boards using the direct connectivity mode. \ No newline at end of file +The Arduino MKR WAN 1310 provides a practical and cost effective solution to add LoRa® connectivity to projects requiring low power. This open source board can connect to the Arduino Cloud, your own LoRa-based network using the Arduino LoRa® PRO Gateway, existing public networks such as The Things Network or even other boards using the direct connectivity mode. \ No newline at end of file diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-button-press/lora-button-press.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-button-press/lora-button-press.md index 88d28e6329..52fe774cff 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-button-press/lora-button-press.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-button-press/lora-button-press.md @@ -2,7 +2,7 @@ title: LoRa® LED Control with MKR WAN 1310 difficulty: intermediate compatible-products: [mkr-wan-1310] -description: 'Learn how to connect two boards using LoRa®, and how to control an LED remotely from another board.' +description: 'Learn how to connect two boards using LoRa® technology and control an LED remotely from another board.' tags: - IoT - LoRa® @@ -56,7 +56,7 @@ ___ ## Let's Start -In this tutorial, we will achieve a basic trigger over the LoRa® network. When we press a button on one of the MKR WAN 1310 boards, an LED will light up on another. This is quite a simple setup, but it can be useful for long range, low power communication! +In this tutorial, we will achieve a basic trigger using the LoRa® technology. When we press a button on one of the MKR WAN 1310 boards, an LED will light up on another. This is quite a simple setup, but it can be useful for long range, low power communication! But let's take a look at what we need to include in the code. As we are using two different boards, we will also need to create two separate sketches. @@ -366,4 +366,8 @@ If the code is not working, there are some common issues we might need to troubl ## Conclusion -This tutorial demonstrates a simple, yet powerful communication setup, featuring two MKR WAN 1310 boards and how to remotely control an LED over the LoRa® network. +This tutorial demonstrates a simple, yet powerful communication setup, featuring two MKR WAN 1310 boards and how to remotely control an LED over the LoRa®-based network. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-message/lora-message.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-message/lora-message.md index 89d1e30e8f..9f1dd7b476 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-message/lora-message.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-message/lora-message.md @@ -1,5 +1,5 @@ --- -title: 'LoRa® Message Service with MKR WAN 1310' +title: 'LoRa®-Based Messaging with MKR WAN 1310' difficulty: advanced compatible-products: [mkr-wan-1310] description: 'Learn how to use the Serial Monitor to send messages between two MKR WAN 1300 boards using LoRa® technology.' @@ -19,7 +19,7 @@ software: - web-editor --- -In this tutorial, we will use two MKR WAN 1310's to set up a simple message service over the LoRa® network. This communication will be achieved through the Serial Monitor, where you can send and receive messages directly. +In this tutorial, we will use two MKR WAN 1310's to set up a simple message service over a LoRa®-based communication channel. This communication will be achieved through the Serial Monitor, where you can send and receive messages directly. We will use the **LoRa** library to for the communication, and we will not use any external services. Additionally, we will also create specific addresses for each board. This will help ensure that the messages that we send and receive are only displayed on the corresponding devices. @@ -49,7 +49,7 @@ ___ ## Let's Start -In this tutorial, we will create a message service that utilizes the LoRa® network. In our other tutorials for the MKR WAN 1310 board, we have typically set up one board as a sender, and one as a receiver. Now, we will instead set them up as **both sender and receiver**. This will allow us to both send and receive packets simultaneously, which works very similar to any messenger service you might be used to! +In this tutorial, we will create a message service that uses a LoRa®-based communication channel. In our other tutorials for the MKR WAN 1310 board, we have typically set up one board as a sender, and one as a receiver. Now, we will instead set them up as **both sender and receiver**. This will allow us to both send and receive packets simultaneously, which works very similar to any messenger service you might be used to! To do this, we basically only need to create one sketch that we will upload to each of the MKR WAN 1310 boards, with only some minor adjustments made in the code for each. @@ -155,7 +155,7 @@ Whenever the `onReceive()` function is called upon, it first checks whether a pa But if a packet comes in, there are two major things that happen. First, we read the packet, using the command `int recipient = LoRa.read();`, which contains the `localAddress` (sent from the other board). We then create a string called `incoming`, which we then store the incoming message in. -We then compare `recipient` to `localAddress` and `0xFF`, and if it doesn't match, we print "This message is not for me" in the Serial Monitor. As there are many people using the LoRa® network, we might intercept other messages, and if we do, that is the message we will see instead. +We then compare `recipient` to `localAddress` and `0xFF`, and if it doesn't match, we print "This message is not for me" in the Serial Monitor. As there are many people using the LoRa®-based network, we might intercept other messages, and if we do, that is the message we will see instead. Finally, we print the message stored in the `incoming` string in the Serial Monitor, along with RSSI. @@ -356,9 +356,9 @@ void loop() { ## Upload Sketch and Testing the Program -Once we are finished with the code, we can upload the sketches to each board. At this point, we will need **two computers**, as we are going to write messages between them. When the code has been uploaded, **open the Serial Monitor on each computer**. +Once we are finished with the code, we can upload the sketches to each board. At this point, we will need **two computers**, as we are going to exchange messages between them. When the code has been uploaded, **open the Serial Monitor on each computer**. -If everything goes right, we should be able to write messages over the LoRa® network. This is done by simply typing a message in the Serial Monitor of either device, and hit "enter" once finished. This will store the entered message in a string called `message`. In the code, we also created a packet and printed `message` to it. This is done automatically after we have hit "enter", and should now be sent to the other device. +If everything goes right, we should be able to write messages over the LoRa®-based network. This is done by simply typing a message in the Serial Monitor of either device, and hit "enter" once finished. This will store the entered message in a string called `message`. In the code, we also created a packet and printed `message` to it. This is done automatically after we have hit "enter", and should now be sent to the other device. >**Important:** the Serial Monitor needs to be open for both devices in order to send and receive messages. If we send a message from **Device #1**, we will need to have the Serial Monitor open on **Device #2**. @@ -390,5 +390,8 @@ If the code is not working, there are some common issues we might need to troubl ## Conclusion -In this tutorial, we have created a messaging over LoRa® application, using two MKR WAN 1310 boards and two antennas. In the right conditions, these boards can send messages over very long distances, and can be an ideal solution for remote places where internet access is limited. +In this tutorial, we have created a LoRa®-based messaging service application, using two MKR WAN 1310 boards and two antennas. In the right conditions, these boards can send messages over very long distances, and can be an ideal solution for remote places where internet access is limited. +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-send-and-receive/lora-send-and-receive.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-send-and-receive/lora-send-and-receive.md index 4cad373b16..2a441545fd 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-send-and-receive/lora-send-and-receive.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-send-and-receive/lora-send-and-receive.md @@ -1,5 +1,5 @@ --- -title: 'Send Data Using LoRa® with MKR WAN 1310' +title: 'Send Data Using LoRa® Technology with MKR WAN 1310' difficulty: intermediate compatible-products: [mkr-wan-1310] description: 'Learn how to setup a continuous stream of data between two devices using LoRa® technology.' @@ -19,7 +19,8 @@ software: - web-editor --- -The Arduino MKR WAN 1310 is an excellent entry point to get started with low-powered, wide-area networks (LPWAN). In this tutorial, we will go through some of the core concepts such as long range (LoRa®) and the LoRaWAN® protocol. +The Arduino MKR WAN 1310 is an excellent entry point to get started with low-powered, wide-area networks (LPWAN). In this tutorial, we will go through some of the core concepts such as LoRa® technology and set up communication using it. + We will create a basic sketch that will allow communication between two **MKR WAN 1310** boards. The communication will be established firstly through the radio module on the board, where we will also attach an antenna to each board. @@ -27,17 +28,13 @@ We will create a basic sketch that will allow communication between two **MKR WA There are many different terms to be familiar with in the world of LoRa® technology, so let's go through some of them! -### LoRa® +### LoRa® Technology -LoRa® is short for long range modulation technique based on a technology called chirp spread spectrum (CSS). It is designed to carry out long-range transmissions with minimal power consumption. LoRa® defines as the "lower layer" or **"physical layer"**, according to the **OSI model**. The physical layer is defined by hardware, signals and frequencies. +LoRa® is short for long range modulation technique based on a technology called chirp spread spectrum (CSS). It is designed to carry out long-range transmissions with minimal power consumption. LoRa serves as the `lower layer` or **`physical layer`**, according to the **OSI model**. The physical layer is defined by hardware, signals and frequencies. LoRa® uses different radio frequencies depending on where you are located in the world. The most common are Europe (868 MHz) and North America & Australia (915 MHz), but it differs from country to country. You can also read more about a [country's unique radio frequency](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country/). -LoRa® is also often used to describe hardware devices supported by LoRa®, e.g. modules or gateways. The Arduino MKR WAN 1310 has a LoRa® module called **Murata CMWX1ZZABZ**. - -### LoRaWAN® - -LoRaWAN® can be defined as the networking protocol used in an Low-Power, Wide-Area networks (LPWAN). The architecture of the network consists of different gateways that relay messages from low-power devices over long ranges, to central network servers. The protocol is defined as the **upper networking layers**. +LoRa® is also often used to describe hardware devices supported by LoRa, e.g. modules or gateways. The Arduino MKR WAN 1310 has a LPWAN module called **Murata CMWX1ZZABZ**. ### The Benefits of LoRa® @@ -59,7 +56,7 @@ ___ - 2x Micro USB cable - Arduino IDE (offline and online versions available) - Arduino SAMD Board Package installed, [follow this link for instructions](https://www.arduino.cc/en/Guide/MKRWiFi1010#installing-drivers-for-the-mkr-wifi-1010) -- LoRa library installed, see the [github repository](https://github.com/sandeepmistry/arduino-LoRa) +- `LoRa` library installed, see the [github repository](https://github.com/sandeepmistry/arduino-LoRa) ### Circuit @@ -314,6 +311,10 @@ If the code is not working, there are some common issues we might need to troubl ## Conclusion -In this tutorial, we have introduced some fundamental concepts around LoRa®, where we have setup a basic communication line between two boards using the LoRa® network. With this basic framework, you can go on to combine this tutorial with sensors and other software libraries, so that you can create your own long-range, low-powered devices! +In this tutorial, we have introduced some fundamental concepts around LoRa® technology, where we have setup a basic communication line between two boards using the LoRa® technology-based communication. With this basic framework, you can go on to combine this tutorial with sensors and other software libraries, so that you can create your own long-range, low-powered devices! + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-sensor-data/lora-sensor-data.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-sensor-data/lora-sensor-data.md index 2bcee187e9..0eef885cbc 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-sensor-data/lora-sensor-data.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lora-sensor-data/lora-sensor-data.md @@ -100,7 +100,7 @@ int counter = 0; In the `setup()` we will begin serial communication, where we will use the command `while(!Serial);` to prevent the program from running until we open the Serial Monitor. -We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for LoRa® communication. If we are located in North America, we need to change this to 915E6. +We will then initialize the **LoRa** library, where we will set the radio frequency to 868E6, which is used in Europe for communication based on LoRa® technology. If we are located in North America, we need to change this to 915E6. As we are using the MKR ENV shield, we also need to initialize the **Arduino_MKRENV** library by using the line `if (!ENV.begin())` followed by an error message in case it failed to initialize. @@ -239,7 +239,10 @@ If the code is not working, there are some common issues we might need to troubl - We have not opened the Serial Monitor. - We are using the same computer for both boards without a serial interfacing program. - ## Conclusion -This tutorial demonstrates a simple, yet powerful communication setup with the MKR WAN 1310 board and a MKR ENV Shield over the LoRa® network. +This tutorial demonstrates a simple, yet powerful communication setup with the MKR WAN 1310 board and a MKR ENV Shield over the LoRa®-based network. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-farming-with-mkr-wan-1310/lorawan-farming-with-mkr-wan-1310.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-farming-with-mkr-wan-1310/lorawan-farming-with-mkr-wan-1310.md index ef8733b213..6808ba8834 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-farming-with-mkr-wan-1310/lorawan-farming-with-mkr-wan-1310.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-farming-with-mkr-wan-1310/lorawan-farming-with-mkr-wan-1310.md @@ -1,5 +1,5 @@ --- -title: "LoRaWAN Farming with MKR WAN 1310" +title: "LoRa® Farming with MKR WAN 1310" description: "Let's collect sensor data with MKR WAN 1300 or 1310 and combine it with weather forecast in order to optimize watering in a wide area!" coverImage: "assets/blob_KruXU85KZx.png" tags: [mkr1300, mkr1310, nodered, ttn] @@ -29,9 +29,9 @@ source: "https://create.arduino.cc/projecthub/145678/lorawan-farming-with-mkr-wa If you need to control a watering system (or lighting system or other generic actuators) in a smart way and collect sensor data over a large area where WiFi coverage is optional, you have to switch to other ways to communicate. -LoRa is maybe the better choice: low power consumption, long range and inexpensive hardware. Last but not least, we can use LoRa under a LoRaWAN network, that means you can place your devices all around the world no matter if you have your own receiver there! +LoRa® technology is an excellent choice due to its low power consumption, long range and cost effective hardware. Most importantly, LoRa devices can operate within public or private networks, allowing flexible deployment anywhere. -In this project we'll use the most known global LoRaWAN network: [The Things Network](https://www.thethingsnetwork.org/). +In this project we'll use the most known global LoRa®-based network: [The Things Network](https://www.thethingsnetwork.org/). We'll then integrate everything with [Node-RED](https://nodered.org/), so it will be easy to plot the received data and create rules to send back commands! @@ -76,11 +76,11 @@ Of course you can reach the same setup using a breadboard and spare components! ### TheThingNetwork Setup -If you have followed our previous guide "MKR WAN 1310 meets TheThingsNetwork!", then you are done. +If you have followed our previous guide `"MKR WAN 1310 meets TheThingsNetwork!"`, then you are done. ### The Arduino MKR 1300 / MKR 1310 Code -Only few things to say about the code (that you'll find below). This is based on the LoraSendAndReceive example available in the MKRWAN library. +Only few things to say about the code (that you'll find below). This is based on the `LoraSendAndReceive` example available in the MKRWAN library. There are 2 additional libraries imported: @@ -110,7 +110,7 @@ It's available for every OS, and well documented. After [installing it](https:// Now you'll have to install additional palettes (kinda plugins) in order to: -- Connect to TTN for grabbing the _uplinks_ from the MKR WAN 1300 and MKR WAN 1310, and for send back the _downlink_ +- Connect to The Things Network (TTN) to retrieve _uplinks_ from the MKR WAN 1300 and MKR WAN 1310 and send back _downlink_ messages. - Create a dashboard for the sensor data visualization - Define a calendar for the watering - Verify the weather forecast for a close rain (in that case watering won't make sense) @@ -344,3 +344,7 @@ You can of course add more Arduino MKR WAN 1300 or MKR WAN 1310 devices in the T ## Complete Sketch + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/assets/mkr-wan-1310_t2_img02.png b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/assets/mkr-wan-1310_t2_img02.png index c8cdfcd388..d25259c38e 100644 Binary files a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/assets/mkr-wan-1310_t2_img02.png and b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/assets/mkr-wan-1310_t2_img02.png differ diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/lorawan-regional-parameters.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/lorawan-regional-parameters.md index 1abc6b47e7..e676e30f13 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/lorawan-regional-parameters.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/lorawan-regional-parameters/lorawan-regional-parameters.md @@ -1,8 +1,8 @@ --- -title: 'LoRaWAN® Regional Parameters in the Arduino® MKRWAN 1310' -description: 'Learn how to set up specific LoRaWAN® regional parameters in the LoRa® module of the Arduino® MKR WAN 1310 board using the Arduino MKRWAN library.' +title: 'LoRa® Regional Parameters in Arduino® MKR WAN 1310' +description: 'Learn how to set up specific LoRa® regional parameters in the LoRa module of the Arduino® MKR WAN 1310 board using the Arduino MKRWAN library.' tags: - - LoRaWAN® + - LoRa®-based Network - Regional parameters - MKR WAN 1310 - MKRWAN @@ -11,13 +11,13 @@ author: 'José Bagur' ## Introduction -In this tutorial, we will learn how to set up specific LoRaWAN® regional parameters for the LoRa® module (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) and [Arduino® MKR WAN 1300](https://store.arduino.cc/arduino-mkr-wan-1300-lora-connectivity-1414) boards. For doing this, we are going to use the [Arduino MKRWAN library](https://github.com/arduino-libraries/MKRWAN) functionalities. +In this tutorial, we will learn how to set up specific LoRa® regional parameters for the LPWAN module (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) and [Arduino® MKR WAN 1300](https://store.arduino.cc/arduino-mkr-wan-1300-lora-connectivity-1414) boards. For doing this, we are going to use the [Arduino MKRWAN library](https://github.com/arduino-libraries/MKRWAN) functionalities. ### Goals -- Learn LoRaWAN® networking protocol basics. -- Learn about the [LoRaWAN® Regional Parameters](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf) specification. -- Use the Arduino [MKRWAN library](https://github.com/arduino-libraries/MKRWAN) for setting up specific LoRaWAN® regional parameters in the LoRa® module (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) board. +- Learn LoRa®-based network protocol basics. +- Learn about the [LoRa® Regional Parameters](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf) specification. +- Use the Arduino [MKRWAN library](https://github.com/arduino-libraries/MKRWAN) for setting up specific LoRa® regional parameters in the LPWAN module with LoRa® technology (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) board. ### Required Hardware and Software @@ -26,38 +26,38 @@ In this tutorial, we will learn how to set up specific LoRaWAN® regional parame - [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) board. - Micro USB cable (x1). -## LoRaWAN® Networking Protocol Overview +## LoRa®-Based Network Protocol Overview -LoRaWAN® is a "Low Power Wide Area (LPWA) end-to-end system architecture designed to wirelessly connect battery operated "things" to the internet in regional, national or global networks. The architecture includes protocol standards and features that support low-cost, mobile, and secure bi-directional communication for Internet of Things (IoT), machine-to-machine (M2M), smart city & industrial applications". LoRaWAN® is optimized for low-power consumption and it is designed to scale from a simple gateway up to a large global network of billions of connected devices. +LoRa®-based network is a "Low Power Wide Area (LPWA) end-to-end system architecture designed to wirelessly connect battery operated "things" to the internet in regional, national or global networks. The architecture includes protocol standards and features that support low-cost, mobile, and secure bi-directional communication for Internet of Things (IoT), machine-to-machine (M2M), smart city & industrial applications". LoRa-based network is optimized for low-power consumption and it is designed to scale from a simple gateway up to a large global network of billions of connected devices. -LoRaWAN® **fundamental characteristics** are the following: +LoRa®-based networks **fundamental characteristics** are the following: * **Long-range**: typically two to 5 km in urban areas (obstacles) and 5 to 15 km in rural areas. * **Long battery duration**: up to 10 years without a replacement (note that long battery duration will require an increased downlink latency configuration). * **Low cost**: regarding sensors and maintenance. -* **License-free spectrum**: LoRaWAN® networks operates on license-free and cost-​free ISM (Industrial, Scientific, Medical) bands; however, **region-specific regulations apply**. +* **License-free spectrum**: LoRa®-based networks operates on license-free and cost-​free ISM (Industrial, Scientific, Medical) bands; however, **region-specific regulations apply**. * **Limited payload**: 51 to 256 bytes (depending on data rate). * **Limited data rate**: 0.3 to 27 Kbps. -The LoRa Alliance® specifies the LoRaWAN® networking protocol in the **LoRaWAN® specification** documents. These documents are developed and maintained by the LoRa® Alliance, an open association of collaborating members. As stated before, though LoRaWAN® operates on **license-free and cost-​free ISM bands**, **manufacturers and operators of LoRaWAN® devices still have to fulfill various country-specific regulations**. +The LoRa®-based network protocol is specified in the **LoRa-based network specification** documents. These documents are developed and maintained by the LoRa standards organization. As stated before, though LoRa-based network operates on **license-free and cost-​free ISM bands**, **manufacturers and operators of LoRa-based network devices still have to fulfill various country-specific regulations**. -## LoRa Alliance® Regional Parameters Overview +## LoRa® Regional Parameters Overview -The **LoRaWAN® Regional Parameters specification** is a companion to the LoRaWAN® Link Layer specification. While the LoRaWAN® Link Layer specification defines the air interface between a compliant end-device (sensor, actuator, tracker, etc.) and a compliant network core, the LoRaWAN® Regional Parameters specification defines the **adaptation of the LoRaWAN® Link Layer specification to comply with the various regulations enforced throughout the world on the use of various frequency bands of the unlicensed spectrum which are available**. +The **LoRa®-based network Regional Parameters specification** is a companion to the LoRa-based network Link Layer specification. While the LoRa-based network Link Layer specification defines the air interface between a compliant end-device (sensor, actuator, tracker, etc.) and a compliant network core, the LoRa Regional Parameters specification defines the **adaptation of the LoRa-based network Link Layer specification to comply with the various regulations enforced throughout the world on the use of various frequency bands of the unlicensed spectrum which are available**. -Also, the LoRaWAN® Regional Parameters specification documents the **physical layer configurations required for the compliant operation of LoRaWAN® Link Layer radios** using various radio frequency modulation techniques. +Also, the LoRa® Regional Parameters specification documents the **physical layer configurations required for the compliant operation of LoRa-based network Link Layer radios** using various radio frequency modulation techniques. -***The idea behind the LoRaWAN® Regional Parameters specification is to create the smallest number of regional channel plans covering the largest possible number of regulatory regions. With this, complexity is decreased to implementers as well as the certification cost (end-device certification is enumerated by Link Layer, Regional Parameters and channel plan revision).*** +***The idea behind the LoRa® Regional Parameters specification is to create the smallest number of regional channel plans covering the largest possible number of regulatory regions. With this, complexity is decreased to implementers as well as the certification cost (end-device certification is enumerated by Link Layer, Regional Parameters and channel plan revision).*** -LoRaWAN® Regional Parameters specifications do not specify everything. They only cover a region by specifying the common denominator. For example, the LoRaWAN® Regional Parameters for Asia only specify a common subset of channels, but there are variations between regulations in Asian countries. Furthermore, each **network server operator**, for example [The Things Network](https://www.thethingsnetwork.org/) (TTN), is free to select additional parameters, such as additional emission channels. +LoRa® Regional Parameters specifications do not specify everything. They only cover a region by specifying the common denominator. For example, the LoRa Regional Parameters for Asia only specify a common subset of channels, but there are variations between regulations in Asian countries. Furthermore, each **network server operator**, for example [The Things Network](https://www.thethingsnetwork.org/) (TTN), is free to select additional parameters, such as additional emission channels. -For more information, you can read the RP002-1.0.2 LoRaWAN® Regional Parameters document [here](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf). +For more information, you can read the RP002-1.0.2 LoRa® Regional Parameters document [here](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf). ## Regional Parameters Configuration Example: Australia -Let's use **Australia** (AU915-928) as an example of how we can set up, or configure, it's specific LoRaWAN® regional parameters in the LoRa® module of our MKR WAN 1310 board and connect it to TTN. TTN also have specific LoRaWAN® protocol characteristics for every region, including Australia, that must be configured. You can read more about The Things Network and the LoRaWAN® Regional Parameters [here](https://www.thethingsnetwork.org/docs/lorawan/regional-parameters/). +Let's use **Australia** (AU915-928) as an example of how we can set up, or configure, it's specific LoRa® regional parameters in the LoRa module of our MKR WAN 1310 board and connect it to TTN. TTN also have specific LoRa-based network protocol characteristics for every region, including Australia, that must be configured. You can read more about The Things Network and the LoRa Regional Parameters [here](https://www.thethingsnetwork.org/docs/lorawan/regional-parameters/). -As stated in [section 2.8](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf) of the LoRaWAN® Regional Parameters specification, in Australia the LoRaWAN® frequency spectrum has **64 uplink channels** available, channels 0 to 63 (125 kHz each), starting at 915.2 MHz which increment every 200 kHz up to 927.8 MHz. There are also **8 additional uplink channels**, channels 64 to 71 (500 kHz each), starting at 915.9 MHz which increment every 1.6 MHz up to 927.1 MHz. The frequency spectrum for those is overlapping with the basic 64 channels. For **gateway to end-node device communication** there are **8 downlink channels**, channels 0 to 7 (500 KHz each), starting at 923.3 MHz which increment every 600 KHz up to 927.5 MHz. This information is shown in the table below: +As stated in [section 2.8](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf) of the LoRa® Regional Parameters specification, in Australia the LoRa-based network frequency spectrum has **64 uplink channels** available, channels 0 to 63 (125 kHz each), starting at 915.2 MHz which increment every 200 kHz up to 927.8 MHz. There are also **8 additional uplink channels**, channels 64 to 71 (500 kHz each), starting at 915.9 MHz which increment every 1.6 MHz up to 927.1 MHz. The frequency spectrum for those is overlapping with the basic 64 channels. For **gateway to end-node device communication** there are **8 downlink channels**, channels 0 to 7 (500 KHz each), starting at 923.3 MHz which increment every 600 KHz up to 927.5 MHz. This information is shown in the table below: | **Frequency Bands** | **Frequency Range (MHz)** | **Channels** | |:------------------:|:---------------------:|:--------:| @@ -89,7 +89,7 @@ Before we can use the MKRWAN library a firmware update of the LoRa® module of o ![Updating the firmware of the MKR WAN 1310 LoRa® module.](assets/mkr-wan-1310_t2_img01.png) -For **enabling** or **disabling**, or masking, specific LoRaWAN® frequency spectrum channels in our MKR WAN 1310 board we can use the `enableChannel()` and `disableChannel()` functions from the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN). Channel masking should be made in the initialization function like in the example code shown below: +For **enabling** or **disabling**, or masking, specific LoRa®-based network frequency spectrum channels in our MKR WAN 1310 board we can use the `enableChannel()` and `disableChannel()` functions from the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN). Channel masking should be made in the initialization function like in the example code shown below: ```arduino #include @@ -124,7 +124,7 @@ void setup() { Serial.println(modem.getChannelMask()); // Enable AU915-928 channels - // LoRaWAN® Regional Parameters and TTN specification: channels 8 to 15 plus 65 + // LoRa®-based network Regional Parameters and TTN specification: channels 8 to 15 plus 65 Serial.println("- Enabling channels 8 to 15 plus 65..."); for (unsigned int i = 8; i <= 15; i++) { modem.enableChannel(i); @@ -185,7 +185,7 @@ void setup() { Serial.println(modem.deviceEUI()); // Enable AU915-928 channels - // LoRaWAN® Regional Parameters and TTN specification: channels 8 to 15 plus 65 + // LoRa®-based network Regional Parameters and TTN specification: channels 8 to 15 plus 65 modem.sendMask("ff000001f000ffff00020000"); Serial.println(modem.getChannelMask()); modem.setADR(true); @@ -204,8 +204,12 @@ void join() { void loop(){} ``` -That's it! Now you should be able to configure your own LoRaWAN® Regional Parameters using the `enableChannel()`, `disableChannel()` and `sendMask()` functions. +That's it! Now you should be able to configure your own LoRa® Regional Parameters using the `enableChannel()`, `disableChannel()` and `sendMask()` functions. ## Conclusion -In this tutorial we learned how to set up specific LoRaWAN® Regional Parameters for the LoRa® module (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) board using the `enableChannel()`, `disableChannel()` and `sendMask()` functions from the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN). +In this tutorial we learned how to set up specific LoRa® Regional Parameters for the LPWAN module (Murata CMWX1ZZABZ-078) of the [Arduino® MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) board using the `enableChannel()`, `disableChannel()` and `sendMask()` functions from the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/the-things-network/the-things-network.md b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/the-things-network/the-things-network.md index e35f57c7a0..00fe715bfa 100644 --- a/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/the-things-network/the-things-network.md +++ b/content/hardware/01.mkr/01.boards/mkr-wan-1310/tutorials/the-things-network/the-things-network.md @@ -24,9 +24,9 @@ software: In this tutorial, we will go through how to set up the MKR WAN 1310 board to work with The Things Network (TTN). -It is a good idea to already look at the limitations of using LoRa®. As with any technology, there advantages and disadvantages, and with LoRa®, there's also some limitations of how much data we can send. You can read more about this through the link below: +It is a good idea to already look at the limitations of using LoRa® technology. As with any technology, there are advantages and disadvantages, and with LoRa, there's also some limitations of how much data we can send. You can read more about this through the link below: -- [Limitations of LoRaWAN®](https://www.thethingsnetwork.org/docs/lorawan/limitations/) +- [Limitations of LoRa®-based networks](https://www.thethingsnetwork.org/docs/lorawan/limitations/) ## Goals @@ -48,14 +48,14 @@ The goals of this project are: - 1x micro USB cable. -## LoRaWAN® +## LoRa®-Based Network -LoRaWAN®, stands for **Long Range Wide Area Network**, which is becoming increasingly popular in the Internet of Things-sphere, due to its capability of sending data over larger distances using minimal battery power and ensuring that data and credentials remain secure. There are also other acronyms that are associated with LoRaWAN® such as: +LoRa®-based networks are becoming increasingly popular in the Internet of Things-sphere, due to its capability of sending data over larger distances using minimal battery power and ensuring that data and credentials remain secure. There are also other acronyms that are associated with LoRa-based network such as: -- LoRa® which stands for Long Range +- LoRa® technology which stands for Long Range - LP WAN which stands for Low Power Wide Area Network -LoRa® devices come with lower data rates, with longer intervals than i.e. a device connected through WiFi. This is due to the low-power consumption and long range that LoRa® technology puts emphasis on. +LoRa® devices come with lower data rates, with longer intervals than i.e. a device connected through WiFi. This is due to the low-power consumption and long range that LoRa technology puts emphasis on. While the data rate may be a restriction, let’s have a look at some of the amazing features LoRa® technology comes with: @@ -65,7 +65,7 @@ While the data rate may be a restriction, let’s have a look at some of the ama - **Security:** The MKR WAN 1310 board comes with the crypto chip (ECC-508), which allows us to store data and credentials securely. -In this tutorial, we will be covering the basics of setting up a MKRWAN series device to connect to the LoRa® network, through something called The Things Network (TTN). We can start by looking at [this map](https://www.thethingsnetwork.org/map) to see if we are within reach of a gateway. +In this tutorial, we will be covering the basics of setting up a MKRWAN series device to connect to the LoRa®-based network, through something called The Things Network (TTN). We can start by looking at [this map](https://www.thethingsnetwork.org/map) to see if we are within reach of a gateway. ### Circuit @@ -114,7 +114,7 @@ fill in **End device ID** and **DevEUI**. You can click the generate button next **Note**: The Frequency Plan used in Australia by **The Things Network** is **"Australia 915-928 MHz, FSB 2 (used by TTN)"**. The other plans are included in -the list for LoRaWAN deployments using other LoRaWAN radio networks. +the list for LoRa®-based network deployments using other compatible radio networks. ![Second step of registering device](assets/WAN1310_T6_IMG06_02.png) @@ -126,7 +126,7 @@ In our device overview, we can now see three rows: Device EUI, Application EUI a **Note**: For devices using the **AU_915_928** band plan, an additional configuration step is required. In settings for the end device, under -**General Settings**, expand the **Network Layer** options and change **Regional Parameters version** to **"RP001 Regional Parameters 1.0.2 revision B"**. Click **Save changes** to commit the new setting. Without this change, the device will be unable to complete it's registration to the TTN LoRaWAN network and will not be able to transmit data. +**General Settings**, expand the **Network Layer** options and change **Regional Parameters version** to **"RP001 Regional Parameters 1.0.2 revision B"**. Click **Save changes** to commit the new setting. Without this change, the device will be unable to complete it's registration to the TTN's LoRa®-based network and will not be able to transmit data. Now, we need to open the **FirstConfiguration** sketch again. To be safe, reset your board and open the Serial Monitor again. Once the program starts, it will start asking questions in the Serial Monitor. The first one is if we are using OTAA or ABP. We will use OTAA, so we can enter a **"1"** in the monitor and hit **"send"**. @@ -192,4 +192,8 @@ This will decode the incoming message and add the text "payload: yourmessage" at In this tutorial, we have looked at how to connect our MKR WAN 1310 board to the The Things Network (TTN). We have retrieved the device EUI, used it to register the device in the TTN console, and programmed the board using the data provided by TTN. -As long as we are in range of a TTN gateway, we can now send data over the LoRa® network which can be viewed from anywhere in the world (as long as we have an Internet connection). +As long as we are in range of a TTN gateway, we can now send data over the LoRa®-based network which can be viewed from anywhere in the world (as long as we have an Internet connection). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md b/content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md index af076b9497..7b11065bd9 100644 --- a/content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md +++ b/content/hardware/04.pro/boards/portenta-x8/tutorials/01.user-manual/content.md @@ -934,7 +934,7 @@ Build Arduino sketches for real-time tasks like sensor communication and Fieldbu For example, the [Data Exchange Between Python® on Linux and an Arduino Sketch](https://docs.arduino.cc/tutorials/portenta-x8/python-arduino-data-exchange) tutorial will help you understand how to exchange sensor data between the Python® container embedded on Portenta X8 and an Arduino sketch. -If you are a more advanced user, you can check [Multi-Protocol Gateway With Portenta X8 & Max Carrier](https://docs.arduino.cc/tutorials/portenta-x8/multi-protocol-gateway) tutorial on developing your multi-protocol gateway. It aims to receive data from a sensor with the Arduino layer via MQTT protocol, take advantage of RPC to establish communication between Arduino and Linux, and then send the acquired data to *The Things Network* via *LoRaWAN®* managed by the Linux layer. +If you are a more advanced user, you can check [Multi-Protocol Gateway With Portenta X8 & Max Carrier](https://docs.arduino.cc/tutorials/portenta-x8/multi-protocol-gateway) tutorial on developing your multi-protocol gateway. It aims to receive data from a sensor with the Arduino layer via MQTT protocol, take advantage of RPC to establish communication between Arduino and Linux, and then send the acquired data to *The Things Network* via *LoRa®-based network* managed by the Linux layer. ## Working With Portenta X8 Board Manager @@ -1366,3 +1366,7 @@ Join our community forum to connect with other Portenta X8 users, share your exp Please get in touch with our support team if you need personalized assistance or have questions not covered by the help and support resources described before. We're happy to help you with any issues or inquiries about the Portenta X8. - [Contact us page](https://www.arduino.cc/en/contact-us/) + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch-general.png b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch-general.png index f867695213..0ced1f316a 100644 Binary files a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch-general.png and b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch-general.png differ diff --git a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch.png b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch.png index cc01880eed..df04c7276d 100644 Binary files a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch.png and b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/assets/multi-protocol-arch.png differ diff --git a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/content.md b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/content.md index 043aadf452..d8190262d6 100644 --- a/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/content.md +++ b/content/hardware/04.pro/boards/portenta-x8/tutorials/12.multi-protocol-gateway/content.md @@ -19,9 +19,9 @@ hardware: ## Overview -Portenta X8 has the NXP® i.MX 8M Mini MPU (Linux) and STM32H747XI dual Cortex®-M7+M4 32bit low power ARM® MCU (Arduino) stacked together and can be used to design different workloads for these two different microprocessors. We will use the Portenta Max Carriers onboard CMWX1ZZABZ-078 LoRaWAN® module from Murata® and the Wi-Fi® connectivity from Portenta X8 to build a Multi-Protocol Gateway. +Portenta X8 has the NXP® i.MX 8M Mini MPU (Linux) and STM32H747XI dual Cortex®-M7+M4 32bit low power ARM® MCU (Arduino) stacked together and can be used to design different workloads for these two different microprocessors. We will use the Portenta Max Carrier's onboard CMWX1ZZABZ-078 LPWAN module from Murata® and the Wi-Fi® connectivity from Portenta X8 to build a Multi-Protocol Gateway. -In this tutorial, we will go through the steps on how to set up both the Linux and Arduino sides. A device collecting sensor data will transfer the data via Wi-Fi®, receive the data, and exchange them between the Arduino and Linux layers, finally using LoRaWAN® to send the information to *The Things Network*. We will also configure and expose a local communication lane to further expand its capability if a local sensor is desired. +In this tutorial, we will go through the steps on how to set up both the Linux and Arduino sides. A device collecting sensor data will transfer the data via Wi-Fi®, receive the data and exchange them between the Arduino and Linux layers, finally using LoRa® technology to send the information to *The Things Network*. We will also configure and expose a local communication lane to further expand its capability if a local sensor is desired. ## Goals @@ -52,7 +52,7 @@ The Portenta X8 paired with the Portenta Max Carrier has the potential to create - Wi-Fi® (MQTT Protocol, API calls, custom protocols) - Bluetooth® Low Energy -- LoRaWAN® (*The Things Network*) +- LoRa®-based networks (*The Things Network*) - NB-IoT & Cat-M1 The following image illustrates an architecture overview of a multi-protocol gateway composed of Portenta X8 and Max Carrier as the gateway system. @@ -78,9 +78,9 @@ The Arduino layer extends within the M4 Core, which is the layer dedicated to re ## The Linux Layer -It is important to understand that **all networking processes are made within the Linux layer**. All network processes are Wi-Fi®, Bluetooth® Low Energy, LoRa®, NB-IoT, and Cat. M1. We will focus on using Wi-Fi® with MQTT protocol and LoRa® connectivities to establish a multiple protocol gateway. +It is important to understand that **all networking processes are made within the Linux layer**. All network processes are Wi-Fi®, Bluetooth® Low Energy, LoRa® technology, NB-IoT, and Cat. M1. We will focus on using Wi-Fi® with MQTT protocol and LoRa connectivities to establish a multiple protocol gateway. -The Portenta X8 provides Wi-Fi® connectivity and the Portenta Max Carrier provides a LoRaWAN® module that can help to communicate with *The Things Network*. We will use the MQTT protocol to receive sensor data transmitted by an end device. +The Portenta X8 provides Wi-Fi® connectivity and the Portenta Max Carrier provides a LoRa®-based network module that can help to communicate with *The Things Network*. We will use the MQTT protocol to receive sensor data transmitted by an end device. We will use a Python® script to configure and handle the connectivity modules and their sensor data. The RPC calls will expose the received sensor data to the Arduino layer, setting up data exchange configuration to expand the capability of the Portenta X8 and Max Carrier. The process can also be done vice-versa, using the Arduino layer to transmit the data to the Linux layer from the local end device. @@ -92,7 +92,7 @@ Now that we know the roles of Arduino and Linux layer, we will need a clear pict To showcase the ability of the Linux layer and Arduino layer extended by M4 Core, we will build a multi-protocol gateway that will receive MQTT protocol packages using EMQX as the broker, retrieve the data from a local sensor attached to Portenta via RPC mechanism, wrap the data together and send to *The Things Network* using LoRa® connectivity within Cayenne Low Power Payload Encoder. -The Cayenne Low Power Payload Encoder is one of the payload formatters for data exchange between end devices and has compatibility support for Arduino boards. The encoder has the capability to decode CayenneLPP payload formats without additional custom code, and it helps simplify data transmission over LPWAN networks as LoRaWAN®. +The Cayenne Low Power Payload Encoder is one of the payload formatters for data exchange between end devices and has compatibility support for Arduino boards. The encoder has the capability to decode CayenneLPP payload formats without additional custom code and it helps simplify data transmission over LPWAN networks. ***You can find more information regarding Cayenne Low Power Payload Encoder by following [here](https://www.thethingsindustries.com/docs/integrations/payload-formatters/cayenne/)*** @@ -149,13 +149,13 @@ nmcli device wifi connect "SSID" password "PASSWORD" ### Setting Up The Things Network -You now have the prerequisites for the Portenta X8 ready, but since you are using the LoRa® connectivity, you will need a platform capable of receiving data transmitted from the Portenta X8 and Max Carrier. **The Things Network** will be the platform we will use to communicate using LoRaWAN®. On the platform, you will need to create an application to add the Portenta Max Carrier as an End-Device. +You now have the prerequisites for the Portenta X8 ready, but since you are using the LoRa® connectivity, you will need a platform capable of receiving data transmitted from the Portenta X8 and Max Carrier. **The Things Network** will be the platform we will use to communicate using LoRa technology. On the platform, you will need to create an application to add the Portenta Max Carrier as an End-Device. -**Manual** option will be used when adding the End-Device. The Portenta Max Carrier will be added under Arduino SA to be included within the LoRaWAN® Device Repository. The LoRaWAN® version and parameters compatible with the Portenta Max Carrier are as follows. The frequency plan will depend on the region in which you are going to install the device. +**Manual** option will be used when adding the End-Device. The Portenta Max Carrier will be added under Arduino SA to be included within the LoRa®-enabled Device Repository. The LoRa-based network version and parameters compatible with the Portenta Max Carrier are as follows. The frequency plan will depend on the region in which you are going to install the device. ![General End-Device Configuration](assets/ttn-end-device.png) -***To learn more about LoRa® and LoRaWAN®, please have a look at our [Arduino Guide to LoRa® and LoRaWAN®](https://docs.arduino.cc/learn/communication/lorawan-101). Additionally, if you wish to learn how to properly set up the End-Device in The Things Network, please read [this tutorial](https://docs.arduino.cc/tutorials/mkr-wan-1310/the-things-network) reference*** +***To learn more about LoRa® and its networks, please have a look in [this documentation](https://docs.arduino.cc/learn/communication/lorawan-101). Additionally, if you wish to learn how to properly set up the End-Device in The Things Network, please read [this tutorial](https://docs.arduino.cc/tutorials/mkr-wan-1310/the-things-network) reference*** We will now build a multi-protocol gateway using Portenta X8 and Max Carrier. @@ -258,7 +258,7 @@ mqtt_username = 'emqx' mqtt_password = 'public' ``` -These 2 parameters are required to establish a connection with *The Things Network*. The `APP_EUI` and `APP_KEY` are required to be configured, as they are provided by *The Things Network* or from the LoRaWAN® platform that you may try to establish the connection. Additionally the `DEV_EUI` will be predefined as the device will request and apply the EUI. However, if it requires different `DEV_EUI`, you can make the change in this section. +These 2 parameters are required to establish a connection with *The Things Network*. The `APP_EUI` and `APP_KEY` are required to be configured, as they are provided by *The Things Network* or from the LoRa®-based network platform that you may try to establish the connection. Additionally the `DEV_EUI` will be predefined as the device will request and apply the EUI. However, if it requires different `DEV_EUI`, you can make the change in this section. ```python # Obtained during the first registration of the device @@ -552,11 +552,11 @@ If you are curious about what to expect from the build you have made in this tut ## Conclusion -In this tutorial, you have learned how to set up a Multi-Protocol Gateway composed of MQTT protocol, RPC, and LoRaWAN®, by using the Portenta X8 and the Portenta Max Carrier. You have built the gateway that will connect to *The Things Network* to send the desired data. Also, the gateway is capable of exchanging data between Arduino and Linux layers using RPC, in which you have exposed the ports to be able to receive data from the local sensor to be sent directly to *The Things Network*. +In this tutorial, you have learned how to set up a Multi-Protocol Gateway composed of MQTT protocol, RPC and LoRa® technology, by using the Portenta X8 and the Portenta Max Carrier. You have built the gateway that will connect to *The Things Network* to send the desired data. Also, the gateway is capable of exchanging data between Arduino and Linux layers using RPC, in which you have exposed the ports to be able to receive data from the local sensor to be sent directly to *The Things Network*. ### Next Steps -- Now that you have developed a multi-protocol gateway, using Wi-Fi® and LoRaWAN® connectivity, expand the gateway's capability by adding other connectivity types such as Cat. M1 and NB-IoT. +- Now that you have developed a multi-protocol gateway, using Wi-Fi® and LoRa® connectivity, expand the gateway's capability by adding other connectivity types such as Cat. M1 and NB-IoT. - Expand functionalities for data processing using RPC while using multi-protocol architecture. ## Troubleshooting @@ -568,3 +568,7 @@ You might encounter some errors or misbehaviors while working on the code, preve * If you encounter an issue regarding terminal input inconvenience, please enter `export TERM=xterm` as the command in the terminal to get readable inputs. * In case an internal Wi-Fi® connection cannot be established through the command input due to "unavailable" SSID, although it is in range. Please try using a different SSID if available or a hotspot from a different device to host network connectivity. * If you encounter a docker image conflict when running after building, please make sure you have used a name tag that matches the one from the `docker-compose.yml` file. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/assets/mc_ard_conn_module.png b/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/assets/mc_ard_conn_module.png index fb2a78adc9..c05ae778ba 100644 Binary files a/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/assets/mc_ard_conn_module.png and b/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/assets/mc_ard_conn_module.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/content.md index 1d95d57b7d..d574fc4da7 100644 --- a/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/content.md +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/_unlisted/getting-started/content.md @@ -68,7 +68,7 @@ The following image shows the Portenta Max Carrier's power inputs: ![Portenta Max Carrier Power Inputs](assets/mc_ard_power.png) -These power feed line options power up different peripherals and modules depending on the line configuration. The Portenta H7 powered by USB-C® cable attached to Portenta Max Carrier enables Audio, LoRa®, USB Hub, SD port, and Fieldbus. The Debugger is also enabled, and it is also possible to upload the code at the same time. This power line use case will be useful to develop and debug the code. +These power feed line options power up different peripherals and modules depending on the line configuration. The Portenta H7 powered by USB-C® cable attached to Portenta Max Carrier enables Audio, LoRa® connectivity, USB Hub, SD port and Fieldbus. The Debugger is also enabled, and it is also possible to upload the code at the same time. This power line use case will be useful to develop and debug the code. **If the Arduino IDE throws an error failing to upload the code, please set the Portenta H7 in Bootloader Mode before uploading.** @@ -133,19 +133,21 @@ The Portenta Max Carrier equips two different memory units onboard: Flash Memory #### 1.4. Wireless Connectivity -The Portenta Max Carrier has on-board Murata CMWX1ZZABZ-078 LoRaWAN® Module and SARA-R412M-02B Cell Modem shown in the following image below: +The Portenta Max Carrier has on-board Murata CMWX1ZZABZ-078 LPWAN Module and SARA-R412M-02B Cell Modem shown in the following image below: ![Portenta Max Carrier Connectivity Module](assets/mc_ard_conn_module.png) -#### LoRaWAN® Module - Murata CMWX1ZZABZ-078 +#### Murata CMWX1ZZABZ-078 LPWAN Module -One of the notable features of Portenta Max Carrier is the Murata [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078) that enables LoRaWAN® connectivity. LoRaWAN® is a Low Power Wide Area Network (LPWAN) designed to connect low-power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. +One of the notable features of Portenta Max Carrier is the Murata [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078), which provides LoRa® technology connectivity. LoRa-based network is a type of Low Power Wide Area Network (LPWAN) designed to connect low-power devices to the Internet. + +It was developed to address the specific needs of Internet of Things (IoT) devices, including low power consumption and efficient data transmission over long distances. Depending on the region, it will require to use an appropriate antenna for the respective frequencies. The common frequencies are 915 MHz for North America and Australia, and 863 MHz for European region. Frequencies are on a range, so for example, Australian region is possible to use a 928 MHz compatible antenna and configuration. -***For more in-depth information about LoRa® and LoRaWAN®, please read [The Arduino Guide to LoRa® and LoRaWAN®](https://docs.arduino.cc/learn/communication/lorawan-101).*** +***For more in-depth information about LoRa® and its networks, please refer to this [documentation](https://docs.arduino.cc/learn/communication/lorawan-101).*** -For the LoRa® Connection tutorial with in-depth details on how to power up the module and establish a connection to The Things Network (TTN), please go [here](https://docs.arduino.cc/tutorials/portenta-max-carrier/connecting-to-ttn) for more information. +For the LoRa® connection tutorial with in-depth details on how to power up the module and establish a connection to The Things Network (TTN), please go [here](https://docs.arduino.cc/tutorials/portenta-max-carrier/connecting-to-ttn) for more information. #### Cell Modem - SARA-R412M-02B @@ -161,7 +163,7 @@ We will use the `arduino_secrets.h` header file for the PIN and APN configuratio If you want to learn how to run a sketch with this library or how to switch between Cat M1 and NB IoT, please take a look at our [Portenta Max Carrier and Portenta H7 Cat M1/NB IoT tutorial](https://docs.arduino.cc/tutorials/portenta-max-carrier/catm1-and-nbiot) -The antenna connectors for both LoRaWAN® and cellular modem with the microSIM slot are indicated in the following image: +The antenna connectors for both LoRa® connectivity and cellular modem with the microSIM slot are indicated in the following image: ![Portenta Max Carrier Antenna Connectors and microSIM Slot](assets/mc_ard_antenna_sma.png) @@ -197,7 +199,7 @@ The following image indicates the connectors that enable and allows to establish ### 2. Basic Setup of the Portenta Max Carrier -The Portenta Max Carrier only requires the Portenta H7 as the main unit to be able to use it. External components are required to enable the onboard module's capability and correct operation, such as cellular modem and LoRaWAN® connectivity. As the Portenta H7 is the central control unit of the Portenta Max Carrier, it will need to have the latest **Arduino Mbed OS Portenta Core** installed. +The Portenta Max Carrier only requires the Portenta H7 as the main unit to be able to use it. External components are required to enable the onboard module's capability and correct operation, such as cellular modem and LoRa® connectivity. As the Portenta H7 is the central control unit of the Portenta Max Carrier, it will need to have the latest **Arduino Mbed OS Portenta Core** installed. If it is not installed or requires an update, it is possible to navigate under **Tools > Board > Board Manager** and search for the `Arduino Mbed OS Portenta Core` and proceed with the update. @@ -345,3 +347,7 @@ One may encounter issues setting up and initializing for the first time the Port - When sketch upload fails, please check if the Portenta H7 attached to Portenta Max Carrier is in bootloader mode. Double-press the RESET button and the Green LED will be waving, indicating it has entered bootloader mode. Please retry uploading the sketch afterward. - Verify that the BOOT DIP switch of the Portenta Max Carrier has been configured to an address. Otherwise, the paired Portenta H7 will go into bootloader mode after power-on and it will not initialize the program. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md index 2140fe1110..f4ad522a4f 100644 --- a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md @@ -83,31 +83,31 @@ The Portenta Max Carrier provides the user with almost limitless possibilities t ### Board Topology ![Board topology](assets/maxCarrierDesignators.png) -| **Ref.** | **Description** | **Ref.** | **Description** | -| -------- | ------------------------------------------------------ | -------------- | --------------------------------------------------------- | -| U1 | SARA-R412M-02B 4G LTE/Cat-M1/NB-IoT Modem IC | U2 | CS42L52-CNZ Stereo Codec IC | -| U3 | USB2514Bi/M2 4-port USB 2.0 Hub IC | U4 | SP335EER1-L RS232/RS485/RS422 Transceiver IC | -| U5 | TJA1049 CAN Transceiver IC | U6 | MPM3550EGLE Non-isolated DC-DC IC | -| U7 | NCP383 Current Limiting IC | U8,U20,U21,U22 | SN74LVC1T45 Bi-directional logic level converter IC | -| U9 | DSC6111HI2B 12MHz MEMS Oscillator IC | U10 | SN74LVC1G125 Single Bus Buffer Gate IC | -| U11 | BQ24195RGET 4.5A Single Cell Charger IC | U12 | AP7311 1.8V 150mA LDO Linear Regulator IC | -| U13 | TPS54620 6A Buck Regulator IC | U14 | AP2112K-3.3TRG1 3.3V 600mA LDO Regulator IC | -| U15 | STM32F405RG 168MHz 32 bit Arm® Cortex®-M4 MCU IC | U16-U19 | 74LVC1G157 Single 2-input multiplexer IC | -| U23 | CMWX1ZZABZ-078 Murrata LoRa® module | U24, U25 | LM73100 Ideal Diode with Reverse Polarity Protection | -| J1, J2 | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | J3 | Right-Angle SMA Connector for Modem | -| J4 | 2-1734248-0 FPC Connector | J5 | FW-20-05-G-D-254-150 Signal Break | -| J6 | 615006138421 RS232/RS485 Connector | J7 | 615006138421 CAN Connector | -| J8 | 1759546-1 Mini PCIe Connector | J9 | Right-Angle SMA Connector for LoRa® | -| J10 | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | J11 | 114-00841-68 Micro SD Connector | -| J12 | SJ-3524-SMT-TR 3.5mm Headphone Out | J13 | SJ-3524-SMT-TR 3.5mm Line In Right | -| J14 | SJ-3524-SMT-TR 3.5mm Line In Left | J15 | 61400826021 2-port USB 2.0 Female Connector | -| J16 | 254TR Positive Li-ion Terminal | J17 | TRJK7003A97NL Gigabit Ethernet Connector | -| J18 | 254TR Negative Li-ion Terminal | | | -| J20 | 110990030 Connector for Speaker | X1 | PJ-102A 5.5mm Power Jack Adapter | -| CN1 | FTSH-105-01-F-DV 10-pin JTAG Header | CN2 | Debug Header | -| CN3 | LoRa® Debug Header | SIM1 | 2199337-5 microSIM Card Holder (for on-board modem) | -| SW1 | 218-2LPST Boot Select Switch | SW2 | 218-2LPST Switch *(2)* | -| PB1 | PTS820J25KSMTRLFS Power On Button | PB2 | PTS820J25KSMTRLFS Reset Button | +| **Ref.** | **Description** | **Ref.** | **Description** | +|----------|--------------------------------------------------------|----------------|------------------------------------------------------| +| U1 | SARA-R412M-02B 4G LTE/Cat-M1/NB-IoT Modem IC | U2 | CS42L52-CNZ Stereo Codec IC | +| U3 | USB2514Bi/M2 4-port USB 2.0 Hub IC | U4 | SP335EER1-L RS232/RS485/RS422 Transceiver IC | +| U5 | TJA1049 CAN Transceiver IC | U6 | MPM3550EGLE Non-isolated DC-DC IC | +| U7 | NCP383 Current Limiting IC | U8,U20,U21,U22 | SN74LVC1T45 Bi-directional logic level converter IC | +| U9 | DSC6111HI2B 12MHz MEMS Oscillator IC | U10 | SN74LVC1G125 Single Bus Buffer Gate IC | +| U11 | BQ24195RGET 4.5A Single Cell Charger IC | U12 | AP7311 1.8V 150mA LDO Linear Regulator IC | +| U13 | TPS54620 6A Buck Regulator IC | U14 | AP2112K-3.3TRG1 3.3V 600mA LDO Regulator IC | +| U15 | STM32F405RG 168MHz 32 bit Arm® Cortex®-M4 MCU IC | U16-U19 | 74LVC1G157 Single 2-input multiplexer IC | +| U23 | CMWX1ZZABZ-078 Murata LoRa® module | U24, U25 | LM73100 Ideal Diode with Reverse Polarity Protection | +| J1, J2 | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | J3 | Right-Angle SMA Connector for Modem | +| J4 | 2-1734248-0 FPC Connector | J5 | FW-20-05-G-D-254-150 Signal Break | +| J6 | 615006138421 RS232/RS485 Connector | J7 | 615006138421 CAN Connector | +| J8 | 1759546-1 Mini PCIe Connector | J9 | Right-Angle SMA Connector for LoRa® | +| J10 | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | J11 | 114-00841-68 Micro SD Connector | +| J12 | SJ-3524-SMT-TR 3.5mm Headphone Out | J13 | SJ-3524-SMT-TR 3.5mm Line In Right | +| J14 | SJ-3524-SMT-TR 3.5mm Line In Left | J15 | 61400826021 2-port USB 2.0 Female Connector | +| J16 | 254TR Positive Li-ion Terminal | J17 | TRJK7003A97NL Gigabit Ethernet Connector | +| J18 | 254TR Negative Li-ion Terminal | | | +| J20 | 110990030 Connector for Speaker | X1 | PJ-102A 5.5mm Power Jack Adapter | +| CN1 | FTSH-105-01-F-DV 10-pin JTAG Header | CN2 | Debug Header | +| CN3 | LoRa® Debug Header | SIM1 | 2199337-5 microSIM Card Holder (for on-board modem) | +| SW1 | 218-2LPST Boot Select Switch | SW2 | 218-2LPST Switch *(2)* | +| PB1 | PTS820J25KSMTRLFS Power On Button | PB2 | PTS820J25KSMTRLFS Reset Button | ### Debugger Debugging capabilities are integrated directly into the Portenta Max Carrier and are accessible via microUSB (J10). The J-link debugger is compatible with the Segger® J-Link OB and Blackmagic probes, driven by the STM32F405RGT6 controller (U15). In addition to providing access to the Portenta board JTAG ports, different sniffer channels for I2C, CAN and UART lines. The debugger firmware can be updated via SWD on CN3. Additionally, headers for debugging the LoRa® are accessible via CN2 with SWD. @@ -498,8 +498,10 @@ Hereby, Arduino S.r.l. declares that this product is in compliance with essentia | Arduino Max Carrier Docs | https://docs.arduino.cc/hardware/portenta-max-carrier | ## Revision History -| Date | **Revision** | **Changes** | -|------------|--------------|--------------------------------------| -| 03/09/2024 | 3 | Cloud Editor updated from Web Editor | -| 11/20/2023 | 2 | Recommended antennas added | -| 10/05/2022 | 1 | First Release | +| Date | **Revision** | **Changes** | +|------------|--------------|-------------------------------------------| +| 28/02/2025 | 3 | General information and trademark revision | + +| 03/09/2024 | 3 | Cloud Editor updated from Web Editor | +| 11/20/2023 | 2 | Recommended antennas added | +| 10/05/2022 | 1 | First Release | diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png index d9694f1347..dd745fb3e9 100644 Binary files a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md index c3c3966b86..ea26436282 100644 --- a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md @@ -1,10 +1,10 @@ --- title: Connecting the Portenta Max Carrier to The Things Network -description: This tutorial explains how to connect your Portenta Max Carrier to the Things Network(TTN) using its onboard LoRaWAN® module. +description: This tutorial explains how to connect your Portenta Max Carrier to the Things Network(TTN) using its onboard LPWAN module. difficulty: intermediate tags: - IoT - - LoRaWAN® + - LoRa® author: Taddy Chung, José Bagur libraries: - name: MKRWAN @@ -18,14 +18,13 @@ software: ## Overview -This tutorial explains how to connect your [Arduino® Max Carrier](http://store.arduino.cc/portenta-max-carrier), with an [Arduino® Portenta H7](https://store.arduino.cc/products/portenta-h7) to The Things Network (TTN) using its onboard LoRaWAN® module. The article will focus on achieving communication between the Max Carrier and an application on TTN. +This tutorial explains how to connect your [Arduino® Max Carrier](http://store.arduino.cc/portenta-max-carrier), with an [Arduino® Portenta H7](https://store.arduino.cc/products/portenta-h7) to The Things Network (TTN) using its onboard LPWAN module. The article will focus on achieving communication between the Max Carrier and an application on TTN. ## Goals -* Enable LoRaWAN® connectivity on the Portenta Max Carrier. +* Enable LoRa® connectivity on the Portenta Max Carrier. * Establish a connection between the Portenta Max Carrier and TTN. - ### Required Hardware and Software - [Portenta H7](https://store.arduino.cc/products/portenta-h7) @@ -36,17 +35,17 @@ This tutorial explains how to connect your [Arduino® Max Carrier](http://store. - [Arduino MKRWAN library](https://github.com/arduino-libraries/MKRWAN) - An active account in [TTN](https://www.thethingsnetwork.org/) -## The Arduino® Portenta Max Carrier LoRaWAN® Module +## Arduino® Portenta Max Carrier LPWAN Module -The Portenta Max Carrier provides you with an unlimited range of applications, from robotics and medical devices to industrial or automotive applications; the Max Carrier possibilities are endless. One feature that boosts Portenta's Max Carrier possibilities is its **onboard LoRaWAN® module**, the [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078) from Murata®. LoRaWAN® is a Low Power Wide Area Network (LPWAN) designed to connect low power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. +The Portenta Max Carrier provides you with an unlimited range of applications, from robotics and medical devices to industrial or automotive applications; the Max Carrier possibilities are endless. One feature that boosts Portenta's Max Carrier possibilities is its **onboard LPWAN module**, the [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078) from Murata®. LoRa®-based network is a type of Low Power Wide Area Network (LPWAN) designed to connect low power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. -![CMWX1ZZABZ-078 LoRaWAN® module in the Portenta Max Carrier.](assets/mc_ard_ttn_module.png) +![CMWX1ZZABZ-078 LPWAN module in the Portenta Max Carrier.](assets/mc_ard_ttn_module.png) -***For more in-depth information about LoRa® and LoRaWAN®, please read [The Arduino Guide to LoRa® and LoRaWAN®](/learn/communication/lorawan-101).*** +***For more in-depth information about LoRa® and its networks, please refer to [this documentation](/learn/communication/lorawan-101).*** ## Connecting to TTN -Let's start sending data to TTN using the Portenta Max Carrier LoRaWAN® module. To do this, you will need a TTN account and to be in the range of a public TTN gateway. You can check the [world map](https://www.thethingsnetwork.org/map) of public gateways connected to TTN and see if your region already has a gateway installed. If not, consider installing one! +Let's start sending data to TTN using the Portenta Max Carrier's LPWAN module. To do this, you will need a TTN account and to be in the range of a public TTN gateway. You can check the [world map](https://www.thethingsnetwork.org/map) of public gateways connected to TTN and see if your region already has a gateway installed. If not, consider installing one! ***Check out [this](https://www.thethingsnetwork.org/docs/gateways/) article from TTN, where you can find how to buy or build your gateway to extend TTN coverage in your region.*** @@ -64,21 +63,21 @@ Let's start! Begin by attaching the Arduino® Portenta H7 board to the high-density connectors of the Portenta Max Carrier, as shown in the image below: -![CMWX1ZZABZ-078 LoRaWAN® module in the Portenta Max Carrier.](assets/mc_ard_hd_ttn_connectors.png) +![CMWX1ZZABZ-078 module with LoRa® technology on the Portenta Max Carrier.](assets/mc_ard_hd_ttn_connectors.png) -To power the CMWX1ZZABZ-078 LoRaWAN® module of the Portenta Max Carrier, you can use the **DC power jack** (with a 4.5V to 36V external DC power supply) of the Portenta Max Carrier or a **18650 3.7V Li-Ion battery**, connected to the Portenta Max Carrier battery clips; you can power the module also directly from the USB-C® connector of the Portenta H7 board. **Also, do not forget to attach an 868-915 MHz antenna to the SMA connector (J9) on the Max Carrier**. +To power the Murata CMWX1ZZABZ-078 module with LoRa® technology on the Portenta Max Carrier, you can use the **DC power jack** (with a 4.5V to 36V external DC power supply) of the Portenta Max Carrier or a **18650 3.7V Li-Ion battery**, connected to the Portenta Max Carrier battery clips; you can power the module also directly from the USB-C® connector of the Portenta H7 board. **Also, do not forget to attach an 868-915 MHz antenna to the SMA connector (J9) on the Max Carrier**. -![Power sources and LoRa® antenna connector in the Portenta Max Carrier.](assets/mc_ard_ttn_power.png) +![Power sources and LoRa® antenna connector on the Portenta Max Carrier.](assets/mc_ard_ttn_power.png) -***Using the LoRaWAN® module of the Portenta Max Carrier without an antenna may damage it. Please, do not forget to connect a suitable antenna to the dedicated SMA connector (J9) on the Portenta Max Carrier.*** +***Using the LPWAN module of the Portenta Max Carrier without an antenna may damage it. Please, do not forget to connect a suitable antenna to the dedicated SMA connector (J9) on the Portenta Max Carrier.*** Now you can connect the Portenta H7 board to your computer using a USB-C® cable. **Don't forget to change the position of the BOOT DIP switch (SW1) to OFF** ; otherwise, you will not be able to program your Portenta H7 board when attached to the Portenta Max Carrier. -![Power sources and LoRa® antenna connector in the Portenta Max Carrier.](assets/mc_ard_ttn_boot_sel.png) +![BOOT DIP Switches on the Portenta Max Carrier.](assets/mc_ard_ttn_boot_sel.png) ### 2. Setting up the Software -You can use several Arduino libraries with the CMWX1ZZABZ-078 LoRaWAN® module from Murata®; we recommend the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN), developed by the Arduino Team. The MKRWAN library provides you with the APIs to communicate with LoRa® and LoRaWAN® networks using the CMWX1ZZABZ-078 module. You can use this library in the Arduino IDE, both [online](https://create.arduino.cc/editor) and [offline](https://www.arduino.cc/en/software). +You can use several Arduino libraries with the CMWX1ZZABZ-078 LPWAN module from Murata®; we recommend the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN), developed by the Arduino Team. The MKRWAN library provides you with the APIs for LoRa® connectivity using the CMWX1ZZABZ-078 module. You can use this library in the Arduino IDE, both [online](https://create.arduino.cc/editor) and [offline](https://www.arduino.cc/en/software). If you are using the online IDE, you don't need to do anything; the library is already installed and ready to be used. If you are using the offline IDE, you must install the library **manually**. Installing the library can be done quickly by navigating to **Tools > Manage Libraries...** and then in the **Library Manager** search for **MKRWAN** library by Arduino; remember to install the latest version of the libraries. You can also access the Library Manager using the left toolbar of the IDE, as shown in the image below: @@ -93,9 +92,9 @@ To use the MKRWAN library with the Portenta Max Carrier, you must define `PORTEN #include ``` -#### 2.1 Updating the LoRaWAN® Module Firmware +#### 2.1 Updating the LPWAN Module Firmware -The LoRaWAN® module firmware of the Portenta Max Carrier **must be updated** before its first use. This can be done using the example sketch `MKRWANFWUpdate_standalone` of the MKRWAN library. You can open this example by navigating to **File > Examples > MKRWAN**. Before uploading the sketch to the Portenta H7 board, open the `MKRWANFWUpdate_standalone.ino` file and define `PORTENTA_CARRIER` before the library inclusion, as shown in the image below: +The LPWAN module firmware of the Portenta Max Carrier **must be updated** before its first use. This can be done using the example sketch `MKRWANFWUpdate_standalone` of the MKRWAN library. You can open this example by navigating to **File > Examples > MKRWAN**. Before uploading the sketch to the Portenta H7 board, open the `MKRWANFWUpdate_standalone.ino` file and define `PORTENTA_CARRIER` before the library inclusion, as shown in the image below: ![Library Manager in the Arduino IDE 2.](assets/mc_ard_ttn_firmware_1.png) @@ -104,7 +103,7 @@ Upload the sketch, open the Serial Monitor and wait for the firmware update to f ### 3. Provisioning the Arduino® Portenta Max Carrier -Device provisioning is a process comparable to bank card numbering. Let's think about bank cards; bank cards numbers start with a six-digit vendor ID number that indicates who allocated and controls the card's security; the remaining digits are unique numbers associated with a specific card. Devices with LoRa® and LoRaWAN® capabilities have a similar system; the **Join Server Unique Identifier** (usually referred to as `JoinEUI`) is a number that manages the security and authorizes the device in a network, while the **Device Unique Identifier** (usually referred to as `DevEUI`) is a unique number that identifies the device. The `JoinEUI` and `DevEUI` are required to send information to TTN; the `JoinEUI` number is provided by the network (in this case TTN) while the `DevEUI` is provided by the manufacturer of the device's LoRa® module. +Device provisioning is a process comparable to bank card numbering. Let's think about bank cards; bank cards numbers start with a six-digit vendor ID number that indicates who allocated and controls the card's security; the remaining digits are unique numbers associated with a specific card. Devices with LoRa® capabilities have a similar system; the **Join Server Unique Identifier** (usually referred to as `JoinEUI`) is a number that manages the security and authorizes the device in a network, while the **Device Unique Identifier** (usually referred to as `DevEUI`) is a unique number that identifies the device. The `JoinEUI` and `DevEUI` are required to send information to TTN; the `JoinEUI` number is provided by the network (in this case TTN) while the `DevEUI` is provided by the manufacturer of the device's LPWAN module. The following sketch lets you find out what is the `DevEUI` of your Portenta Max Carrier: @@ -168,13 +167,13 @@ Now, scroll to **End devices** in the left toolbar and then click on **Add end d On the registration page, click on **Manually**; you will have to add the following information for your Portenta Max Carrier: * **Frequency plan**: choose a region according to your country. -* **LoRaWAN® version**: 1.0.2. +* **LoRa® technology version**: 1.0.2. * **Regional Parameters version**: 1.0.2. -Click on Show advanced activation, **LoRaWAN® class and cluster settings** and choose: +Click on Show advanced activation, **LoRa® class and cluster settings** and choose: * **Activation mode**: Over the air activation (OTAA). -* **Additional LoRaWAN® class capabilities**: None (class A only). +* **Additional LoRa® class capabilities**: None (class A only). * **Network defaults**: Use network's default MAC settings. Leave the **Cluster settings** option unchecked. Then continue with the following information: @@ -204,7 +203,7 @@ LoRaModem modem(SerialLoRa); void setup() { Serial.begin(115200); while (!Serial); - Serial.println(F("Portenta Max Carrier LoRaWAN Example (OTAA)")); + Serial.println(F("Portenta Max Carrier LoRa Example (OTAA)")); if (!modem.begin(region)) { Serial.println(F("Failed to start the module...")); @@ -266,11 +265,11 @@ In your device overview dashboard on TTN, you should see changes in data activit ## Conclusion -You have now successfully configured and used the onboard LoRaWAN® module of your Portenta Max Carrier. You also have learned how to correctly setup a TTN application and enable LoRaWAN® connectivity between a TTN application and the Portenta Max Carrier. +You have now successfully configured and used the onboard LPWAN module of your Portenta Max Carrier. You also have learned how to correctly setup a TTN application and enable LoRa® connectivity between a TTN application and the Portenta Max Carrier. ### Next Steps -- Scale up the usage of Portenta Max Carrier by using its additional peripherals and turning them into interesting industrial-grade projects, taking advantage of LoRaWAN® connectivity. +- Scale up the usage of Portenta Max Carrier by using its additional peripherals and turning them into interesting industrial-grade projects, taking advantage of LoRa® connectivity. ## Troubleshooting @@ -279,3 +278,7 @@ While working on the sketch or when tried to upload the sketch, the Arduino IDE * If the sketch upload process fails, check if your Portenta H7 is in bootloader mode. To put the Portenta H7 into Bootloader mode, double-press its RESET button and verify that the green LED is waving. After this, you can try re-uploading the sketch. * Check the position of the BOOT DIP switch of the Portenta Max Carrier. If the Portenta H7 gets into bootloader mode immediately after power-on, including when connected via USB-C®, change the position of the BOOT DIP switch to OFF. * If the Arduino IDE fails to compile the sketch, check if you have defined `PORTENTA_CARRIER` before the MKRWAN library inclusion. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/user-manual/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/user-manual/content.md index f90a31f1f9..186d98034c 100644 --- a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/user-manual/content.md +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/user-manual/content.md @@ -9,7 +9,7 @@ tags: - RS-485 - Audio - WiFi - - LoRa + - LoRa® Technology - CAT-M1 / NB-IoT - Connectivity author: 'Christopher Méndez' @@ -54,7 +54,7 @@ This user manual offers a detailed guide on the Portenta Max Carrier, consolidat Max Carrier transforms Portenta modules into single-board computers with edge AI capabilities for high-performance industrial, building automation and robotics applications. Thanks to its dedicated high-density connectors, Portenta Max Carrier can be paired with Portenta X8, H7, or C33, allowing any user to easily prototype and deploy multiple industrial projects. -This Arduino Pro carrier further augments Portenta connectivity options with Fieldbus, LoRa®, Cat-M1 and NB-IoT. +This Arduino Pro carrier further augments Portenta connectivity options with Fieldbus, LoRa® technology, Cat-M1 and NB-IoT. Among the many available plug-and-play connectors, there are Gigabit Ethernet, USB-A, audio jacks, microSD, mini-PCIe, MIPI camera, FD-CAN, and Serial RS-232/422/485. Max Carrier can be powered via external supply (6-36V) or battery via the onboard 18650 Li-ion battery connector. @@ -87,13 +87,13 @@ __Note:__ USB, I2C and SIM functionality over PCIe is available only for the X8. - **Audio**: The Portenta Max Carrier enables connections to analog audio channels. This is done through the low power CS42L52 stereo CODEC providing ADC/DAC between analog signals and the I2S protocol. An internal Class D amplifier eliminates the need for external audio amplification circuitry. -- **LoRa® Module**: The Portenta Max Carrier provides long range wireless connectivity for low bandwidth applications with the onboard Murata CMWX1ZZABZ-078 LoRa® transceiver module. This module operates at 3V3. A dedicated SMA connector is provided for connecting an external antenna. +- **LPWAN Module**: The Portenta Max Carrier provides long range wireless connectivity for low bandwidth applications with the onboard Murata CMWX1ZZABZ-078, which supports LoRa® technology. This module operates at 3V3. A dedicated SMA connector is provided for connecting an external antenna. - **MIPI Camera**: The Portenta Max Carrier, when combined with a Portenta X8, supports MIPI cameras. The latter can be plugged into the onboard camera connector (J4) via a flexible flat cable. The camera support is perfect for machine/computer vision applications such as product line inspection, object detection, image classification and robotics. - **Storage**: The board has a MicroSD card slot for data logging operation. -- **Debug interface**: Debugging capabilities are integrated directly into the Portenta Max Carrier and are accessible via micro USB. The J-link debugger is compatible with the Segger® J-Link OB and Blackmagic probes, driven by the STM32F405RGT6 controller. In addition to providing access to the Portenta board JTAG ports, different sniffer channels for I2C, CAN and UART lines are available. The debugger firmware can be updated via SWD on CN3. Additionally, headers for debugging the LoRa® are accessible via CN2 with SWD. +- **Debug interface**: Debugging capabilities are integrated directly into the Portenta Max Carrier and are accessible via micro USB. The J-link debugger is compatible with the Segger® J-Link OB and Blackmagic probes, driven by the STM32F405RGT6 controller. In addition to providing access to the Portenta board JTAG ports, different sniffer channels for I2C, CAN and UART lines are available. The debugger firmware can be updated via SWD on CN3. Additionally, headers for debugging the LoRa® connectivity are accessible via CN2 with SWD. - **DIP switch**: The carrier has a DIP switch with two positions and enables different profiles depending on the paired Portenta board. See the [DIP Switches section](#dip-switch-configuration) for more details. @@ -102,31 +102,31 @@ __Note:__ USB, I2C and SIM functionality over PCIe is available only for the X8. ![Portenta Max Carrier Topology](assets/Top-new.png) -| **Ref.** | **Description** | **Ref.** | **Description** | -| -------- | ------------------------------------------------------ | -------------- | --------------------------------------------------------- | -| U1 | SARA-R412M-02B 4G LTE/Cat-M1/NB-IoT Modem IC | U2 | CS42L52-CNZ Stereo Codec IC | -| U3 | USB2514Bi/M2 4-port USB 2.0 Hub IC | U4 | SP335EER1-L RS232/RS485/RS422 Transceiver IC | -| U5 | TJA1049 CAN Transceiver IC | U6 | MPM3550EGLE Non-isolated DC-DC IC | -| U7 | NCP383 Current Limiting IC | U8,U20,U21,U22 | SN74LVC1T45 Bi-directional logic level converter IC | -| U9 | DSC6111HI2B 12MHz MEMS Oscillator IC | U10 | SN74LVC1G125 Single Bus Buffer Gate IC | -| U11 | BQ24195RGET 4.5A Single Cell Charger IC | U12 | AP7311 1.8V 150mA LDO Linear Regulator IC | -| U13 | TPS54620 6A Buck Regulator IC | U14 | AP2112K-3.3TRG1 3.3V 600mA LDO Regulator IC | -| U15 | STM32F405RG 168MHz 32 bit Arm® Cortex®-M4 MCU IC | U16-U19 | 74LVC1G157 Single 2-input multiplexer IC | -| U23 | CMWX1ZZABZ-078 Murrata LoRa® module | U24, U25 | LM73100 Ideal Diode with Reverse Polarity Protection | -| J1, J2 | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | J3 | Right-Angle SMA Connector for Modem | -| J4 | Camera 2-1734248-0 FPC Connector | J5 | FW-20-05-G-D-254-150 Signal Break | -| J6 | 615006138421 RS232/RS485 Connector | J7 | 615006138421 CAN Connector | -| J8 | 1759546-1 Mini PCIe Connector | J9 | Right-Angle SMA Connector for LoRa® | -| J10 | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | J11 | 114-00841-68 Micro SD Connector | -| J12 | SJ-3524-SMT-TR 3.5mm Headphone Out | J13 | SJ-3524-SMT-TR 3.5mm Line In Right | -| J14 | SJ-3524-SMT-TR 3.5mm Line In Left | J15 | 61400826021 2-port USB 2.0 Female Connector | -| J16 | 254TR Positive Li-ion Terminal | J17 | TRJK7003A97NL Gigabit Ethernet Connector | -| J18 | 254TR Negative Li-ion Terminal | | | -| J20 | 110990030 Connector for Speaker | X1 | PJ-102A 5.5mm Power Jack Adapter | -| CN1 | FTSH-105-01-F-DV 10-pin JTAG Header | CN2 | Debug Header | -| CN3 | LoRa® Debug Header | SIM1 | 2199337-5 microSIM Card Holder (for on-board modem) | -| SW1 | 218-2LPST Boot Select Switch | SW2 | 218-2LPST Switch *(2)* | -| PB1 | PTS820J25KSMTRLFS Power On Button | PB2 | PTS820J25KSMTRLFS Reset Button | +| **Ref.** | **Description** | **Ref.** | **Description** | +|----------|--------------------------------------------------------|----------------|------------------------------------------------------| +| U1 | SARA-R412M-02B 4G LTE/Cat-M1/NB-IoT Modem IC | U2 | CS42L52-CNZ Stereo Codec IC | +| U3 | USB2514Bi/M2 4-port USB 2.0 Hub IC | U4 | SP335EER1-L RS232/RS485/RS422 Transceiver IC | +| U5 | TJA1049 CAN Transceiver IC | U6 | MPM3550EGLE Non-isolated DC-DC IC | +| U7 | NCP383 Current Limiting IC | U8,U20,U21,U22 | SN74LVC1T45 Bi-directional logic level converter IC | +| U9 | DSC6111HI2B 12MHz MEMS Oscillator IC | U10 | SN74LVC1G125 Single Bus Buffer Gate IC | +| U11 | BQ24195RGET 4.5A Single Cell Charger IC | U12 | AP7311 1.8V 150mA LDO Linear Regulator IC | +| U13 | TPS54620 6A Buck Regulator IC | U14 | AP2112K-3.3TRG1 3.3V 600mA LDO Regulator IC | +| U15 | STM32F405RG 168MHz 32 bit Arm® Cortex®-M4 MCU IC | U16-U19 | 74LVC1G157 Single 2-input multiplexer IC | +| U23 | CMWX1ZZABZ-078 Murata LPWAN module | U24, U25 | LM73100 Ideal Diode with Reverse Polarity Protection | +| J1, J2 | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | J3 | Right-Angle SMA Connector for Modem | +| J4 | Camera 2-1734248-0 FPC Connector | J5 | FW-20-05-G-D-254-150 Signal Break | +| J6 | 615006138421 RS232/RS485 Connector | J7 | 615006138421 CAN Connector | +| J8 | 1759546-1 Mini PCIe Connector | J9 | Right-Angle SMA Connector for LoRa® | +| J10 | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | J11 | 114-00841-68 Micro SD Connector | +| J12 | SJ-3524-SMT-TR 3.5mm Headphone Out | J13 | SJ-3524-SMT-TR 3.5mm Line In Right | +| J14 | SJ-3524-SMT-TR 3.5mm Line In Left | J15 | 61400826021 2-port USB 2.0 Female Connector | +| J16 | 254TR Positive Li-ion Terminal | J17 | TRJK7003A97NL Gigabit Ethernet Connector | +| J18 | 254TR Negative Li-ion Terminal | | | +| J20 | 110990030 Connector for Speaker | X1 | PJ-102A 5.5mm Power Jack Adapter | +| CN1 | FTSH-105-01-F-DV 10-pin JTAG Header | CN2 | Debug Header | +| CN3 | Debug Header for LoRa® connectivity | SIM1 | 2199337-5 microSIM Card Holder (for on-board modem) | +| SW1 | 218-2LPST Boot Select Switch | SW2 | 218-2LPST Switch *(2)* | +| PB1 | PTS820J25KSMTRLFS Power On Button | PB2 | PTS820J25KSMTRLFS Reset Button | ### Carrier Characteristics Highlight @@ -138,9 +138,9 @@ The Portenta Max Carrier extends the features of the Portenta X8, H7, and C33. T | Ethernet | 100 Mbps | 1 Gbps | | | CAN | Portenta C33 only | Yes | | | Mini PCIe (USB) | USB 1.0 | USB 2.0 | Max Speed: USB 1.0 - 12 Mbps, USB 2.0 - 480 Mbps | -| Mini PCIe (PCIe) | No | PCIe 2.0 | | +| Mini PCIe (PCIe) | No | PCIe 2.0 | | | Battery Charger | Yes | Yes | | -| LoRa® | Yes | Yes | | +| LoRa® technology | Yes | Yes | | | NBIoT/CatM1/2G | Yes | Yes | | | Camera | No | MIPI up to 4 lanes | No MIPI camera support on H7/C33 | | Audio | Limited | Yes | No firmware support for the H7 | @@ -645,19 +645,19 @@ Below you can see what will be printed in the Serial Monitor when connecting to ![Results in the Serial Monitor](assets/Cat-M1-serial-monitor.png) -### LoRa® +### LoRa® Technology -One feature that boosts Portenta Max Carrier possibilities is its onboard LoRa® module, the CMWX1ZZABZ-078 from Murata®. LoRaWAN® is a Low Power Wide Area Network (LPWAN) protocol designed to connect low-power devices to the Internet. It has been developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low power consumption and low data throughput. +One feature that boosts Portenta Max Carrier possibilities is its onboard LPWAN module, the CMWX1ZZABZ-078 from Murata®. LoRa® technology is a Low Power Wide Area Network (LPWAN) protocol designed to connect low-power devices to the Internet. It has been developed to meet the requirements of Internet of Things (IoT) applications, such as low power consumption and low data throughput. A dedicated SMA connector (J9) is available for connecting an external antenna. ![Portenta Max Carrier with LoRa® Antenna](assets/LoRaAntenna.png) -***Recommended LoRa® antenna: ANT-8/9-IPW1-SMA*** +***Recommended antenna for LoRa® connectivity: ANT-8/9-IPW1-SMA*** #### Using Linux -Empower your Portenta X8 connectivity with LoRa® by following this detailed guide on [How to set up a multi-protocol gateway using the Portenta X8 and the Max Carrier](https://docs.arduino.cc/tutorials/portenta-x8/multi-protocol-gateway) +Empower your Portenta X8 connectivity with LoRa® technology by following this detailed guide on [How to set up a multi-protocol gateway using the Portenta X8 and the Max Carrier](https://docs.arduino.cc/tutorials/portenta-x8/multi-protocol-gateway) #### Using Arduino IDE @@ -2220,4 +2220,8 @@ Join our community forum to connect with other Portenta Max Carrier users, share Please get in touch with our support team if you need personalized assistance or have questions not covered by the help and support resources described before. We're happy to help you with any issues or inquiries about the Portenta Max Carrier. -- [Contact us page](https://www.arduino.cc/pro/contact-us) \ No newline at end of file +- [Contact us page](https://www.arduino.cc/pro/contact-us) + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/x8-getting-started/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/x8-getting-started/content.md index 72b819f307..30285125aa 100644 --- a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/x8-getting-started/content.md +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/x8-getting-started/content.md @@ -39,14 +39,14 @@ The Arduino® Portenta Max Carrier was designed to add capabilities to the Ardui To make use of the Portenta Max Carrier you will need to power it through either the barrel jack connector or with a 3.7V 18650 Li-Ion battery, connected to the Portenta Max Carriers battery clips. | Function | Supported on the Portenta X8 M4 Core | Supported on Portenta X8's NXP® i.MX 8M Mini Processor | -| ------------------------ | ------------------------------------ | ------------------------------------------------------ | +|--------------------------|--------------------------------------|--------------------------------------------------------| | USB Host | USB 1.0 | USB 2.0 | | Ethernet | Fast Ethernet | 1 Gbps | | CAN | Yes | Yes | | Mini PCIe (USB) | USB 1.0 | USB 2.0 | | Mini PCIe (PCIe) | No | PCIe 2.0 | | Battery Charger | Yes | Yes | -| LoRa® | Yes (additional software required) | Yes (additional software required) | +| LoRa® technology | Yes (additional software required) | Yes (additional software required) | | NBIoT/CatM1/2G | Yes (additional software required) | Yes (additional software required) | | Camera | No | MIPI up to 4 lanes | | Audio | Limited | Yes | @@ -90,13 +90,13 @@ The Portenta Max Carrier carries a cellular modem SARA-R412M-02B to carry out ta If you want to use this feature with Python® scripts, have a look at the [Modem Manager API](https://www.freedesktop.org/software/ModemManager/doc/latest/ModemManager/). -### LoRa® +### LoRa® Technology -One of the many features of the Portenta Max Carrier is the Murata CMWX1ZZABZ-078 which enables LoRaWAN® connectivity. LoRaWAN® is a Low Power Wide Area Network (LPWAN) designed to connect low-power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. +One of the many features of the Portenta Max Carrier is the Murata CMWX1ZZABZ-078 which enables LoRa® connectivity. LoRa technology is a Low Power Wide Area Network (LPWAN) protocol designed to connect low-power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. The appropriate antenna and frequencies depend on the region. The common frequencies are 915 MHz for North America and Australia and 863 MHz for the European region. Frequencies are on a range, so for example in the Australia region it is possible to use a 928 MHz compatible antenna and configuration. -For more in-depth information about LoRa® and LoRaWAN®, please read [The Arduino Guide to LoRa® and LoRaWAN®](/learn/communication/lorawan-101). +For more in-depth information about LoRa® and its networks, please refer to [this documentation](/learn/communication/lorawan-101). ### Ethernet @@ -212,3 +212,7 @@ If you want to use the Portenta X8 and Max Carrier with a FoundriesFactory, Pyth | | 33 | mPCIe_TX_P | Diff. | PCIe Transmission Differential Positive | | | 36 | USB_DN | Diff. | USB Data Differential Negative | | | 38 | USB_DN | Diff. | USB Differential Positive | + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/connecting-to-ttn/content.md b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/connecting-to-ttn/content.md index e55fbc41a3..38027fde38 100644 --- a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/connecting-to-ttn/content.md +++ b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/connecting-to-ttn/content.md @@ -1,8 +1,8 @@ --- -title: Connecting the Portenta Vision Shield to TTN Using LoRa® +title: Connect Portenta Vision Shield to TTN with LoRa® Technology coverImage: assets/vs_ard_things_nw.svg difficulty: intermediate -tags: [Things Network, LoRa, Vision Shield] +tags: [Things Network, LoRa® Technology, Vision Shield] description: This tutorial explains how to connect your Portenta H7 to The Things Network (TTN) using the the Portenta Vision Shield's LoRa® Connectivity feature. author: Lenard George, Ignacio Herrera hardware: @@ -14,28 +14,28 @@ hardware: This tutorial explains how to connect your Portenta H7 to The Things Network (TTN) using the the Portenta Vision Shield's LoRa® Connectivity feature. A data communication channel will be enabled between the H7 and a TTN application that will be configured on your TTN console. -***In order to connect your Portenta to the TTN, make sure you are within the range (max. 10 Km) from an available LoRa® Gateway. Indoor gateways will have a much shorter range. It is recommended that you check LoRa® Gateway availability on [The Things Network map](https://www.thethingsnetwork.org/map) before you try this tutorial.*** +***In order to connect your Portenta to the TTN, make sure you are within the range (max. 10 Km) from an available LoRa® Gateway. Indoor gateways will have a much shorter range. It is recommended that you check LoRa Gateway availability on [The Things Network map](https://www.thethingsnetwork.org/map) before you try this tutorial.*** ## Goals -- About LoRaWAN® and The Things Network, +- About LoRa® technology and The Things Network, - About creating a TTN application, - How to establish a connection between the Portenta H7 and the TTN. ### Required Hardware and Software - [Portenta H7](https://store.arduino.cc/portenta-h7) -- [Portenta Vision Shield - LoRa](https://store.arduino.cc/portenta-vision-shield-lora) +- [Portenta Vision Shield with LoRa® technology](https://store.arduino.cc/portenta-vision-shield-lora) - [Dipole Pentaband antenna](https://store.arduino.cc/antenna) or a UFL Antenna of the H7 (x1) - [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software), or the [Arduino Cloud Editor](https://create.arduino.cc/editor) - [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c) - An [account](https://console.cloud.thethings.network/) with The Things Network ### Updating the LoRa® Module Firmware -To be able to use the LoRa® functionality, we need to first update the firmware on the LoRa® modem. This can be done through Arduino IDE by running a sketch included in the examples from the MKRWAN library. +To be able to use the LoRa® functionality, we need to first update the firmware on the LoRa modem. This can be done through Arduino IDE by running a sketch included in the examples from the MKRWAN library. -1. Connect the Portenta H7 and the Portenta Vision Shield - LoRa to your computer and open the Arduino IDE. -2. Install/update the **MKRWAN** library from Arduino IDE menu **Tools > Manage Libraries**. Type "MKRWAN" to find the library and click 'Install' or 'Update' if necessary. This library provides all the APIs to communicate with LoRa® and LoRaWAN® networks. +1. Connect the Portenta H7 and the Portenta Vision Shield - LoRa® to your computer and open the Arduino IDE. +2. Install/update the **MKRWAN** library from Arduino IDE menu **Tools > Manage Libraries**. Type "MKRWAN" to find the library and click 'Install' or 'Update' if necessary. This library provides all the APIs to establish LoRa® connectivity. 3. Open the **MKRWANFWUpdate_standalone** sketch from the Arduino IDE menu: **File > Examples > MKRWAN**. 4. Upload the sketch. @@ -49,7 +49,7 @@ To be able to use the LoRa® functionality, we need to first update the firmware ## Connecting to the TTN -The Portenta Vision Shield - LoRa can be connected to the TTN and can transmit data to other devices connected to this network through a secure channel. This channel is nothing but an application on the TTN network dedicated for your board. In this tutorial, you will be guided through a step-by-step process of setting up your Portenta board and the Vision Shield - LoRa to communicate with a TTN application. As stated before, to be able to follow this guide, you need to be under coverage of one of the TTN gateways. You can check for [the coverage](https://www.thethingsnetwork.org/map) now if you have not done so yet. +The Portenta Vision Shield with LoRa® technology can be connected to the TTN and can transmit data to other devices connected to this network through a secure channel. This channel is nothing but an application on the TTN network dedicated for your board. In this tutorial, you will be guided through a step-by-step process of setting up your Portenta board and the Vision Shield with LoRa technology to communicate with a TTN application. As stated before, to be able to follow this guide, you need to be under coverage of one of the TTN gateways. You can check for [the coverage](https://www.thethingsnetwork.org/map) now if you have not done so yet. ### 1. Setting up the Environment @@ -78,23 +78,23 @@ After completing these two fields, press the "Create application" button located Let's take a closer look at these sections: -- **Application Overview**: in order to use this app, you will need the Application ID and a device specific AppKey. An EUI is a globally unique identifier for networks, gateways applications and devices. The EUIs are used to identify all parts of the LoRaWAN® inside the backend server. -- **End devices**: here you can see and manage all the associated devices (e.g. your Portenta H7 with Portenta Vision Shield - LoRa, Arduino MKR WAN 1300 or MKR WAN 1310), or proceed with the registration of a new one. Registering a new device lets you generate an AppEUI and an AppKey. +- **Application Overview**: in order to use this app, you will need the Application ID and a device specific AppKey. An EUI is a globally unique identifier for networks, gateways applications and devices. The EUIs are used to identify all parts of the LoRa®-based network inside the backend server. +- **End devices**: here you can see and manage all the associated devices (e.g. your Portenta H7 with Portenta Vision Shield with LoRa® technology, Arduino MKR WAN 1300 or MKR WAN 1310), or proceed with the registration of a new one. Registering a new device lets you generate an AppEUI and an AppKey. - **Collaborators**: here you can see and manage all the app collaborators, to integrate with other collaborative platforms or to manage access rights to the app with other TTN registered profiles. - **API keys**: here you can create an API key, it is the most sensible information. It is basically the key to gain access to your app, so keep it safe. ### 3. Configuring the Portenta Vision Shield -It iss now time to connect your Portenta H7 and Portenta Vision Shield - LoRa to TTN. You will need to upload code to the board, so, as you probably already know, there are two options: +It iss now time to connect your Portenta H7 and Portenta Vision Shield with LoRa® technology to TTN. You will need to upload code to the board, so, as you probably already know, there are two options: - Use the [Arduino Cloud Editor](https://create.arduino.cc/editor) - Use the [Arduino IDE](https://www.arduino.cc/en/software), (this is the option this guide will follow) -Plug the Portenta Vision Shield - LoRa to the Portenta H7 and them to your PC through the USB port. Be sure to have selected the right board "Arduino Portenta H7 (M7 core)" and the right port. +Plug the Portenta Vision Shield with LoRa® technology to the Portenta H7 and them to your PC through the USB port. Be sure to have selected the right board "Arduino Portenta H7 (M7 core)" and the right port. ![Select port M7 Core](assets/vs_ard_select_port.png) -The LoRa® module on the Portenta Vision Shield - LoRa can be accessed by using the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN)(if you cannot find it in your examples list, you can go to **Tools > Library Manager** and type "MKRWAN library" to install it). This library provides all the APIS to communicate with LoRa® and LoRaWAN® networks and can be installed from the library Manager. The first code you need to upload and run is from the **MKRWAN** library, and its name is **FirstConfiguration**. +The LoRa® module on the Portenta Vision Shield with LoRa technology can be accessed by using the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN)(if you cannot find it in your examples list, you can go to **Tools > Library Manager** and type "MKRWAN library" to install it). This library provides all the APIS to establish LoRa connectivity and can be installed from the library Manager. The first code you need to upload and run is from the **MKRWAN** library, and its name is **FirstConfiguration**. ![Upload code to IDE](assets/vs_ard_select_example.png) @@ -122,7 +122,7 @@ Before your Portenta H7 can start communicating with the TTN, you need to [regis ![Registering a Device](assets/vs_ard_ttn_click_register.png) -On the registration page, first you have to fill in information about your board. Select brand Arduino SA, and Portenta Vision Shield - LoRa as the model. Hardware and firmware versions will automatically be set to the newest ones. Then set your preferred region. +On the registration page, first you have to fill in information about your board. Select brand Arduino SA, and Portenta Vision Shield with LoRa® technology as the model. Hardware and firmware versions will automatically be set to the newest ones. Then set your preferred region. ![Entering the device EUI](assets/vs_ard_ttn_register_device_1.png) @@ -162,18 +162,22 @@ Message sent correctly! ## Conclusion -If you receive this message, you have managed to configure the Portenta H7 and the Portenta Vision Shield - LoRa on TTN. +If you receive this message, you have managed to configure the Portenta H7 and the Portenta Vision Shield with LoRa® technology on TTN. -You have retrieved the device EUI, used it to register the device in the TTN console, and programmed the board using the data provided by TTN. Now, you can send data over the LoRa® network which can be viewed from anywhere in the world (as long as we have an Internet connection and your device is in the range of a TTN gateway). +You have retrieved the device EUI, used it to register the device in the TTN console, and programmed the board using the data provided by TTN. Now, you can send data over the LoRa®-based network which can be viewed from anywhere in the world (as long as we have an Internet connection and your device is in the range of a TTN gateway). ### Next Steps - Try sending uplink and downlink messages between Portenta and your TTN application with **LoraSendAndReceive** sketch from the MKRWAN library. - Experiment your board's capabilities with OpenMV and the examples from the dedicated library for Arduino. You can continue with [this tutorial](https://docs.arduino.cc/tutorials/portenta-h7/getting-started-openmv-micropython) from the Arduino Documentation site. -- Combine LoRaWAN® protocol with an OpenMV example to develop your own IoT application. Take advantage of the board's camera to detect, filter, classify images, read QR codes or more. +- Combine LoRa® protocol with an OpenMV example to develop your own IoT application. Take advantage of the board's camera to detect, filter, classify images, read QR codes or more. ## Troubleshooting The most common issue is that the device cannot connect to a TTN gateway. Again, it is a good idea to check if you have coverage in the area you are conducting this tutorial, by checking out [this map](https://www.thethingsnetwork.org/map). If you are within good range of a gateway, you should also try to move your device and antenna to a window, and even hold it out the window and move it around. This has proven successful on numerous accounts, as the signal can travel less obstructed. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/things-network-openmv/content.md b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/things-network-openmv/content.md index b427451cb7..fc010b5bf8 100644 --- a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/things-network-openmv/content.md +++ b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/things-network-openmv/content.md @@ -2,7 +2,7 @@ title: Connecting to The Things Network Using OpenMV coverImage: assets/vs_mp_ttn_cover.svg difficulty: intermediate -tags: [Getting Started, OpenMV, IDE, Setup, TTN, LoRa] +tags: [Getting Started, OpenMV, IDE, Setup, TTN, LoRa® Technology] description: This tutorial explains how to connect your Portenta H7 to The Things Network (TTN) using the Vision Shield's LoRa® Connectivity feature. author: Lenard George, Ignacio Herrera, Benjamin Dannegård hardware: @@ -16,18 +16,18 @@ software: This tutorial explains how to connect your Portenta H7 to The Things Network (TTN) using the Vision Shield's LoRa® Connectivity feature. A data communication channel will be enabled between the H7 and a TTN application that will be configured on your TTN console. -***In order to connect your Portenta to the TTN, make sure you are within the range (max. 10 Km) from an available LoRa® Gateway. Indoor gateways will have a much shorter range. It is recommended that you check LoRa® Gateway availability on [The Things Network map](https://www.thethingsnetwork.org/map) before you try this tutorial.*** +***In order to connect your Portenta to the TTN, make sure you are within the range (max. 10 Km) from an available LoRa® Gateway. Indoor gateways will have a much shorter range. It is recommended that you check LoRa Gateway availability on [The Things Network map](https://www.thethingsnetwork.org/map) before you try this tutorial.*** ## You Will Learn -- About LoRaWAN® and The Things Network +- About LoRa® technology and The Things Network - About creating a TTN application - How to establish a connection between the H7 and the TTN ## Required Hardware and Software - [Portenta H7](https://store.arduino.cc/portenta-h7) -- [Portenta Vision Shield - LoRa](https://store.arduino.cc/portenta-vision-shield-lora) +- [Portenta Vision Shield with LoRa® technology](https://store.arduino.cc/portenta-vision-shield-lora) - [Dipole Pentaband antenna](https://store.arduino.cc/antenna) or a UFL Antenna of the H7 (x1) - [OpenMV IDE](https://openmv.io/pages/download) - [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software) or [Arduino CLI 0.13.0+](https://arduino.github.io/arduino-cli) @@ -36,7 +36,7 @@ This tutorial explains how to connect your Portenta H7 to The Things Network (TT ## Instructions -The Portenta Vision Shield - LoRa can be connected to TTN and can transmit data to other devices connected to this network through a secure channel. This channel is nothing but an application on the TTN network dedicated for your board. In this tutorial, you will be guided through a step-by-step process of setting up your Portenta board and the Portenta Vision Shield - LoRa to communicate with a TTN application using OpenMV and MicroPython. As stated before, to be able to follow this guide, you need to be under coverage of one of the TTN gateways. You can check for [the coverage](https://www.thethingsnetwork.org/map) now, if you have not done so yet. +The Portenta Vision Shield with LoRa® technology can be connected to TTN and can transmit data to other devices connected to this network through a secure channel. This channel is nothing but an application on the TTN network dedicated for your board. In this tutorial, you will be guided through a step-by-step process of setting up your Portenta board and the Portenta Vision Shield with LoRa technology to communicate with a TTN application using OpenMV and MicroPython. As stated before, to be able to follow this guide, you need to be under coverage of one of the TTN gateways. You can check for [the coverage](https://www.thethingsnetwork.org/map) now, if you have not done so yet. ### 1. Setting up the Environment @@ -65,14 +65,14 @@ After completing these two fields, press the "Create application" button located Let's take a closer look at these sections: -- **Application Overview**: in order to use this app, you will need the Application ID and a device specific AppKey. An EUI is a globally unique identifier for networks, gateways applications and devices. The EUIs are used to identify all parts of the LoRaWAN® inside the backend server. -- **End devices**: here you can see and manage all the associated devices (e.g. your Portenta H7 with Portenta Vision Shield LoRa, Arduino MKR WAN 1300 or MKR WAN 1310) or proceed with the registration of a new one. Registering a new device lets you generate an AppEUI and an AppKey. +- **Application Overview**: in order to use this app, you will need the Application ID and a device specific AppKey. An EUI is a globally unique identifier for networks, gateways applications and devices. The EUIs are used to identify all parts of the LoRa®-based network inside the backend server. +- **End devices**: here you can see and manage all the associated devices (e.g. your Portenta H7 with Portenta Vision Shield with LoRa® technology, Arduino MKR WAN 1300 or MKR WAN 1310) or proceed with the registration of a new one. Registering a new device lets you generate an AppEUI and an AppKey. - **Collaborators**: here you can see and manage all the app collaborators, to integrate with other collaborative platforms or to manage access rights to the app with other TTN registered profiles. - **API keys**: here you can create an API key; it is the most sensible information. It is basically the key to gain access to your app, so keep it safe. ### 3. Updating the Modems Firmware -To be able to use the LoRa® functionality, you need to first update the modems firmware through the Arduino IDE. Connect the Portenta H7 and Portenta Vision Shield to your computer and open the Arduino IDE. The LoRa® module on the Portenta Vision Shield can be accessed by using the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN)(if you cannot find it in your examples list, you can go to **Tools > Library Manager** and type "MKRWAN library" to install it). This library provides all the APIS to communicate with LoRa® and LoRaWAN® networks and can be installed from the library manager. Select the **Portenta H7 (M7 core)** board in the Arduino IDE, like shown below. +To be able to use the LoRa® functionality, you need to first update the modems firmware through the Arduino IDE. Connect the Portenta H7 and Portenta Vision Shield to your computer and open the Arduino IDE. The LoRa® module on the Portenta Vision Shield can be accessed by using the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN)(if you cannot find it in your examples list, you can go to **Tools > Library Manager** and type "MKRWAN library" to install it). This library provides all the APIS to establish LoRa® connectivity and can be installed from the library manager. Select the **Portenta H7 (M7 core)** board in the Arduino IDE, like shown below. ![Select the Arduino Portenta H7 (M7 core) in the board selector.](assets/por_ard_gs_upload_sketch.png) @@ -88,9 +88,9 @@ If it all went correctly, you should see the same text in your Serial Monitor as ### 4. Configuring the Portenta Vision Shield -It is now time to connect your Portenta H7 and Portenta Vision Shield - LoRa to TTN. You will need to upload code to the board using [OpenMV](https://openmv.io/pages/download) +It is now time to connect your Portenta H7 and Portenta Vision Shield with LoRa® technology to TTN. You will need to upload code to the board using [OpenMV](https://openmv.io/pages/download) -Plug the Portenta Vision Shield - LoRa to the Portenta H7 and them to your PC through the USB port. If the Portenta board does not show up on OpenMV, try double-pressing the reset button on the Portenta. Now update to the latest firmware in OpenMV. +Plug the Portenta Vision Shield with LoRa® technology to the Portenta H7 and them to your PC through the USB port. If the Portenta board does not show up on OpenMV, try double-pressing the reset button on the Portenta. Now update to the latest firmware in OpenMV. The only line you may need to change before uploading the code is the one that sets the frequency. Set the frequency code according to your country if needed. You can find more information about frequency by country at [this TTN link](https://www.thethingsnetwork.org/docs/lorawan/frequency-plans/). @@ -146,7 +146,7 @@ Before your Portenta H7 can start communicating with the TTN, you need to [regis ![Registering a Device](assets/vs_ard_ttn_click_register.png) -On the registration page, first you have to fill in information about your board. Select brand Arduino SA and Portenta Vision Shield - LoRa as the model. Hardware and firmware versions will automatically be set to the newest ones. Then set your preferred region. +On the registration page, first you have to fill in information about your board. Select brand Arduino SA and Portenta Vision Shield with LoRa® technology as the model. Hardware and firmware versions will automatically be set to the newest ones. Then set your preferred region. ![First step of registering device](assets/vs_ard_ttn_register_device_1.png) @@ -180,7 +180,7 @@ Message confirmed. ``` ## Conclusion -If you receive this message, you have managed to configure the Portenta H7 and the Portenta Vision Shield - LoRa to TTN. You have retrieved the device EUI, used it to register the device in the TTN console and programmed the board using the data provided by TTN. Now, you can send data over LoRa® network, which can be viewed from anywhere in the world (as long as you have an Internet connection and your device is in range from a TTN gateway). +If you receive this message, you have managed to configure the Portenta H7 and the Portenta Vision Shield with LoRa® technology to TTN. You have retrieved the device EUI, used it to register the device in the TTN console and programmed the board using the data provided by TTN. Now, you can send data over LoRa-based network, which can be viewed from anywhere in the world (as long as you have an Internet connection and your device is in range from a TTN gateway). ### Complete Sketch @@ -234,10 +234,14 @@ while (True): ### Next Steps - Experiment your Portenta Vision Shield's capabilities with OpenMV and the examples from the dedicated library for Arduino. You can continue with [this tutorial](https://docs.arduino.cc/tutorials/portenta-vision-shield/blob-detection) from the Arduino DOCS site. -- Combine LoRaWAN® protocol with an OpenMV example to develop your own IoT application. Take advantage of the Portenta Vision Shield's camera to detect, filter, classify images, read QR codes or more. +- Combine LoRa® protocol with an OpenMV example to develop your own IoT application. Take advantage of the Portenta Vision Shield's camera to detect, filter, classify images, read QR codes or more. ## Troubleshooting The most common issue is that the device cannot connect to a TTN gateway. Again, it is a good idea to check if you have coverage in the area you are conducting this tutorial, by checking out [this map](https://www.thethingsnetwork.org/map). If you are within a good range from a gateway, you should also try to move your device and antenna to a window and even hold it out the window and move it around. This has proven successful on numerous accounts, as the signal can travel less obstructed. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/assets/arch-top-c.png b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/assets/arch-top-c.png index 630150fa76..a4b7bedb9e 100644 Binary files a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/assets/arch-top-c.png and b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/assets/arch-top-c.png differ diff --git a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/content.md b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/content.md index d17f1f6fb3..4c6542c66d 100644 --- a/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/content.md +++ b/content/hardware/04.pro/shields/portenta-vision-shield/tutorials/user-manual/content.md @@ -24,7 +24,7 @@ This user manual will guide you through a practical journey covering the most in ## Hardware and Software Requirements ### Hardware Requirements -- [Portenta Vision Shield Ethernet](https://store.arduino.cc/collections/shields-carriers/products/arduino-portenta-vision-shield-ethernet) (x1) or [Portenta Vision Shield LoRa®](https://store.arduino.cc/collections/shields-carriers/products/arduino-portenta-vision-shield-lora%C2%AE) +- [Portenta Vision Shield Ethernet](https://store.arduino.cc/collections/shields-carriers/products/arduino-portenta-vision-shield-ethernet) (x1) or [Portenta Vision Shield with LoRa® technology](https://store.arduino.cc/collections/shields-carriers/products/arduino-portenta-vision-shield-lora%C2%AE) - [Portenta H7](https://store.arduino.cc/products/portenta-h7) (x1) or [Portenta C33](https://store.arduino.cc/products/portenta-c33) (x1) - [USB-C® cable cable](https://store.arduino.cc/products/usb-cable2in1-type-c) (x1) @@ -47,7 +47,7 @@ The included camera module has been pre-configured to work with the OpenMV libra ### Board Architecture Overview -The Portenta Vision Shield LoRa® brings industry-rated features to your Portenta. This hardware add-on will let you run embedded computer vision applications, connect wirelessly via LoRa® to the Arduino Cloud or your own infrastructure, and activate your system upon the detection of sound events. +The Portenta Vision Shield with LoRa® technology brings industry-rated features to your Portenta. This hardware add-on will let you run embedded computer vision applications, connect wirelessly via LoRa technology to the Arduino Cloud or your own infrastructure, and activate your system upon the detection of sound events. ![Vision Shield main components (top view)](assets/arch-top-c.png) ![Vision Shield main components (bottom view)](assets/arch-bottom.png) @@ -890,22 +890,22 @@ Run the script and the current date and time will be printed in the OpenMV IDE S ## LoRa® (ASX00026) -The **Vision Shield - LoRa®** can extend our project connectivity by leveraging it LoRa® module for long-range communication in remote areas with a lack of internet access. Powered by the Murata CMWX1ZZABZ module which contains an STM32L0 processor along with a Semtech SX1276 Radio. +The **Vision Shield with LoRa® technology** can extend our project connectivity by leveraging it LoRa® module for long-range communication in remote areas with a lack of internet access. Powered by the Murata CMWX1ZZABZ module which contains an STM32L0 processor along with a Semtech SX1276 Radio. -![LoRa® antenna connection](assets/antenna.png) +![Antenna connection for LoRa® connectivity](assets/antenna.png) -To test the LoRa® connectivity, first, connect the Vision Shield - LoRa® to the Portenta H7. Attach the LoRa® antenna to its respective connector. Now connect the USB-C® cable to the Portenta H7 and your computer. +To test the LoRa® connectivity, first, connect the Vision Shield with LoRa technology to the Portenta H7. Attach the antenna for LoRa connectivity to its respective connector. Now connect the USB-C® cable to the Portenta H7 and your computer. ***Follow this [guide](https://docs.arduino.cc/tutorials/portenta-vision-shield/things-network-openmv) to learn how to set up and create your __end device__ on The Things Network.*** Important hardware LoRa® configurations are listed below: -| **Setting** | **Compatibility** | -| :-----------------: | :---------------: | -| LoRaWAN MAC Version | V1.0.2 | -| Class | A or C | +| **Setting** | **Compatibility** | +|:-----------------------:|:-----------------:| +| LoRa®-based MAC Version | V1.0.2 | +| Class | A or C | -The following MicroPython script lets you connect to The Things Network using LoRaWAN® and send a `Hello World` message to it. +The following MicroPython script lets you connect to The Things Network using LoRa® technology and send a `Hello World` message to it. ```python from lora import * @@ -967,11 +967,11 @@ appEui = "*****************" # now called JoinEUI appKey = "*****************************" ``` -After configuring your credentials and frequency band, you can run the script. You must be in an area with LoRaWAN® coverage, if not, you should receive an alert from the code advising you to move near a window. +After configuring your credentials and frequency band, you can run the script. You must be in an area with LoRa®-based network coverage, if not, you should receive an alert from the code advising you to move near a window. -![LoRaWAN® uplink received on TTN](assets/lora.png) +![LoRa®-based network uplink received on TTN](assets/lora.png) -***You can set up your own LoRaWAN® network using our [LoRa® gateways](https://www.arduino.cc/pro/lora-gateways/)*** +***You can set up your own LoRa®-based network using our [LoRa® gateways](https://www.arduino.cc/pro/lora-gateways/)*** ## Support @@ -996,3 +996,7 @@ Please get in touch with our support team if you need personalized assistance or - [Contact us page](https://www.arduino.cc/en/contact-us/) +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. + diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tech-specs.yml b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tech-specs.yml index b146713afc..92066347a0 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tech-specs.yml +++ b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tech-specs.yml @@ -22,7 +22,7 @@ Connectivity (* Requires Arduino MKR board): Bluetooth® Wifi* 3G*NB-IoT* - LoRaWAN®* + LoRa® technology* Peripherals: Full-speed 12 Mbps USB Arm CryptoCell CC310 security subsystem diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/02.smart-irrigation-system/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/02.smart-irrigation-system/content.md index 4004602af2..d0a35f2e12 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/02.smart-irrigation-system/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/02.smart-irrigation-system/content.md @@ -536,4 +536,8 @@ Thanks to the Edge Control capabilities to connect to the Cloud and be remotely Since you already know how to develop a Smart Irrigation System with Arduino Edge Control and the MKR WiFi 1010, it is time for you to continue exploring all the capabilities of the Arduino Pro portfolio and integrating it into your professional setup. -You can extend the capabilities of your Edge Control-based system by adding different connectivity options, leveraging the [Arduino MKR family](https://store-usa.arduino.cc/collections/mkr-family) like LoRaWAN®, GSM, RS-485 or Ethernet. \ No newline at end of file +You can extend the capabilities of your Edge Control-based system by adding different connectivity options, leveraging the [Arduino MKR family](https://store-usa.arduino.cc/collections/mkr-family) like LoRa® technology, GSM, RS-485 or Ethernet. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/assets/Edge-Control_MKR_Codes.zip b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/assets/Edge-Control_MKR_Codes.zip index ffdff51f41..ee7bcd4ca0 100644 Binary files a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/assets/Edge-Control_MKR_Codes.zip and b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/assets/Edge-Control_MKR_Codes.zip differ diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/content.md index c9776cdcad..39f744866f 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/edge-control/tutorials/03.smart-irrigation-system-v2/content.md @@ -1,6 +1,6 @@ --- -title: 'LoRaWAN® Irrigation System Using Arduino® Edge Control' -description: "This application note describes how to control a four zones irrigation system using Edge Control and Arduino Cloud with LoRaWAN® connectivity." +title: 'LPWAN Irrigation System Using Arduino® Edge Control' +description: "This application note describes how to control a four zones irrigation system using Edge Control and Arduino Cloud with LoRa® connectivity." difficulty: intermediate tags: - Irrigation System @@ -10,7 +10,7 @@ tags: - Arduino Cloud - Agriculture - WisGate Lite - - LoRaWAN® + - LPWAN author: 'Christopher Mendez' libraries: - name: Arduino_EdgeControl @@ -41,16 +41,16 @@ Smart farming techniques are being implemented more and more due to the importan ![Application Note Overview. Each pot represents one individual irrigation zone capable of watering a crop field](assets/Thumbnail.png) -Implementing traditional wired communication infrastructure in remote areas can be expensive and time-consuming. LoRaWAN®, being a wireless technology, provides a cost-effective alternative, as it requires minimal infrastructure setup, reducing installation and maintenance costs. +Implementing traditional wired communication infrastructure in remote areas can be expensive and time-consuming. LoRa® technology, being a wireless technology, provides a cost-effective alternative, as it requires minimal infrastructure setup, reducing installation and maintenance costs. Arduino has you covered in these scenarios with its Pro solutions, including products designed to work in remote environments, supplying their power from renewable sources, and providing long-distance connectivity and low power consumption. ## Goals -The goal of this application note is to showcase a LoRaWAN® farming irrigation system that can be implemented on real agriculture fields using a combination of an Edge Control, an MKR WAN 1310, and the Arduino Cloud. The project's objectives are the following: +The goal of this application note is to showcase a LoRa® technology based farming irrigation system that can be implemented on real agriculture fields using a combination of an Edge Control, an MKR WAN 1310, and the Arduino Cloud. The project's objectives are the following: - Independently control four irrigation zones using latching valves. -- Leverage MKR WAN 1310 with LoRa® and a Wisgate (Lite or PRO) to communicate with Arduino Cloud. +- Leverage MKR WAN 1310 with LoRa® technology and a Wisgate (Lite or PRO) to communicate with Arduino Cloud. - Monitor soil moisture and decide whether to irrigate based on it. - Display the soil humidity level on the Edge Control Enclosure kit LCD. - Manually activate irrigation through Enclosure Kit built-in push button. @@ -134,7 +134,7 @@ The Edge Control is responsible for: The MKR WAN 1310 is responsible for: -- Providing Cloud connectivity using LoRaWAN®. +- Providing Cloud connectivity using LoRa® technology. - Reporting the values of the Edge Control sensors on the Cloud. The communication between both devices is done leveraging the I2C communication protocol. @@ -210,7 +210,7 @@ RunningMedian calibs{ calibsCount }; unsigned long previousMillis = 0; // will store last time the sensors were updated -const long interval = 180000; // interval of the LoRaWAN message (milliseconds) +const long interval = 180000; // interval of the LoRa message (milliseconds) // Variables for the water flow measurement volatile int irqCounts; @@ -396,7 +396,7 @@ void loop() { The Edge Control will check the number of button taps for the valve's manual control and handle the right action to do through the use of a switch case statement. Then, it will read the watermark sensors and periodically measure the battery voltage. -Every 3 minutes, the Edge Control will request the MKR WAN to send a LoRaWAN® message updating the sensors values in the Cloud. +Every 3 minutes, the Edge Control will request the MKR WAN to send a LoRa®-based network message updating the sensors values in the Cloud. Finally, in the loop function, we will check the valves states to control them and keep track of their active time. @@ -411,7 +411,7 @@ There are three headers included in the project code that handles some helper fu - `thingProperties.h` is automatically generated by the Arduino Cloud. However, if you are using an offline IDE, verify it is in the same directory as your sketch and includes all the Arduino Cloud variables. - `SensorValues.hpp` handles the shared variables between the Edge Control and the MKR WAN 1310 through I2C. -- `arduino_secrets.h` includes the LoRaWAN® credentials of your device. +- `arduino_secrets.h` includes the LoRa®-based network credentials of your device. ```arduino #include "arduino_secrets.h" @@ -427,7 +427,7 @@ There are three headers included in the project code that handles some helper fu unsigned long previousMillis = 0; const long interval = 3*60000; //180 second interval (3 minutes) ``` -We also define the I2C address of the MKR and the update interval for the LoRaWAN® messages. Due to the LoRaWAN® limitations, we shouldn't define "short" intervals. +We also define the I2C address of the MKR and the update interval for the LoRa®-based network messages. Due to the LoRa technology limitations, we shouldn't define "short" intervals. ```arduino /** @@ -521,15 +521,15 @@ The `uploadValues` function simply updates the Cloud variables with the ones rec ## Connectivity -![LoRaWAN® Gateways](assets/GATEWAY1.png) +![LoRa® Gateways](assets/GATEWAY1.png) -This project is using LoRaWAN®, which stands for Long Range Wide Area Network, and it is a low-power wireless communication protocol designed for connecting battery-operated devices to the internet over long distances. If you want to learn more about LoRa® and LoRaWAN® check this [guide](https://docs.arduino.cc/learn/communication/lorawan-101). +This project is using LoRa® technology, a long range wide area network protocol and it is a low-power wireless communication protocol designed for connecting battery-operated devices to the internet over long distances. If you want to learn more about LoRa technology, please check this [guide](https://docs.arduino.cc/learn/communication/lorawan-101). The MKR WAN 1310 will be the **end-device** encharged of connecting to The Things Network (TTN), which is the network server supported by the Arduino Cloud. Learn how to connect the MKR WAN 1310 to TTN using this [guide](https://docs.arduino.cc/tutorials/mkr-wan-1310/the-things-network). -After following the guide you will get two important keys that will be needed for the LoRaWAN® connectivity `APP_EUI` and `APP_KEY`, define them in the `arduino_secrets.h` header of your MKR code. +After following the guide you will get two important keys that will be needed for the LoRa® connectivity `APP_EUI` and `APP_KEY`, define them in the `arduino_secrets.h` header of your MKR code. -![LoRaWAN® network credentials](assets/CREDENTIALS.png) +![LoRa®-based network credentials](assets/CREDENTIALS.png) As a **gateway** we will be using the [WisGate Edge Lite 2](https://docs.arduino.cc/hardware/wisgate-edge-lite-2), which will provide long-range coverage and access to the network. Learn how to set up yours using this [guide](https://docs.arduino.cc/tutorials/wisgate-edge-lite-2/getting-started). @@ -569,11 +569,11 @@ Remember that the system is designed to be scalable; therefore, it is possible t ## Conclusion -In this application note, you have learned how to build a LoRaWAN® irrigation system to water your crops automatically or manually and monitor the crop's status remotely. Thanks to the soil moisture analysis, you can avoid irrigation when it's not necessary, saving water and avoiding over-irrigation or flooding problems. +In this application note, you have learned how to build a LoRa® technology based irrigation system to water your crops automatically or manually and monitor the crop's status remotely. Thanks to the soil moisture analysis, you can avoid irrigation when it's not necessary, saving water and avoiding over-irrigation or flooding problems. Arduino Edge Control allows you to easily implement this kind of agriculture systems ready for field deployment. Alongside MKR boards, it can get access to the network using the most suitable technology for your application. -In this project, LoRaWAN® was used leveraging its capabilities: this technology is perfect for remote deployments where there is no internet connection and for battery-powered devices because of its low energy consumption. +In this project, LPWAN was used leveraging its capabilities: this technology is perfect for remote deployments where there is no internet connection and for battery-powered devices because of its low energy consumption. Thanks to its capabilities of controlling different types of actuators and handling a vast variety of input sensors, the Edge Control is a great choice for developing robust and agriculture environment-proof solutions. @@ -585,3 +585,7 @@ We have a similar project using motorized ball valves, WiFi® connectivity and s You can extend the capabilities of your Edge Control-based system by adding different connectivity options, leveraging the Arduino MKR family like WiFi®, GSM, RS-485 or Ethernet. +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. + diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/features.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/features.md index f4914ce63e..e050795176 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/features.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/features.md @@ -1,19 +1,21 @@ -The **WisGate Edge Lite 2** gateway is a device with a high reliability that allows to set up home and small medium-sized industrial indoor LoRaWAN® applications with a high execution efficiency. +The **WisGate Edge Lite 2** gateway is a device with a high reliability that allows to set up home and small medium-sized industrial indoor LPWAN applications with a high execution efficiency. -It supports 8 LoRa® channels, multi backhaul with Ethernet, Wi-Fi®, and Cellular connectivity. +It supports 8 configurable LoRa® channels, multi backhaul with Ethernet, Wi-Fi® and Cellular connectivity. The gateway is powered by OpenWRT which allows to develop custom applications. +>LoRa® is a registered trademark of Semtech Corporation. + - 8 configurable channels. Wi-Fi, LTE and Ethernet. - Internal antenna for Wi-Fi, GPS, and LTE, external antenna for LoRa. + 8 configurable LoRa® channels. Wi-Fi, LTE and Ethernet. + Internal antenna for Wi-Fi, GPS, and LTE, external antenna for LoRa® connectivity. diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/product.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/product.md index 00bee28735..2b55942ed9 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/product.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/product.md @@ -11,7 +11,7 @@ certifications: [CE, UKCA] sku: [TXP00098, TXP00100, TXP00099] --- -The WisGate Edge Lite 2 gateway for LoRaWAN® embeds RAKwirelessTM technologies and allows you to set home and small medium-sized industrial indoor applications +The WisGate Edge Lite 2 gateway, featuring RAKwirelessTM technology, is designed for indoor LPWAN applications, supporting LoRa® technology for home and small-to-medium industrial environments. Different models (SKU) are compatibles with three radio frequencies adopted in different regions of the world: Europe, United States, Australia and New Zealand. diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tech-specs.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tech-specs.md index 296d24d637..9fe58b93c6 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tech-specs.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tech-specs.md @@ -1 +1 @@ -Here you will find the technical specifications for the Arduino® Wisgate Edge Lite 2 gateway for LoRaWAN®. \ No newline at end of file +Here you will find the technical specifications for the Arduino® WisGate Edge Lite 2, a gateway designed for LPWAN applications and compatible with LoRa® technology. \ No newline at end of file diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tutorials/getting-started/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tutorials/getting-started/content.md index 52cdb23992..3717da0296 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tutorials/getting-started/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-lite-2/tutorials/getting-started/content.md @@ -33,7 +33,7 @@ The goals of this article are: The package includes: -* LoRa® Gateway +* WisGate Edge Gateway (supports LoRa® technology) * PoE Injector (with its power cable, IEC) * Pole mounting mechanical pieces @@ -89,8 +89,8 @@ Fill the information: * Gateway ID: unique ID for your gateway inside the things network platform. * Gateway EUI: The EUI of your WisGate Gateway (Get it on the overview page on the WisGate dashboard) * Gateway name: Name of the Gateway on your TTN's profile -* Gateway Server Address: the Address of the LoRa® network (format: `wss://`) -* LoRaWAN® options, Frequency plan: select the recommended plan or the one that fits your project +* Gateway Server Address: the Address of the LoRa®-based network (format: `wss://`) +* LoRa® network options, Frequency plan: select the recommended plan or the one that fits your project Click the "Create gateway" button at the end of the page. @@ -144,4 +144,8 @@ Set up the gateway to be a Network Server and MQTT client to connect directly to ## Conclusion -In this tutorial you learned how to setup the LoRa® Gateway. \ No newline at end of file +In this tutorial you learned how to setup the LoRa® technology-based Gateway. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/features.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/features.md index a9608aa6f8..9a5a209626 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/features.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/features.md @@ -1,17 +1,19 @@ -The **WisGate Edge Pro** gateway is an industrial-graded device with high reliability and suits every requirements for an IoT commercial deployment. +The **WisGate Edge Pro** gateway is an industrial-grade device with high reliability, designed for IoT commercial deployments using LoRa® technology. -It supports 16 LoRaWAN® channels thanks to a Dual LoRaWAN® Concentrator, and multi backhaul connectivity via Ethernet, Wi-Fi®, and Cellular LTE. The design of its enclosure allows internal antennas for LTE, Wi-Fi, and GPS. +It supports 16 LoRa® channels thanks to dual LoRa® concentrators and offers multi-backhaul connectivity via Ethernet, Wi-Fi® and Cellular LTE. The enclosure design includes internal antennas for LTE, Wi-Fi and GPS. It is powered by OpenWRT which allows to develop custom applications. +>LoRa® is a registered trademark of Semtech Corporation. + - Dual LoRa® Concentrators with 16 channels and dual fiberglass 5dB external antennas. Wi-Fi, LTE and GPS with internal antennas. Ethernet with PoE Capabilities. + Dual LoRa® concentrators with 16 channels and dual fiberglass 5 dB external antennas. Wi-Fi®, LTE and GPS with internal antennas. Ethernet with PoE capabilities. diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/product.md b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/product.md index 0d1b3e009f..cb47bea64c 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/product.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/wisgate-edge-pro/product.md @@ -11,8 +11,8 @@ certifications: [CE, UKCA] sku: [TPX00095, TPX00096, TPX00097] --- -The WisGate Edge Pro gateway for LoRaWAN® embeds RAKWirelessTM technology and allows to set up professional applications. +The WisGate Edge Pro gateway, featuring RAKWirelessTM technology, is designed for professional applications using LoRa® technology. -Different models (SKU) are compatible with three radio frequencies adopted in different regions of the world: Europe, United States, Australia and New Zealand* +Different models (SKU) are compatible with three radio frequency bands adopted in different regions: Europe, United States, Australia and New Zealand*. >(*) The user is responsible for respecting the local regulations of the country of installation and use the model with the approved frequency spectrum only \ No newline at end of file diff --git a/content/learn/04.electronics/07.low-power/low-power.md b/content/learn/04.electronics/07.low-power/low-power.md index 8f3897ef6e..63370c5bb7 100644 --- a/content/learn/04.electronics/07.low-power/low-power.md +++ b/content/learn/04.electronics/07.low-power/low-power.md @@ -3,14 +3,14 @@ title: 'The Arduino Guide to Low Power Design' description: 'Learn the basics of low-power design using Arduino hardware and software.' tags: - Low Power - - LoRa® + - LoRa® Technology - Voltage Detection author: 'Taddy Chung, José Bagur' --- The objective of **Low Power** is to reduce the device’s power consumption by controlling its behavior to extend its operation lifetime. Electronic devices fed directly from a power source usually do not require the implementation of Low Power or similar techniques to extend their life. On the other hand, it is necessary to save its power consumption to expand its operation lifetime for the devices running from a power source such as batteries. -The present guide for achieving low power system are applicable for every Arduino boards. For example, [Arm Cortex-M0 32-bit SAMD21](https://content.arduino.cc/assets/mkr-microchip_samd21_family_full_datasheet-ds40001882d.pdf) processor based Arduino boards can take advantage of low-power features. The Arduino SAMD21 boards with wireless protocol with LoRaWAN® network capability, with module as [Murata CMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf) featured from [MKR WAN 1310](https://docs.arduino.cc/hardware/mkr-wan-1310), can be combined with low power features to operate for an extensive period. With advanced techniques, such tools as power source guide and self-discharge rates design applies to every Arduino boards for designing power efficient systems. You can check out [Arduino Documentation Hardware](https://docs.arduino.cc/) page to find out about Arduino boards. +The present guide for achieving low power system are applicable for every Arduino boards. For example, [Arm Cortex-M0 32-bit SAMD21](https://content.arduino.cc/assets/mkr-microchip_samd21_family_full_datasheet-ds40001882d.pdf) processor based Arduino boards can take advantage of low-power features. The Arduino SAMD21 boards with wireless protocol using LoRa® technology, with module as [Murata CMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf) featured from [MKR WAN 1310](https://docs.arduino.cc/hardware/mkr-wan-1310), can be combined with low power features to operate for an extensive period. With advanced techniques, such tools as power source guide and self-discharge rates design applies to every Arduino boards for designing power efficient systems. You can check out [Arduino Documentation Hardware](https://docs.arduino.cc/) page to find out about Arduino boards. ## Low Power Library @@ -28,8 +28,6 @@ To learn more about the Arduino IDE, follow the links below: - [Arduino IDE 1](https://docs.arduino.cc/software/ide-v1) - [Arduino IDE 2](https://docs.arduino.cc/software/ide-v2) - - ## Low-Power Design Techniques There are several different options to reduce the power consumption in microcontrollers: @@ -270,15 +268,15 @@ LowPower.detachAdcInterrupt(); Callback functions are to be used when the system wakes up from sleep state via configured interruption. In this function, and as an entire software architecture, usually it is a good practice to avoid using delay() and long running functions. This is to avoid what is called **Blocking Operation** and to be designed in **Non-Blocking Operation** fashion, which very helpful for this types of design cases. In this instances, this will help design power efficient system in parallel being a responsive system. -### LoRa Transmitter With Low Power Example +### Low Power Example Using LoRa® Technology Transmitter - Hardware Needed: MKR WAN 1300/1310 (On-Board Murata Module) -***Extended detail and example about LoRa® using MKR WAN 1310 with its Murata Module, please check [Send Data Using LoRa® with MKR WAN 1310](https://docs.arduino.cc/tutorials/mkr-wan-1310/lora-send-and-receive)*** +***For extended detail and example about LoRa® Technology using MKR WAN 1310 with its Murata Module, please [this documentation](https://docs.arduino.cc/tutorials/mkr-wan-1310/lora-send-and-receive)*** This example shows MKR WAN1300/1310 as a remote transmitter device that sends alive beacon status message periodically. This is to simulate a device broadcasting beacon data every certain amount of time and requires extensive operation lifetime. The receiver device will be stationary as reception tower. The remote transmitter device will have the SAMD21 go into sleep state, but also the On-Board Murata module to remove unnecessary power consumption. -***For more information on the LoRa library, please visit the [Arduino LoRa](https://github.com/sandeepmistry/arduino-LoRa) repository on GitHub.*** +***For more information on the `LoRa` library, please refer to [this library](https://github.com/sandeepmistry/arduino-LoRa) repository on GitHub.*** ```arduino // Low Power Library @@ -334,7 +332,7 @@ void GoToSleep(){ It is important to know that the Low Power task applies only to microcontroller. This means that external modules such as Murata module we used here, found on MKR WAN 1310 board, must be coded in the task separately to make the module go into sleep state. -***If external modules such as Murata (LoRa) Module and sensors are to be used, please remember to put into sleep state before making the MCU go into sleep. Otherwise the device will not go into complete sleep state and maximum power saving will not be possible. This includes turning off for example peripheral interfaces such as TWI and SPI.*** +***If external modules such as Murata (LPWAN) Module and sensors are to be used, please remember to put into sleep state before making the MCU go into sleep. Otherwise the device will not go into complete sleep state and maximum power saving will not be possible. This includes turning off for example peripheral interfaces such as TWI and SPI.*** ### Simple Low Voltage Detection Example @@ -695,4 +693,8 @@ void setup () void loop () { } ``` -***To read more about the Low Power systems topic In-Depth, you can check the following link: https://www.gammon.com.au/power*** \ No newline at end of file +***To read more about the Low Power systems topic In-Depth, you can check the following link: https://www.gammon.com.au/power*** + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/learn/05.communication/03.low-power-wide-area-networks-101/assets/hero.png b/content/learn/05.communication/03.low-power-wide-area-networks-101/assets/hero.png index 1831a52ee5..c03b95f0cc 100644 Binary files a/content/learn/05.communication/03.low-power-wide-area-networks-101/assets/hero.png and b/content/learn/05.communication/03.low-power-wide-area-networks-101/assets/hero.png differ diff --git a/content/learn/05.communication/03.low-power-wide-area-networks-101/low-power-wide-area-networks-101.md b/content/learn/05.communication/03.low-power-wide-area-networks-101/low-power-wide-area-networks-101.md index 6f13305f7a..c00cc44ec5 100644 --- a/content/learn/05.communication/03.low-power-wide-area-networks-101/low-power-wide-area-networks-101.md +++ b/content/learn/05.communication/03.low-power-wide-area-networks-101/low-power-wide-area-networks-101.md @@ -4,7 +4,7 @@ description: 'Learn the fundamentals of low-power wide-area networks, and what A tags: - LPWAN - Sigfox - - LoRaWAN® + - LoRa® Technology - LTE-M - NB-IoT author: 'José Bagur' @@ -22,17 +22,19 @@ The term **LPWAN**, which emerged in 2013, stands for low-power wide-area networ ## Types of LPWAN technologies -In recent years, **two main categories of LPWAN technologies** have emerged: **networks based on non-cellular based technologies and cellular-based networks**. These types of technologies can use **licensed** or **unlicensed** frequencies and use **proprietary** or **open standards**. Let’s talk about the major and most widely deployed LPWANs today: **Sigfox**, **LoRaWAN®**, **NB-IoT** and **LTE-M**. +In recent years, **two main categories of LPWAN technologies** have emerged: **networks based on non-cellular based technologies and cellular-based networks**. These types of technologies can use **licensed** or **unlicensed** frequencies and use **proprietary** or **open standards**. Let’s talk about the major and most widely deployed LPWANs today: **Sigfox**, **networks based on LoRa® Technology**, **NB-IoT** and **LTE-M**. -### Non-cellular-based technologies: Sigfox and LoRaWAN®. +### Non-cellular-based technologies: Sigfox and LoRa® Technology One of the most widely utilized LPWANs today is **Sigfox**. This proprietary ultra-narrowband LPWAN technology runs over a network in the 868MHz or 902MHz frequency bands, these frequency bands are unlicensed Industrial, Scientific, and Medical (ISM) frequency bands. This network can deliver messages over distances of 30 to 50 km in rural areas, 3 to 10 km in urban settings and up to 1,000 km in line-of-site applications. Its packet size is limited to 150 messages of 12 bytes per day, with downlink packets limited to four messages of 8 bytes per day. -**LoRa** is a physical layer technology that works in unlicensed ISM frequency bands. It´s based on the chirped spread spectrum (CSS) technique. LoRa is basically a single-hop technology, which relays the messages received from LoRa sensor nodes to a central server via gateways. The data transmission rate supported by Lo Ra varies from 300 bps to 50 kbps. To support LoRa on the Internet, The LoRa Alliance has developed **LoRaWAN®**, which includes network and upper layer functionalities. LoRaWAN® provides three classes of end devices to address the different requirements of a wide range of IoT applications. +**LoRa® Technology** is a physical layer protocol that operates in unlicensed ISM frequency bands. It is based on the chirped spread spectrum (CSS) technique. LoRa-enabled devices typically use single-hop communication to transmit data to gateways, which forward the messages to network infrastructure. The data transmission rate supported by LoRa Technology varies from 300 bps to 50 kbps. + +To enable networking capabilities for LoRa® Technology, various protocols have been developed to manage communication between devices and network infrastructure. These protocols define secure, long-range communication methods for different IoT applications, supporting multiple device classes to accommodate various operational requirements. ### Cellular-based technologies: LTE-M and NB-IoT -**LTE-M**, which stands for _Long Term Evolution for Machines_, and **NB-IoT**, which stands for _Narrowband Internet of Things_, are wireless telecommunications technologies standards developed by the _3rd Generation Partnership Project_ (3GPP), the international standards group responsible for all major mobile telecommunications standards, including the _Global System for Mobile Communications_ (GSM) standards and _Long Term Evolution_ (LTE) standards. Unlike Sigfox and LoRaWAN®, **LTE-M and NB-IoT are operated by wireless network providers**. +**LTE-M**, which stands for _Long Term Evolution for Machines_, and **NB-IoT**, which stands for _Narrowband Internet of Things_, are wireless telecommunications technologies standards developed by the _3rd Generation Partnership Project_ (3GPP), the international standards group responsible for all major mobile telecommunications standards, including the _Global System for Mobile Communications_ (GSM) standards and _Long Term Evolution_ (LTE) standards. Unlike Sigfox and networks based on LoRa® Technology, **LTE-M and NB-IoT are operated by wireless network providers**. **LTE-M** is compatible with existing LTE networks, it provides extended coverage comparable to LTE networks, coverage for M2M applications similar to 5G networks, and offers a seamless path towards 5G M2M solution. **LTE-M is focused on providing variable data rates and support for both real-time and non-real time applications**. It supports low latency applications, as well as deferred traffic applications that can operate with latencies in the range of a few seconds. It has low power requirements and supports operations ranging from low bandwidth to bandwidth as high as 1Mbps. LTE-M also supports devices with a very wide range of message sizes. @@ -57,11 +59,11 @@ Some examples of current LPWAN applications are the following: The Arduino's MKR family has some alternatives to offer in terms of connectivity to LPWANs: -### LoRaWAN® (MKR WAN 1300/1310) +### Networks using LoRa® Technology (MKR WAN 1300/1310) ![The MKR WAN 1310](assets/MKRWAN1310.png) -The [MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) is a development board for experimenting with either LoRa® or LoRaWAN®. +The [MKR WAN 1310](https://store.arduino.cc/mkr-wan-1310) is a development board for experimenting with LoRa® technology. It can easily connect to [The Things Network](https://www.thethingsnetwork.org/), a platform with LoRa® coverage all over the world. It can also be used for point-to-point connection, where you can easily set up communication between two MKR WAN boards. @@ -77,7 +79,7 @@ To access the [Murata CMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-m #### LoRa library -To easily set up communication between two MKR WAN 1310 boards, you can refer to the examples in the [LoRa](https://github.com/sandeepmistry/arduino-LoRa) library, credit to Sandeep Mistry. +To easily set up communication between two MKR WAN 1310 boards, you can refer to the examples in the [`LoRa`](https://github.com/sandeepmistry/arduino-LoRa) library, credit to Sandeep Mistry. #### Documentation @@ -139,3 +141,6 @@ To access the Sigfox transceiver [ATA8520](https://content.arduino.cc/assets/Ard You can visit the official documentation for this board at the [MKR FOX 1200 documentation page](/hardware/mkr-fox-1200). +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. diff --git a/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img02.png b/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img02.png index 5ebeab01fc..f1871f43f1 100644 Binary files a/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img02.png and b/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img02.png differ diff --git a/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img03.png b/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img03.png index a206ec1cf4..08c68cf992 100644 Binary files a/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img03.png and b/content/learn/05.communication/05.lorawan-101/assets/lorawan-101_img03.png differ diff --git a/content/learn/05.communication/05.lorawan-101/lorawan-101.md b/content/learn/05.communication/05.lorawan-101/lorawan-101.md index db2797a41e..59601124fc 100644 --- a/content/learn/05.communication/05.lorawan-101/lorawan-101.md +++ b/content/learn/05.communication/05.lorawan-101/lorawan-101.md @@ -1,9 +1,7 @@ --- -title: 'The Arduino Guide to LoRa® and LoRaWAN®' -description: 'Learn the basics of LoRa® and LoRaWAN® and how to use them with Arduino hardware and software.' -tags: - - LoRa® - - LoRaWAN® +title: 'The Arduino Guide to LoRa® and LPWAN Technologies' +description: 'Learn the basics of LoRa® technology and how to use it with Arduino hardware and software.' +tags: - MKR WAN 1310 author: 'José Bagur, Taddy Chung' --- @@ -12,11 +10,11 @@ The Internet of Things (IoT) is often referred to as a collection of objects con ***By 2025, there will be more than 25 billion IoT devices connected to the Internet.*** -Many of the existing IoT devices will be connected to the Internet using short-range wireless networks such as Wi-Fi®, Bluetooth®, ZigBee, Z-Wave®, etc. Cellular connections using networks such as 2G, 3G, and 4G will also connect IoT devices to the Internet. Still, these **short and medium-range wireless networks are not always suitable for IoT devices** since they were developed for applications where power consumption and battery life are not significant issues. **IoT devices usually have low-power consumption and send and receive low amounts of data**. +Many of the existing IoT devices will be connected to the Internet using short-range wireless networks such as Wi-Fi®, Bluetooth®, ZigBee, Z-Wave®, etc. Cellular connections using networks such as 2G, 3G, and 4G will also connect IoT devices to the Internet. Still, these **short and medium-range wireless networks are not always suitable for IoT devices** since they were developed for applications where power consumption and battery life are not significant issues. **IoT devices usually have low-power consumption and send and receive low amounts of data**. -## Low-Power Wide Area Networks +## Low-Power Wide Area Networks (LPWANs) -**Low-Power Wide Area Networks** (LPWAN) is a group of wireless networks technologies well suited to the specific needs of IoT devices: **low-bandwidth** and **low-power** devices, usually battery-powered. This type of networks provide **low-bit rates** over **long ranges** with a **low-power** consumption. LPWAN's can accommodate data packets sizes from 10 bytes to 1 kB at uplink speeds up to 200 kbps; long-range connectivity varies from 2 to 1,000 km depending on the network technology. Most LPWAN's technologies have a **star topology**; this means that each device connects directly to a central access point. +**Low-Power Wide Area Networks** (LPWANs) is a group of wireless network technologies well suited to the specific needs of IoT devices: **low-bandwidth** and **low-power** devices, usually battery-powered. These types of networks provide **low-bit rates** over **long ranges** with **low-power** consumption. LPWANs can accommodate data packet sizes from 10 bytes to 1 kB at uplink speeds up to 200 kbps; long-range connectivity varies from 2 to 1,000 km depending on the network technology. Most LPWAN technologies have a **star topology**; this means that each device connects directly to a central access point. Some of the important use cases for LPWAN's include the following applications: @@ -25,35 +23,33 @@ Some of the important use cases for LPWAN's include the following applications: - **Smart grids**: electricity, water, and gas metering. - **Smart agriculture**: land condition monitoring, animal tracking, geofencing. -***If you want to read more about LPWAN's, check out [this article](/learn/communication/low-power-wide-area-networks-101) from the Learn section.*** +***If you want to read more about LPWANs, check out [this article](/learn/communication/low-power-wide-area-networks-101) from the Learn section.*** -Several LPWAN technologies use **licensed** or **unlicensed frequencies** and **proprietary** or **open** specifications. **LoRa®** and its Media Access Control (MAC) layer protocol implementation, **LoRaWAN®**, is currently one of the existing LPWAN gaining the most traction to support IoT devices and services. +Several LPWAN technologies use **licensed** or **unlicensed frequencies** and **proprietary** or **open** specifications. **LoRa®** and its Media Access Control (MAC) layer protocol implementation is one of the LPWAN technologies gaining traction to support IoT devices and services. ![Bandwidth vs. range of short distance, cellullar and LPWA networks. Image credits: The Things Network.](assets/lorawan-101_img01.png) -## LoRa® and LoRaWAN® +## LoRa® Technology -### What are LoRa® and LoRaWAN®? +### What is LoRa® Technology? -**LoRa®** is a **wireless modulation technique** derived from **Chirp Spread Spectrum** (CSS) technology. CSS uses wideband linear frequency modulated chirp pulses to encode information. LoRa® can operate on the following license-free sub-gigahertz ISM (Industrial, Scientific, and Medical) bands: **433 MHz**, **868 MHz**, and **915 MHz**. ISM bands are internationally reserved for industrial, scientific and, medical uses. +**LoRa® Technology** is a **wireless modulation technique** derived from **Chirp Spread Spectrum** (CSS) technology. CSS uses wideband linear frequency modulated chirp pulses to encode information. It can operate on the following license-free sub-gigahertz ISM (Industrial, Scientific, and Medical) bands: **433 MHz**, **868 MHz** and **915 MHz**. ISM bands are internationally reserved for industrial, scientific and medical uses. -***LoRa® modulation technique was invented in 2010 by the French startup Cycleo; then, it was acquired in 2012 by Semtech.*** +***The Long Range modulation technique was invented in 2010 by the French startup Cycleo and was later acquired in 2012 by Semtech.*** -Based on LoRa®, the **LoRaWAN®** (LoRa for Wide Area Networks) specification extended the LoRa® physical communication layer into the Internet by adding a **MAC layer**. The LoRaWAN® specification is a software layer that defines how devices must use the LoRa, for example, when they transmit or receive messages. The LoRaWAN specification is open-source; it has been supported and maintained by the LoRa Alliance® since 2015. +LoRa® technology is widely used in LPWAN deployments for applications requiring long-distance connectivity with minimal power consumption. -***The LoRa Alliance® is an open, nonprofit organization that collaborates and shares experiences to promote and drive the success of the LoRaWAN® standard as the leading open global standard for secure IoT LPWAN connectivity.*** +### LoRa® Network Architecture -### LoRaWAN® Network Architecture +A typical network using LoRa® technology consists of the following essential parts: **end devices** (usually sensors), a base station or **gateway**, a **network server** and an **operations support system (OSS)** for provisioning and managing the network. -A typical LoRaWAN® network architecture includes the following essential parts: **end-devices** (usually sensors), a base station or **gateway**, also known as Long Range Relay (LRR), a **network server** also known as Long Range Controller (LRC), and the **Operation Support System** (OSS) for provisioning and management of the network. +![Typical LoRa® network architecture example. Image credits: The Things Network.](assets/lorawan-101_img02.png) -![Typical LoRaWAN® network architecture example. Image credits: The Things Network.](assets/lorawan-101_img02.png) +From the image above, notice there is a fundamental difference between a network server and a gateway. The **network server** manages message routing, while **gateways** function as relays that forward data between end devices and the server. LoRa®-based networks can be **public or private**, depending on the deployment needs. -From the image above, notice there is a fundamental difference between a network server and a gateway. The **network server** controls the virtualized MAC layer of the LoRaWAN® network while **gateways** are devices pre-integrated with the network server to ease the LPWAN rollout and provisioning. LoRaWAN® network servers and gateways access can be public or private. +***[The Things Network (TTN)](https://www.thethingsnetwork.org/) is a crowdsourced, open, and decentralized LoRa®-based network server. This network is a great way to start testing devices, applications, integrations and get familiar with LoRa. To connect to TTN, you will need to be in the range of a gateway. Check the [world map](https://www.thethingsnetwork.org/map) to see if your local community already has a gateway installed; if not, consider installing one!*** -***[The Things Network (TTN)](https://www.thethingsnetwork.org/) is a crowdsourced, open, and decentralized LoRaWAN® network server. This network is a great way to start testing devices, applications, integrations and get familiar with LoRaWAN®. To connect to TTN, you will need to be in the range of a gateway. Check the [world map](https://www.thethingsnetwork.org/map) to see if your local community already has a gateway installed; if not, consider installing one!*** - -LoRaWAN® networks are usually deployed in a **star-of-stars topology**; this means that **gateways manage data between end-devices and a network server**. Gateways are connected to the central network server via the Internet, while end-devices use LoRa® to send and receive data to and from the gateways; end-devices are not exclusively tied to a single gateway, end-devices broadcast information to all the gateways in range. Communication in LoRaWAN® networks is natively **bi-directional**, although uplink communication between end-devices and the central network server is expected to be predominant in the network. +LoRa®-based networks are usually deployed in a **star-of-stars topology**; this means that **gateways manage data between end-devices and a network server**. Gateways are connected to the central network server via the Internet, while end-devices use LoRa to send and receive data to and from the gateways; end-devices are not exclusively tied to a single gateway, end-devices broadcast information to all the gateways in range. Communication in LoRa-based networks is natively **bi-directional**, although uplink communication between end-devices and the central network server is expected to be predominant in the network. ***Star networks topologies provide the best relationship between long-range communications, the number of gateways or base stations in the network, end-devices power consumption, and battery life.*** @@ -64,11 +60,11 @@ Star networks present several advantages compared to other network topologies: ### Data Rates -Communication between end-devices and gateways in LoRaWAN® networks is spread out on different **frequency channels** and **data rates** (communications using different data rates do not interfere with each other). +Communication between end-devices and gateways in LoRa®-based networks is spread out on different **frequency channels** and **data rates** (communications using different data rates do not interfere with each other). -***LoRa® supports data rates ranging from 300 bps to 5 kbps for a 125 kHz bandwidth.*** +***LoRa® technology supports data rates ranging from 300 bps to 5 kbps for a 125 kHz bandwidth.*** -To maximize the battery life of each end-device and the overall capacity available through the network, LoRaWAN® uses an **Adaptive Data Rate** (ADR) mechanism for **optimizing data rates, airtime, and power consumption**. ADR controls the following transmission parameters on end-devices: +To maximize the battery life of each end-device and the overall capacity available through the network, LoRa® technology uses an **Adaptive Data Rate** (ADR) mechanism for **optimizing data rates, airtime, and power consumption**. ADR controls the following transmission parameters on end-devices: - **Spreading factor**: the **speed of data transmission**. Lower spreading factors mean a higher data transmission rate. - **Bandwidth**: the **amount of data that can be transmitted** from one point to another within the network. @@ -94,25 +90,25 @@ Also, local regulations must be respected, for example: - In the EU868 band, the end-device must respect the maximum transmit duty cycle relative to the sub-band used and local regulations (1% for end-devices). - In the US915 band, the end-device must respect the maximum transmit duration (or dwell time) relative to the sub-band used and local regulations (400ms). -![LoRaWAN® network layers. Image credits: Semtech.](assets/lorawan-101_img03.png) +![LoRa®-based network layers. Image credits: Semtech.](assets/lorawan-101_img03.png) ### Regional Parameters -The **LoRaWAN® Regional Parameters specification** is a companion to the LoRaWAN® network layer specification. While the LoRaWAN® network layer specification defines the air interface between a compliant end-device (sensor, actuator, tracker, etc.) and a compliant network core, the LoRaWAN® Regional Parameters specification defines the **adaptation of the LoRaWAN® network layer specification to comply with the various regulations enforced throughout the world on the use of various frequency bands of the unlicensed spectrum which are available**. +The **LoRa® technology Regional Parameters specification** is a companion to the LoRa-based network layer specification. While the LoRa-based network layer specification defines the air interface between a compliant end-device (sensor, actuator, tracker, etc.) and a compliant network core, the LoRa technology Regional Parameters specification defines the **adaptation of the LoRa-based network layer specification to comply with the various regulations enforced throughout the world on the use of various frequency bands of the unlicensed spectrum which are available**. -Also, the LoRaWAN® Regional Parameters specification documents the **physical layer configurations required for the compliant operation of LoRaWAN® Link Layer radios** using various radio frequency modulation techniques. +Also, the LoRa® technology Regional Parameters specification documents the **physical layer configurations required for the compliant operation of LoRa technology Link Layer radios** using various radio frequency modulation techniques. -***The idea behind the LoRaWAN® Regional Parameters specification is to create the smallest number of regional channel plans covering the largest possible number of regulatory regions. With this, complexity is decreased to implementers as well as the certification cost (end-device certification is enumerated by network layer, Regional Parameters and channel plan revision).*** +***The idea behind the LoRa® technology Regional Parameters specification is to create the smallest number of regional channel plans covering the largest possible number of regulatory regions. With this, complexity is decreased to implementers as well as the certification cost (end-device certification is enumerated by network layer, Regional Parameters and channel plan revision).*** -LoRaWAN® Regional Parameters specifications do not specify everything. They only cover a region by specifying the common denominator. For example, the LoRaWAN® Regional Parameters for Asia only specify a common subset of channels, but there are variations between regulations in Asian countries. Furthermore, each network server, for example TTN, is free to select additional parameters, such as additional emission channels. +LoRa® technology Regional Parameters specifications do not specify everything. They only cover a region by specifying the common denominator. For example, the LoRa technology Regional Parameters for Asia only specify a common subset of channels, but there are variations between regulations in Asian countries. Furthermore, each network server, for example TTN, is free to select additional parameters, such as additional emission channels. -For more information, you can read the RP002-1.0.2 LoRaWAN® Regional Parameters document [here](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf), we also have a more detailed tutorial about LoRaWAN® Regional Parameters and Arduino hardware; the tutorial can be found here [here](https://docs.arduino.cc/tutorials/mkr-wan-1310/lorawan-regional-parameters) +For more information, you can read the RP002-1.0.2 LoRa® technology Regional Parameters document [here](https://lora-alliance.org/wp-content/uploads/2020/11/RP_2-1.0.2.pdf), we also have a more detailed tutorial about LoRa technology Regional Parameters and Arduino hardware; the tutorial can be found here [here](https://docs.arduino.cc/tutorials/mkr-wan-1310/lorawan-regional-parameters) ### Classes -The LoRaWAN® specification has **three** different communication profiles between devices and applications: **Class A**, **Class B**, and **Class C**. Each class serves different application needs and has optimized requirements for specific purposes. The main difference between the three classes is latency and power consumption; end-devices can always send uplinks when needed, but its class will determine when to receive downlinks. +The LoRa® technology specification has **three** different communication profiles between devices and applications: **Class A**, **Class B**, and **Class C**. Each class serves different application needs and has optimized requirements for specific purposes. The main difference between the three classes is latency and power consumption; end-devices can always send uplinks when needed, but its class will determine when to receive downlinks. -***All LoRaWAN devices must implement Class A; Class B, and Class C are extensions of Class A profile.*** +***All network devices using LoRa® technology must implement Class A; Class B, and Class C are extensions of Class A profile.*** #### Class A: "Aloha" @@ -134,35 +130,35 @@ Class C communication profile is used in applications with enough power availabl ### Authentication and Security -Authentication and security are also important in LoRaWAN® networks. Any LoRaWAN® network has a baseline authentication and security framework based on the AES 128 encryption scheme. Compared to other LPWAN's, which rely on a single key for authentication and encryption, the LoRaWAN® framework separates both. Authentication and integrity control use a **network session key** (NwkSKey) while user data encryption uses an **application session key** (AppSKey). +Authentication and security are also important in LoRa®-based networks. Any LoRa-based network has a baseline authentication and security framework based on the AES 128 encryption scheme. Compared to other LPWAN's, which rely on a single key for authentication and encryption, the LoRa technology framework separates both. Authentication and integrity control use a **network session key** (NwkSKey) while user data encryption uses an **application session key** (AppSKey). ***NwkSKey and AppSKey are AES-128 root keys specific to the end-device, end-devices manufacturers, or application owners assigned them.*** -LoRaWAN® supports two authentication and activation methods: **Over-The-Air-Activation** (OTAA) and **Activation by Personalization** (ABP). +LoRa® technology supports two authentication and activation methods: **Over-The-Air-Activation** (OTAA) and **Activation by Personalization** (ABP). -- **Over-The-Air Activation (OTAA)**: In this method, end-devices are not initialized for any particular network; they send a JOIN request to a specific LoRaWAN® network and then receive a device address and an authorization token from which session keys are derived; NwkSKey and AppSKey are derived during this procedure from a root AppKey pre-provisioned in the end-devices by its manufacturer. +- **Over-The-Air Activation (OTAA)**: In this method, end-devices are not initialized for any particular network; they send a JOIN request to a specific LoRa®-based network and then receive a device address and an authorization token from which session keys are derived; NwkSKey and AppSKey are derived during this procedure from a root AppKey pre-provisioned in the end-devices by its manufacturer. ![Over-The-Air activation process. Image credits: Heath Raftery.](assets/lorawan-101_img08.png) -- **Activation by Personalization (ABP)**: In this method, end-devices are personalized to work with a given LoRaWAN® network. End-devices are pre-provisioned with the NwkSKey and AppSKey and the 32-bits device network address. +- **Activation by Personalization (ABP)**: In this method, end-devices are personalized to work with a given LoRa®-based network. End-devices are pre-provisioned with the NwkSKey and AppSKey and the 32-bits device network address. ![Activation by Personalization process. Image credits: Heath Raftery.](assets/lorawan-101_img09.png) ***The recommended authentication and activation method is OTAA since it provides a high level of security; ABP method should be used only for specific situations.*** -## Arduino® and LoRa® +## Arduino® and LoRa® Technology Arduino® brings LoRa® connectivity to your projects with several boards, addons and libraries. ### Arduino® Boards with LoRa® Connectivity -The MKR WAN [1300](https://store.arduino.cc/products/arduino-mkr-wan-1300-lora-connectivity) and [1310](https://store.arduino.cc/products/arduino-mkr-wan-1310) boards provide you with a practical and cost-effective solution to applications that require LoRa® connectivity and low-power consumption. The MKR WAN 1300 and 1310 boards are based on a [SAMD21 microcontroller](https://content.arduino.cc/assets/mkr-microchip_samd21_family_full_datasheet-ds40001882d.pdf) from Microchip®; they also features a [CMCMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf) module from Murata® for LoRa® connectivity, the [ATECC508](https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/20005928A.pdf) cryptoauthentication device for security, and a 2MB SPI Flash memory for onboard storage. +The MKR WAN [1300](https://store.arduino.cc/products/arduino-mkr-wan-1300-lora-connectivity) and [1310](https://store.arduino.cc/products/arduino-mkr-wan-1310) boards provide you with a practical and cost-effective solution to applications that require LoRa® connectivity and low-power consumption. The MKR WAN 1300 and 1310 boards are based on a [SAMD21 microcontroller](https://content.arduino.cc/assets/mkr-microchip_samd21_family_full_datasheet-ds40001882d.pdf) from Microchip®; they also features a [CMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf) module from Murata® for LoRa connectivity, the [ATECC508](https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/20005928A.pdf) cryptoauthentication device for security, and a 2MB SPI Flash memory for onboard storage. ![The Arduino® MKR WAN 1310 board.](assets/lorawan-101_img10.png) -PRO hardware also has LoRa® connectivity. The Arduino® [Portenta H7](https://store.arduino.cc/collections/boards/products/portenta-h7) board can have LoRa® connectivity with the [Portenta Vision Shield - LoRa](https://store.arduino.cc/products/arduino-portenta-vision-shield-lora%C2%AE); this addon board also features a [CMCMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf?_gl=1*54znn6*_ga*NzQ5Mzk2MDcwLjE2MjU2MDQ2MjA.*_ga_NEXN8H46L5*MTY0MDAzOTY0Ny4yNTIuMS4xNjQwMDM5NzQ2LjA.) module from Murata® for LoRa® connectivity, the same module present in the MKR 1300 and 1310 boards. +PRO hardware also has LoRa® connectivity. The Arduino® [Portenta H7](https://store.arduino.cc/collections/boards/products/portenta-h7) board can have LoRa connectivity with the [Portenta Vision Shield with LoRa® technology](https://store.arduino.cc/products/arduino-portenta-vision-shield-lora%C2%AE); this addon board also features a [CMWX1ZZABZ](https://content.arduino.cc/assets/mkrwan1310-murata_lora_module-type_abz.pdf?_gl=1*54znn6*_ga*NzQ5Mzk2MDcwLjE2MjU2MDQ2MjA.*_ga_NEXN8H46L5*MTY0MDAzOTY0Ny4yNTIuMS4xNjQwMDM5NzQ2LjA.) module from Murata® for LoRa connectivity, the same module present in the MKR 1300 and 1310 boards. -![The Arduino Portenta Vision Shield - LoRa.](assets/lorawan-101_img11.png) +![Portenta Vision Shield with LoRa® technology](assets/lorawan-101_img11.png) The Arduino® [Edge Control](https://store.arduino.cc/products/arduino-edge-control), a remote monitoring and control solution optimized for outdoor environments, can expand its wireless connectivity capabilities by adding an MKR WAN 1300 or 1310 board. Edge Control can be positioned anywhere and is well suited for smart agriculture and other applications that require intelligent control in remote locations. @@ -170,7 +166,7 @@ The Arduino® [Edge Control](https://store.arduino.cc/products/arduino-edge-cont ### Arduino® Libraries for LoRa® Connectivity -You can use several Arduino libraries with the CMCMWX1ZZABZ LoRa® module from Murata®; we recommend two: The [MKRWAN library](https://github.com/arduino-libraries/MKRWAN), developed by Arduino, and the [Arduino LoRa](https://github.com/sandeepmistry/arduino-LoRa) library, developed by Sandeep Mistry. The MKRWAN and the Arduino LoRa libraries provide you the APIs to communicate with LoRa® and LoRaWAN networks®. +You can use several Arduino libraries with the CMWX1ZZABZ LoRa® module from Murata®; we recommend two: The [MKRWAN library](https://github.com/arduino-libraries/MKRWAN), developed by Arduino, and the [`Arduino LoRa`](https://github.com/sandeepmistry/arduino-LoRa) library, developed by Sandeep Mistry. The MKRWAN and the Arduino `LoRa` libraries provide you the APIs to communicate with networks that support LoRa technology. You can use both libraries in the Arduino IDE, [online](https://store.arduino.cc/digital/create) and [offline](https://www.arduino.cc/en/software). If you are using the online IDE, you don't need to do anything, both libraries are already installed and ready to be used. If you are using the offline IDE, you must install the libraries manually. Installing libraries can be done easily by navigating to **Tools > Manage Libraries...** and then look for **MKRWAN** library by Arduino and **LoRa** by Sandeep Mistry; **remember to install the latest version of the libraries**. @@ -178,7 +174,7 @@ You can use both libraries in the Arduino IDE, [online](https://store.arduino.cc ### Example: Sending and Receiving Data to a Network Server -Using Arduino® hardware and software to communicate with LoRa® and LoRaWAN® networks is simple; let's check out an example. This example uses an MKR WAN 1310 board and the MKRWAN library to send data to a LoRaWAN® network, in this case, TTN. The circuit for this example is shown in the image below: +Using Arduino hardware and software to communicate with LoRa®-based networks is simple; let's check out an example. This example uses an MKR WAN 1310 board and the MKRWAN library to send data to a LoRa-based networks, in this case, TTN. The circuit for this example is shown in the image below: ![Circuit used in the example.](assets/lorawan-101_img13.png) @@ -188,7 +184,7 @@ Once your device is registered on TTN, you can start sending and receiving data ```arduino /* - Send and receive data from a LoRaWAN network + Send and receive data from a LoRa®-based network This sketch demonstrates how to send and receive data with the MKR WAN 1300/1310 board. This example code is in the public domain. */ @@ -294,9 +290,12 @@ Check out more detailed tutorials we have about sending data between a MKR WAN b ## Further Reading and Resources -LoRa® and LoRaWAN® are pretty extensive but exciting topics to study. If you want to learn more about these technologies, check out the following links: +LoRa® technology is pretty extensive but exciting topic to study. If you want to learn more about these technologies, check out the following links: -- [The LoRa Alliance® Resource Hub](https://lora-alliance.org/resource-hub/). Here you can access LoRaWAN® technical documents and Whitepapers from The LoRa Alliance®. - [LoRa Developer Portal from Semtech](https://lora-alliance.org/resource-hub/). Here you can find technical papers and user guides as well as specifications and datasheets from Semtech. -- [The Things Network documentation](https://www.thethingsnetwork.org/docs/). Here you can learn all about LoRaWAN® and The Things Network! -- [The Things Academy online course in Udemy](https://www.udemy.com/course/lorawan-fundamentals/). A free online course where you'll learn all about LoRa® and LoRaWAN®, and get ready to start building your own Low Power Wide Area Network applications. \ No newline at end of file +- [The Things Network documentation](https://www.thethingsnetwork.org/docs/). Here you can learn all about LoRa® technology and The Things Network! +- [The Things Academy online course in Udemy](https://www.udemy.com/course/lorawan-fundamentals/). A free online course where you'll learn all about LoRa® technology, and get ready to start building your own Low Power Wide Area Network applications. + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/retired/03.kits/pro-gateway/content.md b/content/retired/03.kits/pro-gateway/content.md index 9bca569f1c..5304d29f41 100644 --- a/content/retired/03.kits/pro-gateway/content.md +++ b/content/retired/03.kits/pro-gateway/content.md @@ -9,14 +9,14 @@ author: 'Jorge Trujillo Román' ## Description -The gateway offers up to 8 LoRa® Channels in the 868Mhz frequency allowing it to receive up to 8 LoRa® packets simultaneously making it the ideal device to use in **LoRaWAN® gateways applications**. +The gateway supports up to 8 LoRa® Channels in the 868MHz frequency band, allowing it to receive multiple LoRa® packets simultaneously. It is designed around the SX1301 by Semtech, which enables robust connections with a large number of wireless endpoints over extended distances. -It is designed around the SX1301 from Semtech, which enables robust connection between the gateway and a massive amount of wireless end-points spread over a very wide range of distances. -It has the Listen Before Talk capability, and when enabled, the device monitors channels continuously and transmits only if the channel is free. +The device features *Listen Before Talk (LBT)* capability, meaning it can monitor channels continuously and transmit only when the channel is free. It's the perfect companion for the Arduino MKR WAN 1300. Installation, provisioning and remote management of the Gateway are made incredibly simple through the Arduino Cloud platform. -This gateway enables people to leverage the LoRa® connectivity in many use cases: + +This gateway enables LoRa®-based communication in various use cases, such as: - Automated Meter Reading - Environmental Monitor @@ -32,9 +32,9 @@ The network server and the packet forwarder running on the Arduino Cloud platfor ## Getting Started -You can follow the [Arduino Pro Gateway Assembly](https://docs.arduino.cc/tutorials/generic/lora-gateway-assembly) to learn about how to assemble your Arduino Pro Gateway. +Follow the [Arduino Pro Gateway Assembly](https://docs.arduino.cc/tutorials/generic/lora-gateway-assembly) tutorial to assemble your Arduino Pro Gateway. -If you have already set up your Pro Gateway, you can go directly to the [setup page](https://create.arduino.cc/getting-started/loragw/welcome) to connect your LoRaWAN® devices to the Arduino Device Manager. +If your Pro Gateway is already set up, you can proceed to the [setup page](https://create.arduino.cc/getting-started/loragw/welcome) for further configuration. ### Datasheet You can follow the next link to [download the datasheet](https://content.arduino.cc/assets/AKX00016-datasheet.pdf). @@ -42,4 +42,8 @@ You can follow the next link to [download the datasheet](https://content.arduino ### Need Help? * On the Software [on the Arduino Forum](https://forum.arduino.cc/index.php?board=86.0) -* On the Product itself through [our Customer Support](https://support.arduino.cc/hc) \ No newline at end of file +* On the Product itself through [our Customer Support](https://support.arduino.cc/hc) + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/tutorials/generic/lora-gateway-assembly/lora-gateway-assembly.md b/content/tutorials/generic/lora-gateway-assembly/lora-gateway-assembly.md index c7ae971652..50aa4be9da 100644 --- a/content/tutorials/generic/lora-gateway-assembly/lora-gateway-assembly.md +++ b/content/tutorials/generic/lora-gateway-assembly/lora-gateway-assembly.md @@ -2,10 +2,10 @@ title: 'Arduino Pro Gateway Assembly' author: 'Arduino' description: 'Learn how to assemble your Arduino Pro Gateway.' -tags: [LoRa, Gateway] +tags: [LoRa®, Gateway] --- -In this page we are going to give you all the information needed to assemble your Arduino Pro Gateway LoRa Connectivity Kit. We will guide you through the process needed to have a device fully assembled and ready to be configured on the software and network side as documented in the [Arduino Pro Gateway Setup](https://create.arduino.cc/getting-started/loragw/welcome). +In this page we are going to give you all the information needed to assemble your Arduino Pro Gateway LoRa® Connectivity Kit. We will guide you through the process needed to have a device fully assembled and ready to be configured on the software and network side as documented in the [Arduino Pro Gateway Setup](https://create.arduino.cc/getting-started/loragw/welcome). ## Hardware list @@ -15,7 +15,7 @@ In the box you have several pieces and it is important to locate them all before - Aluminum enclosure - Raspberry Pi 3 model B+ - Arduino Radio Module Adapter -- LoRa Radio module +- LoRa® Radio module - Fan - Micro UFL to SMA Pigtail - SMA Antenna @@ -27,7 +27,7 @@ In the box you have several pieces and it is important to locate them all before ## Preliminary operations -The LoRa Radio module has a label on top that contains some very important numbers. Take a picture of it or take note on paper of the codes because they will be used to register and activate your gateway. The components are sensitive to static electricity and we strongly suggest that you properly earth yourself before you touch them, keeping the grounding connection for all the assembly process. +The LoRa® Radio module has a label on top that contains some very important numbers. Take a picture of it or take note on paper of the codes because they will be used to register and activate your gateway. The components are sensitive to static electricity and we strongly suggest that you properly earth yourself before you touch them, keeping the grounding connection for all the assembly process. ## Assembly @@ -63,8 +63,12 @@ Now it is time to connect the external antenna to its connector, as in picture 5 Connect the Ethernet cable to your wired internet access. -Connect the Power Adapter to a plug that won’t be disconnected easily from the mains because any power interruption will require a reboot of the Arduino Pro Gateway LoRa Connectivity and may disrupt your LoRa network. +Connect the Power Adapter to a plug that won’t be disconnected easily from the mains because any power interruption will require a reboot of the Arduino Pro Gateway LoRa® Connectivity and may disrupt your LoRa® technology-based network. ![Step 6 out 6.](assets/picture_6.jpg) -You should hear the fan and see some LEDs flashing inside. Everything is now ready to proceed to the [Arduino Pro Gateway Setup](https://create.arduino.cc/getting-started/loragw/welcome). \ No newline at end of file +You should hear the fan and see some LEDs flashing inside. Everything is now ready to proceed to the [Arduino Pro Gateway Setup](https://create.arduino.cc/getting-started/loragw/welcome). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/content/tutorials/generic/pro-smart-agriculture-kit/pro-smart-agriculture-kit.md b/content/tutorials/generic/pro-smart-agriculture-kit/pro-smart-agriculture-kit.md index 4dba15e2ab..59374b411f 100644 --- a/content/tutorials/generic/pro-smart-agriculture-kit/pro-smart-agriculture-kit.md +++ b/content/tutorials/generic/pro-smart-agriculture-kit/pro-smart-agriculture-kit.md @@ -73,11 +73,11 @@ Additionally, you may need the following accessories: If you want to learn more about the technologies of the kit, we propose the following experiences: -| Experience | Edge Control | MKR WAN 1310 | MKR WiFi 1010 | WisGate | -|:-----------------------------------------------------------------------------------------------------------------------------------:|:------------:|:------------:|:-------------:|:-------:| -| [Connecting and Controlling a Motorized Ball Valve](https://docs.arduino.cc/tutorials/edge-control/motorized-ball-valve) | Yes | | | | -| [Smart Farm Irrigation System Using Arduino® Edge Control](https://docs.arduino.cc/tutorials/edge-control/smart-irrigation-system) | Yes | | Yes | | -| [LoRaWAN® Irrigation System Using Arduino® Edge Control](https://docs.arduino.cc/tutorials/edge-control/smart-irrigation-system-v2) | Yes | Yes | | Yes | +| Experience | Edge Control | MKR WAN 1310 | MKR WiFi 1010 | WisGate | +|:----------------------------------------------------------------------------------------------------------------------------------:|:------------:|:------------:|:-------------:|:-------:| +| [Connecting and Controlling a Motorized Ball Valve](https://docs.arduino.cc/tutorials/edge-control/motorized-ball-valve) | Yes | | | | +| [Smart Farm Irrigation System Using Arduino® Edge Control](https://docs.arduino.cc/tutorials/edge-control/smart-irrigation-system) | Yes | | Yes | | +| [LPWAN Irrigation System Using Arduino® Edge Control](https://docs.arduino.cc/tutorials/edge-control/smart-irrigation-system-v2) | Yes | Yes | | Yes | The experiences marked with a `Yes` are the ones related to the product. Experiences marked with a `+` means that to follow the tutorial you must use all the products with the `+` symbol. @@ -86,4 +86,8 @@ The experiences marked with a `Yes` are the ones related to the product. Experie ## Support -If you encounter any issues or have questions, we offer various support resources to help you find answers and solutions. In case of any issues with the redemption process, please contact us by filling out the form available [here](https://www.arduino.cc/en/contact-us/). \ No newline at end of file +If you encounter any issues or have questions, we offer various support resources to help you find answers and solutions. In case of any issues with the redemption process, please contact us by filling out the form available [here](https://www.arduino.cc/en/contact-us/). + +## Trademark Acknowledgments + +- **LoRa®** is a registered trademark of Semtech Corporation. \ No newline at end of file diff --git a/contribution-templates/README.md b/contribution-templates/README.md index 9f0bca7bea..d67e2f3d58 100644 --- a/contribution-templates/README.md +++ b/contribution-templates/README.md @@ -140,7 +140,6 @@ Right: `1.75 μm pixel size` |Bluetooth® / Bluetooth® Low Energy|https://www.bluetooth.com/develop-with-bluetooth/marketing-branding/| |Wi-Fi®|https://www.wi-fi.org/who-we-are/our-brands| |LoRa®|https://blog.semtech.com/how-to-name-and-brand-your-lora-application| -|LoRaWAN®|https://lora-alliance.org/resource_hub/lora-alliance-marks-logo-usage-policy-and-guidelines/| |Arm® / Cortex®|https://www.arm.com/company/policies/trademarks/arm-trademark-list| |MathWorks®|https://www.mathworks.com/company/aboutus/policies_statements/trademarks.html| |Microchip®|https://www.microchip.com/en-us/about/legal-information/microchip-trademarks| diff --git a/scripts/validation/rules/rules-trademarks.yml b/scripts/validation/rules/rules-trademarks.yml index 1fa76e3e47..e4ee7778ee 100644 --- a/scripts/validation/rules/rules-trademarks.yml +++ b/scripts/validation/rules/rules-trademarks.yml @@ -9,12 +9,20 @@ # LoRa® / LoRaWAN® rule # Avoids false positives by excluding the word in conjunction with a dash (e.g. URLs) and as part of code) -- regex: "((?