From b82a98a3fb8c6b59e1f4f0d05bc2026f3ad66167 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Mon, 22 May 2023 19:27:44 -0600 Subject: [PATCH 01/30] Initial commit - TX62-W AT Raw Information Placement For Reference --- .../tutorials/cheat-sheet/cheat-sheet.md | 132 +++++++++++++++++- 1 file changed, 131 insertions(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 363f454763..f0c4082c46 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -89,7 +89,7 @@ This library contains some commands that are quite different, because it leverag | Command | Information | | :----------------------------------------------------: | :----------------------------------------------------------: | -| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1)` | Unlock the SIM card using the PIN parameter and connects to the provider. | +| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider. | | `GSMClient`| Client constructor, on the examples we define it as client | | `GSM.getTime()`|Returns the time, you can set a new one with setTime()| | `GSM.getLocalTime()`| Returns the local time| @@ -126,6 +126,136 @@ void setup() { } ``` +To have a specific frequency band configured, the `GSM.begin()` method requires one additional argument defining frequency band to be used. + +```cpp +void setup() { + Serial.begin(115200); + while(!Serial) {} + + if(GSM.begin(pin, apn, username, pass, CATM1, BAND_20 | BAND_19)){ + Serial.println("connected"); + // ... + } +} +``` + +Here are the details regarding the frequency bands. REQUIRES DETAIL EXPANSION & FOLLOWING INFORMATION EXPLAINED. RAW INFORMATION FROM TX62-W AT COMMAND SPECIFICATION + + determines Cat.M frequency bands the UE is allowed to use. Values are given in hexadecimal +32-bit-value order. Every bit corresponds to a dedicated band number. The number range of covers band 1 to band 32. + +“1“ LTE 2100 (B1) +“2“ LTE 1900 (B2) +“4“ LTE 1800 (B3) +“8“ LTE 1700 (B4) +“10“ LTE 850 (B5) +“80“ LTE 900 (B8) +“800“ LTE 700 (B12) +“1000“ LTE 700 (B13) +“20000“ LTE 850 (B18) +“40000“ LTE 800 (B19) +“80000“ LTE 800 (B20) +“1000000“ LTE 1900 (B25) +“2000000“ LTE 850 (B26) +“4000000“ LTE 800 (B27) +“8000000“ LTE 700 (B28) + +Factory default of is the combination of all available bands meaning that all supported bands are +allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a fullfeatured automatic network selection when trying to register. +Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the +allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, +to reduce the power consumption. In such case, may be one of the supported single values listed +below. + +Any change to this parameter will take effect immediately. So, is a parameter that may be used +to read out the current band combination any time, but the read value is used for reinitializing the UE after next +restart. + +Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands +using AT^SCFG="Radio/Band/CatM","0","0" is possible. + + determines Cat.M frequency bands the UE is allowed to use. Values are given in hexadecimal +bit-value order. Every bit corresponds to a dedicated band number. The number range of covers +band 33 to max possible band. If the UE does not support bands higher than 32 the AT^SCFG test command +returns the value range 0 - 0, and the AT^SCFG read command response does not display . + +“200000000“ LTE 1745 (B66) +“10000000000000“ LTE 700 (B85) + +Factory default of is the combination of all available bands meaning that all supported bands are +allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a fullfeatured automatic network selection when trying to register. +Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the +allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, +to reduce the power consumption. In such case, may be one of the supported single values listed +below. + +Any change to this parameter will take effect immediately. So, is a parameter that may be used +to read out the current band combination any time, but the read value is used for reinitializing the UE after next +restart. + +Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands +using AT^SCFG="Radio/Band/CatM","0","0" is possible. + + determines Cat.NB frequency bands the UE is allowed to use. Values are given in hexadecimal +32-bit-value order. Every bit corresponds to a dedicated band number. The number range of +covers band 1 to band 32. +“1“ LTE 2100 (B1) +“2“ LTE 1900 (B2) +“4“ LTE 1800 (B3) +“8“ LTE 1700 (B4) +“10“ LTE 850 (B5) +“80“ LTE 900 (B8) +“800“ LTE 700 (B12) +“1000“ LTE 700 (B13) +“20000“ LTE 850 (B18) +“40000“ LTE 800 (B19) +“80000“ LTE 800 (B20) +“1000000“ LTE 1900 (B25) +“2000000“ LTE 850 (B26) +“8000000“ LTE 700 (B28) + +Factory default of is the combination of all available bands meaning that all supported bands +are allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a +full-featured automatic network selection when trying to register. +Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the +allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, +to reduce the power consumption. In such case, may be one of the supported single values +listed below. + +Any change to this parameter will take effect immediately. So, is a parameter that may be used +to read out the current band combination any time, but the read value is used for reinitializing the UE after next +restart. + +Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands +using AT^SCFG="Radio/Band/CatNB","0","0" is possible. + + determines Cat.NB frequency bands the UE is allowed to use. Values are given in hexadecimal +bit-value order. Every bit corresponds to a dedicated band number. The number range of covers band 33 to max possible band. If the UE does not support bands higher than 32 the AT^SCFG test command +returns the value range 0 - 0, and the AT^SCFG read command response does not display . + +“200000000“ LTE 1745 (B66) +“4000000000“ LTE 600 (B71) +“10000000000000“ LTE 700 (B85) + +Factory default of is the combination of all available bands meaning that all supported bands +are allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a +full-featured automatic network selection when trying to register. + +Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the +allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, +to reduce the power consumption. In such case, may be one of the supported single values +listed below. + +Any change to this parameter will take effect immediately. So, is a parameter that may be used +to read out the current band combination any time, but the read value is used for reinitializing the UE after next +restart. + +Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands +using AT^SCFG="Radio/Band/CatNB","0","0" is possible. + +ABOVE INFORMATION COMES FROM TX62-W AT COMMAND SPECIFICATION. IN PROGRESS + #### Send a HTTP GET Request and Receive Data The following sketch will connect to your provider and use a HTTP GET request to get data from the server you are connected to. In this case, it connects to "example.com" and prints out the content through the Serial Monitor. From 2c2d0a337dfac32fa744c2836a0517405060709f Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 17:38:17 -0600 Subject: [PATCH 02/30] Cheat sheet - Content realigned WIP --- .../tutorials/cheat-sheet/cheat-sheet.md | 94 ++++++++++--------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index f0c4082c46..c76567b9c4 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -40,7 +40,7 @@ The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Classic - [Installing the Arduino Mbed OS Portenta Boards core](/software/ide-v1/tutorials/getting-started/cores/arduino-mbed_portenta) -### Arduino IDE 2 +### Arduino IDE 2 The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Arduino IDE 2**. To install your board, you can check out the guide below: @@ -53,6 +53,7 @@ The board can be programmed through the **Web Editor**. To get started with your - [Getting started with the Web Editor](/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) ## Pins + As a Portenta family shield, it uses High Density Connectors to interface with the Portenta board which is connected to. ![The pinout of the Portenta Cat. M1/NB IoT GNSS Shield.](assets/ASX00027-pinout.png) @@ -73,9 +74,9 @@ Make sure you go to the `arduino_secrets.h` tab and: * Enter the PIN of your SIM card and store it in the variable `SECRET_PIN`. * Check the mobile APN of your SIM card provider, e.g "online.provider.com", and save it inside the `SECRET_APN`. You can find this information by searching online for APN + provider name. -APN stands for 'Access Point Name'. An APN is a gateway between a cellular network and the Internet. +APN stands for `Access Point Name`. An APN is a gateway between a cellular network and the Internet. -After finishing this setup, compile and upload the program. If everything went fine, you should see the HTML content of the webpage printed in the Serial Monitor. +After finishing this setup, compile, and upload the program. If everything went fine, you should see the HTML content of the webpage printed in the Serial Monitor. ***Sometimes it takes time to connect to the provider's APN, please be patient, it can take up to 30 minutes. If you cannot connect after that time, make sure you entered the correct SIM pin and the APN. If the issue persists, contact your provider and verify whether Cat. M1 is enabled on your SIM card.*** @@ -85,8 +86,6 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). - - | Command | Information | | :----------------------------------------------------: | :----------------------------------------------------------: | | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider. | @@ -100,45 +99,7 @@ This library contains some commands that are quite different, because it leverag | `GSMClient.read()` | Returns data from the server | | `GSMClient.stop()` | Disconnects from the server | -#### Connect to Your Provider - -You need to enter the Pin code and the APN link of your provider. -The user name and password depend on your provider; they are required to authenticate with the APN gateway. These values can usually be found by searching online for APN credentials + provider name. Sometimes they can be left blank. - -This sketch will initialize the SIM card and connect to your provider network - -```cpp -#include - -char pin[] = SECRET_PIN; //example "1234" -char apn[] = SECRET_APN; //example "live.provider.com" -char username[] = SECRET_USERNAME; -char pass[] = SECRET_PASSWORD; - -void setup() { - Serial.begin(115200); - while(!Serial) {} - - if(GSM.begin(pin, apn, username, pass, CATM1)){ - Serial.println("connected"); - // ... - } -} -``` - -To have a specific frequency band configured, the `GSM.begin()` method requires one additional argument defining frequency band to be used. - -```cpp -void setup() { - Serial.begin(115200); - while(!Serial) {} - - if(GSM.begin(pin, apn, username, pass, CATM1, BAND_20 | BAND_19)){ - Serial.println("connected"); - // ... - } -} -``` +#### Frequency Bands Here are the details regarding the frequency bands. REQUIRES DETAIL EXPANSION & FOLLOWING INFORMATION EXPLAINED. RAW INFORMATION FROM TX62-W AT COMMAND SPECIFICATION @@ -256,6 +217,49 @@ using AT^SCFG="Radio/Band/CatNB","0","0" is possible. ABOVE INFORMATION COMES FROM TX62-W AT COMMAND SPECIFICATION. IN PROGRESS +#### Connect to Your Provider + +You need to enter the Pin code and the APN link of your provider. + +The user name and password depends on your provider; these are required to authenticate with the APN gateway. These values can usually be found by searching online for APN credentials and provider name. Sometimes they can be left blank. + +This sketch will initialize the SIM card and connect to your provider network + +```cpp +#include + +char pin[] = SECRET_PIN; //example "1234" +char apn[] = SECRET_APN; //example "live.provider.com" +char username[] = SECRET_USERNAME; +char pass[] = SECRET_PASSWORD; + +void setup() { + Serial.begin(115200); + while(!Serial) {} + + if(GSM.begin(pin, apn, username, pass, CATM1)){ + Serial.println("connected"); + // ... + } +} +``` + +To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be used to mask multiple bands to be used. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. + +```cpp +void setup() { + Serial.begin(115200); + while(!Serial) {} + + if(GSM.begin(pin, apn, username, pass, CATM1, BAND_20 | BAND_19)){ + Serial.println("connected"); + // ... + } +} +``` + +The available frequency band for the shield's cellular connectivity configuration can be found in the previous [Frequency Band section](#frequency-bands). + #### Send a HTTP GET Request and Receive Data The following sketch will connect to your provider and use a HTTP GET request to get data from the server you are connected to. In this case, it connects to "example.com" and prints out the content through the Serial Monitor. @@ -340,7 +344,6 @@ Make sure you go to the `arduino_secrets.h` tab and: ### API - | Command | Information | | :--------------------------------------------------: | :----------------------------------------------------------: | | `GPS.begin()` | Initialize the GPS modem | @@ -351,7 +354,6 @@ Make sure you go to the `arduino_secrets.h` tab and: | `GPS.readAndDrop()` | Read the data and do nothing with it. | | `GPS.checkGNSSEngine()` | Check if the GNSS modem is receiving data correctly. | - #### Get GPS Data The following example connects to the GSM provider, then initializes the GPS antenna, gets data and prints them out on the Serial Monitor. As done previously, you need to provide the GSM data by filling the secrets in `arduino_secrets.h` From ac41f52ff77dffd35e7c8b51077cbb23c4a376d4 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 18:16:36 -0600 Subject: [PATCH 03/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 143 +++--------------- 1 file changed, 24 insertions(+), 119 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index c76567b9c4..665f5fd902 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -20,15 +20,15 @@ libraries: url: https://github.com/107-systems/107-Arduino-NMEA-Parser --- -![The Arduino® Portenta Cat. M1/NB IoT GNSS Shield](assets/featured.png) +![The Arduino Portenta Cat. M1/NB IoT GNSS Shield](assets/featured.png) -The **Arduino® Portenta Cat. M1/NB IoT GNSS Shield** is a board that enables cellular connectivity with both Cat. M1 and NB-IoT networks. Easily track your valuable assets across the city or worldwide by choosing among GPS, GLONASS, Galileo or BeiDou Satellite navigation system. +The **Arduino Portenta Cat. M1/NB IoT GNSS Shield** is a board that enables cellular connectivity with both Cat. M1 and NB-IoT networks. Easily track your valuable assets across the city or worldwide by choosing among GPS, GLONASS, Galileo or BeiDou Satellite navigation system. -This article is a collection of guides, API calls and tutorials that can help you get started with the Arduino® Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Arduino® Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. +This article is a collection of guides, API calls and tutorials that can help you get started with the Arduino® Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Arduino Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. ## Core -The Arduino® Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbed OS Portenta core](https://github.com/arduino/ArduinoCore-mbed). +The Arduino Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbed OS Portenta core](https://github.com/arduino/ArduinoCore-mbed). ***The libraries are included in the mbed Core version greater than 2.6.1*** @@ -101,121 +101,26 @@ This library contains some commands that are quite different, because it leverag #### Frequency Bands -Here are the details regarding the frequency bands. REQUIRES DETAIL EXPANSION & FOLLOWING INFORMATION EXPLAINED. RAW INFORMATION FROM TX62-W AT COMMAND SPECIFICATION - - determines Cat.M frequency bands the UE is allowed to use. Values are given in hexadecimal -32-bit-value order. Every bit corresponds to a dedicated band number. The number range of covers band 1 to band 32. - -“1“ LTE 2100 (B1) -“2“ LTE 1900 (B2) -“4“ LTE 1800 (B3) -“8“ LTE 1700 (B4) -“10“ LTE 850 (B5) -“80“ LTE 900 (B8) -“800“ LTE 700 (B12) -“1000“ LTE 700 (B13) -“20000“ LTE 850 (B18) -“40000“ LTE 800 (B19) -“80000“ LTE 800 (B20) -“1000000“ LTE 1900 (B25) -“2000000“ LTE 850 (B26) -“4000000“ LTE 800 (B27) -“8000000“ LTE 700 (B28) - -Factory default of is the combination of all available bands meaning that all supported bands are -allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a fullfeatured automatic network selection when trying to register. -Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the -allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, -to reduce the power consumption. In such case, may be one of the supported single values listed -below. - -Any change to this parameter will take effect immediately. So, is a parameter that may be used -to read out the current band combination any time, but the read value is used for reinitializing the UE after next -restart. - -Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands -using AT^SCFG="Radio/Band/CatM","0","0" is possible. - - determines Cat.M frequency bands the UE is allowed to use. Values are given in hexadecimal -bit-value order. Every bit corresponds to a dedicated band number. The number range of covers -band 33 to max possible band. If the UE does not support bands higher than 32 the AT^SCFG test command -returns the value range 0 - 0, and the AT^SCFG read command response does not display . - -“200000000“ LTE 1745 (B66) -“10000000000000“ LTE 700 (B85) - -Factory default of is the combination of all available bands meaning that all supported bands are -allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a fullfeatured automatic network selection when trying to register. -Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the -allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, -to reduce the power consumption. In such case, may be one of the supported single values listed -below. - -Any change to this parameter will take effect immediately. So, is a parameter that may be used -to read out the current band combination any time, but the read value is used for reinitializing the UE after next -restart. - -Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands -using AT^SCFG="Radio/Band/CatM","0","0" is possible. - - determines Cat.NB frequency bands the UE is allowed to use. Values are given in hexadecimal -32-bit-value order. Every bit corresponds to a dedicated band number. The number range of -covers band 1 to band 32. -“1“ LTE 2100 (B1) -“2“ LTE 1900 (B2) -“4“ LTE 1800 (B3) -“8“ LTE 1700 (B4) -“10“ LTE 850 (B5) -“80“ LTE 900 (B8) -“800“ LTE 700 (B12) -“1000“ LTE 700 (B13) -“20000“ LTE 850 (B18) -“40000“ LTE 800 (B19) -“80000“ LTE 800 (B20) -“1000000“ LTE 1900 (B25) -“2000000“ LTE 850 (B26) -“8000000“ LTE 700 (B28) - -Factory default of is the combination of all available bands meaning that all supported bands -are allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a -full-featured automatic network selection when trying to register. -Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the -allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, -to reduce the power consumption. In such case, may be one of the supported single values -listed below. - -Any change to this parameter will take effect immediately. So, is a parameter that may be used -to read out the current band combination any time, but the read value is used for reinitializing the UE after next -restart. - -Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands -using AT^SCFG="Radio/Band/CatNB","0","0" is possible. - - determines Cat.NB frequency bands the UE is allowed to use. Values are given in hexadecimal -bit-value order. Every bit corresponds to a dedicated band number. The number range of covers band 33 to max possible band. If the UE does not support bands higher than 32 the AT^SCFG test command -returns the value range 0 - 0, and the AT^SCFG read command response does not display . - -“200000000“ LTE 1745 (B66) -“4000000000“ LTE 600 (B71) -“10000000000000“ LTE 700 (B85) - -Factory default of is the combination of all available bands meaning that all supported bands -are allowed. If AT+COPS equals "0" (automatic mode) this solution allows the subscriber to take advantage of a -full-featured automatic network selection when trying to register. - -Therefore, changes to the band configuration are recommended only if the subscriber wishes to restrict the -allowed bands to a specific band or band combination, in particular to speed up the network search, and thus, -to reduce the power consumption. In such case, may be one of the supported single values -listed below. - -Any change to this parameter will take effect immediately. So, is a parameter that may be used -to read out the current band combination any time, but the read value is used for reinitializing the UE after next -restart. - -Note: The AT^SCFG=? test command shows the minimum and maximum band values. Switching off all bands -using AT^SCFG="Radio/Band/CatNB","0","0" is possible. - -ABOVE INFORMATION COMES FROM TX62-W AT COMMAND SPECIFICATION. IN PROGRESS +When the Portenta Cat. M1/NB IoT GNSS Shield starts establishing connection, it is possible to define frequency band. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: + +| Compatible Frequency Band List | +| 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | +| 0x01 | LTE 2100 | B1 | BAND_1 | +| 0x02 | LTE 1900 | B2 | BAND_2 | +| 0x04 | LTE 1800 | B3 | BAND_3 | +| 0x08 | LTE 1700 | B4 | BAND_4 | +| 0x10 | LTE 850 | B5 | BAND_5 | +| 0x80 | LTE 900 | B8 | BAND_8 | +| 0x800 | LTE 700 | B12 | BAND_12 | +| 0x1000 | LTE 700 | B13 | BAND_13 | +| 0x20000 | LTE 850 | B18 | BAND_18 | +| 0x40000 | LTE 800 | B19 | BAND_19 | +| 0x80000 | LTE 800 | B20 | BAND_20 | +| 0x1000000 | LTE 1900 | B25 | BAND_25 | +| 0x2000000 | LTE 850 | B26 | BAND_26 | +| 0x8000000 | LTE 700 | B28 | BAND_28 | + +Because each country has a compatible frequency band, it is a good practice to ensure the configured band is suitable with its region. You can check the frequency band compatibility with the region by using a website that compiles network status as this [site](https://www.frequencycheck.com/countries). #### Connect to Your Provider From 4e3cbb2cf79626dbfa6207ca2b36722387a1ba94 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 21:19:30 -0600 Subject: [PATCH 04/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 665f5fd902..a69c37362f 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -99,11 +99,12 @@ This library contains some commands that are quite different, because it leverag | `GSMClient.read()` | Returns data from the server | | `GSMClient.stop()` | Disconnects from the server | -#### Frequency Bands +#### Available Frequency Bands -When the Portenta Cat. M1/NB IoT GNSS Shield starts establishing connection, it is possible to define frequency band. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: +It is possible to establish connection with desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: | Compatible Frequency Band List | +| :----------------------------: | | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | 0x01 | LTE 2100 | B1 | BAND_1 | | 0x02 | LTE 1900 | B2 | BAND_2 | @@ -120,6 +121,12 @@ When the Portenta Cat. M1/NB IoT GNSS Shield starts establishing connection, it | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | +These bands are applicable for both Cat.M and Cat.NB radios, and the shield packs Cat-M1 and NB-IoT. A friendly reminder regarding the radio, the Cat.M radio provides high data rates of upto 1 Mbps; while the Cat.NB radio provides lower data rate of 250 Kbps but it is suitable for environments with high variability in its condition. + +The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to shave the time used for network search, and helping to reduce power consumption of the device. + +If you leave the frequency band argument field blank, it will configure using default setting which allows to search for all supported bands that are available. Thus, the Portenta Cat. M1/NB IoT GNSS Shield will proceed to select a compatible network automatically. + Because each country has a compatible frequency band, it is a good practice to ensure the configured band is suitable with its region. You can check the frequency band compatibility with the region by using a website that compiles network status as this [site](https://www.frequencycheck.com/countries). #### Connect to Your Provider @@ -149,7 +156,7 @@ void setup() { } ``` -To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be used to mask multiple bands to be used. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. +To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. ```cpp void setup() { From be795b6ac2ae23e1de693a12c07d16d1edcfa6a5 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 21:42:20 -0600 Subject: [PATCH 05/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index a69c37362f..361aa5cd73 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -101,11 +101,11 @@ This library contains some commands that are quite different, because it leverag #### Available Frequency Bands -It is possible to establish connection with desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: +It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: -| Compatible Frequency Band List | -| :----------------------------: | +**Compatible Frequency Band List** | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | +| :----------------------: | :------: | :--------------: | :------------------: | | 0x01 | LTE 2100 | B1 | BAND_1 | | 0x02 | LTE 1900 | B2 | BAND_2 | | 0x04 | LTE 1800 | B3 | BAND_3 | @@ -121,13 +121,13 @@ It is possible to establish connection with desired frequency band for the Porte | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | -These bands are applicable for both Cat.M and Cat.NB radios, and the shield packs Cat-M1 and NB-IoT. A friendly reminder regarding the radio, the Cat.M radio provides high data rates of upto 1 Mbps; while the Cat.NB radio provides lower data rate of 250 Kbps but it is suitable for environments with high variability in its condition. +These bands are applicable for both Cat.M and Cat.NB radios, enabling shield to use within Cat. M1 and NB-IoT networks. The Cat.M radio provides high data rates of upto 1 Mbps; while the Cat.NB radio provides lower data rate of 250 Kbps but it is suitable for environments with high variability in its condition. These connectivities are granted thanks to TX62-W Cellular-GNSS LPWAN modem. -The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to shave the time used for network search, and helping to reduce power consumption of the device. +The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to reduce the time used for network search, and helping to reduce power consumption of the device. If you leave the frequency band argument field blank, it will configure using default setting which allows to search for all supported bands that are available. Thus, the Portenta Cat. M1/NB IoT GNSS Shield will proceed to select a compatible network automatically. -Because each country has a compatible frequency band, it is a good practice to ensure the configured band is suitable with its region. You can check the frequency band compatibility with the region by using a website that compiles network status as this [site](https://www.frequencycheck.com/countries). +Each country has a compatible frequency band, so it is a good practice to check the configured band is suitable with its region to be operated in. You can check the frequency band compatibility with the region by using a website that compiles network status as [here](https://www.frequencycheck.com/countries). #### Connect to Your Provider From 8ec86a33f4a402d09e7503e5fe5c9621dde3bb77 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 21:50:36 -0600 Subject: [PATCH 06/30] Cheat sheet content update - rectified important detail --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 361aa5cd73..0ec9d6ba6a 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -121,7 +121,7 @@ It is possible to establish connection within desired frequency band for the Por | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | -These bands are applicable for both Cat.M and Cat.NB radios, enabling shield to use within Cat. M1 and NB-IoT networks. The Cat.M radio provides high data rates of upto 1 Mbps; while the Cat.NB radio provides lower data rate of 250 Kbps but it is suitable for environments with high variability in its condition. These connectivities are granted thanks to TX62-W Cellular-GNSS LPWAN modem. +These are Cat.M and Cat.NB frequency bands available for use with TX62-W LTE Cat.M1 and Cat.NB1 Engine, of which the Portenta Cat. M1/NB IoT GNSS Shield operates on. The network connectivities are granted thanks to TX62-W Cellular-GNSS LPWAN modem. The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to reduce the time used for network search, and helping to reduce power consumption of the device. From 8f8919484bd33c52817a65b569bf807f169241e3 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 22:22:08 -0600 Subject: [PATCH 07/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 0ec9d6ba6a..c6cb373434 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -101,7 +101,7 @@ This library contains some commands that are quite different, because it leverag #### Available Frequency Bands -It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used to set the device when it configures the credentials into the device is as follows: +It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used for the device's credential configuration are as follows: **Compatible Frequency Band List** | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | @@ -121,13 +121,13 @@ It is possible to establish connection within desired frequency band for the Por | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | -These are Cat.M and Cat.NB frequency bands available for use with TX62-W LTE Cat.M1 and Cat.NB1 Engine, of which the Portenta Cat. M1/NB IoT GNSS Shield operates on. The network connectivities are granted thanks to TX62-W Cellular-GNSS LPWAN modem. +These are Cat.M and Cat.NB frequency bands available for use with TX62-W, which is referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its on-board TX62-W Cellular-GNSS LPWAN modem. -The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to reduce the time used for network search, and helping to reduce power consumption of the device. +The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to lower the network search time, reducing power consumption of the device. -If you leave the frequency band argument field blank, it will configure using default setting which allows to search for all supported bands that are available. Thus, the Portenta Cat. M1/NB IoT GNSS Shield will proceed to select a compatible network automatically. +If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using default setting which allows to search for all supported bands that are available. Thus, the Portenta Cat. M1/NB IoT GNSS Shield will proceed to select a compatible network automatically depending on the region. -Each country has a compatible frequency band, so it is a good practice to check the configured band is suitable with its region to be operated in. You can check the frequency band compatibility with the region by using a website that compiles network status as [here](https://www.frequencycheck.com/countries). +Each country has a compatible frequency band, so it is a good practice to check the desired band is suitable with its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). #### Connect to Your Provider @@ -135,7 +135,7 @@ You need to enter the Pin code and the APN link of your provider. The user name and password depends on your provider; these are required to authenticate with the APN gateway. These values can usually be found by searching online for APN credentials and provider name. Sometimes they can be left blank. -This sketch will initialize the SIM card and connect to your provider network +The following sketch will initialize the SIM card and connect to your provider network within supported bands: ```cpp #include @@ -156,7 +156,7 @@ void setup() { } ``` -To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. +To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. You may check the how this frequncy band configuration works by checking the [Available Frequency Bands section](#available-frequency-bands). The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. ```cpp void setup() { From d48c93935cef408495682804087d1419691d41ce Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 22:34:22 -0600 Subject: [PATCH 08/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index c6cb373434..7d79c5f92d 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -101,9 +101,8 @@ This library contains some commands that are quite different, because it leverag #### Available Frequency Bands -It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The list of available frequency bands that can be used for the device's credential configuration are as follows: +It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration are as follows: -**Compatible Frequency Band List** | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | :----------------------: | :------: | :--------------: | :------------------: | | 0x01 | LTE 2100 | B1 | BAND_1 | @@ -156,7 +155,7 @@ void setup() { } ``` -To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. You may check the how this frequncy band configuration works by checking the [Available Frequency Bands section](#available-frequency-bands). The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. +To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. ```cpp void setup() { @@ -170,7 +169,7 @@ void setup() { } ``` -The available frequency band for the shield's cellular connectivity configuration can be found in the previous [Frequency Band section](#frequency-bands). +Please check how the frequency band configuration works briefly within the [Available Frequency Bands section](#available-frequency-bands). The list of available frequency bands for the shield's cellular connectivity configuration can also be found in the previous [section](#available-frequency-bands). #### Send a HTTP GET Request and Receive Data From df6e47cbd51d659d5c3ac1c4847585a1e8944b9f Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 23:15:54 -0600 Subject: [PATCH 09/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 7d79c5f92d..63029c0d31 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -101,7 +101,7 @@ This library contains some commands that are quite different, because it leverag #### Available Frequency Bands -It is possible to establish connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration are as follows: +It is possible to establish a connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration is as follows: | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | :----------------------: | :------: | :--------------: | :------------------: | @@ -120,27 +120,27 @@ It is possible to establish connection within desired frequency band for the Por | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | -These are Cat.M and Cat.NB frequency bands available for use with TX62-W, which is referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its on-board TX62-W Cellular-GNSS LPWAN modem. +These are Cat.M and Cat.NB frequency bands are available for use with TX62-W, which is referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its onboard TX62-W Cellular-GNSS LPWAN modem. -The band configuration is available to allow the user to restrict to specific or combination of frequency bands. This helps to operate under certain policy requirements, or to lower the network search time, reducing power consumption of the device. +The band configuration is available to allow the user to restrict to a specific or combination of frequency bands. It helps to operate under enforced frequency policy requirements, or to lower the network search time, reducing the device power consumption. -If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using default setting which allows to search for all supported bands that are available. Thus, the Portenta Cat. M1/NB IoT GNSS Shield will proceed to select a compatible network automatically depending on the region. +If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search for all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the region. -Each country has a compatible frequency band, so it is a good practice to check the desired band is suitable with its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). +Each country has a compatible frequency band, so it is a good practice to check the desired band is suitable for its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). #### Connect to Your Provider You need to enter the Pin code and the APN link of your provider. -The user name and password depends on your provider; these are required to authenticate with the APN gateway. These values can usually be found by searching online for APN credentials and provider name. Sometimes they can be left blank. +The username and password depend on your provider; these are required to authenticate with the APN gateway. These values can usually be found by searching online for APN credentials and provider names. Sometimes they can be left blank. The following sketch will initialize the SIM card and connect to your provider network within supported bands: ```cpp #include -char pin[] = SECRET_PIN; //example "1234" -char apn[] = SECRET_APN; //example "live.provider.com" +char pin[] = SECRET_PIN; //example "1234" +char apn[] = SECRET_APN; //example "live.provider.com" char username[] = SECRET_USERNAME; char pass[] = SECRET_PASSWORD; @@ -148,24 +148,24 @@ void setup() { Serial.begin(115200); while(!Serial) {} - if(GSM.begin(pin, apn, username, pass, CATM1)){ - Serial.println("connected"); + if(GSM.begin(pin, apn, username, pass, CATM1)){ + Serial.println("connected"); // ... - } + } } ``` -To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which can be applied to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look like if you were to define the frequency band. +To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which applies to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look if you were to define the frequency band. ```cpp void setup() { Serial.begin(115200); while(!Serial) {} - if(GSM.begin(pin, apn, username, pass, CATM1, BAND_20 | BAND_19)){ - Serial.println("connected"); + if(GSM.begin(pin, apn, username, pass, CATM1, BAND_20 | BAND_19)){ + Serial.println("connected"); // ... - } + } } ``` From a668d239dad8a8c060ead8d49d96c05bbc283d99 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 23:19:17 -0600 Subject: [PATCH 10/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 63029c0d31..942bc8f163 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -120,7 +120,7 @@ It is possible to establish a connection within desired frequency band for the P | 0x2000000 | LTE 850 | B26 | BAND_26 | | 0x8000000 | LTE 700 | B28 | BAND_28 | -These are Cat.M and Cat.NB frequency bands are available for use with TX62-W, which is referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its onboard TX62-W Cellular-GNSS LPWAN modem. +These are Cat.M and Cat.NB frequency bands that are available for use with TX62-W, referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its onboard TX62-W Cellular-GNSS LPWAN modem. The band configuration is available to allow the user to restrict to a specific or combination of frequency bands. It helps to operate under enforced frequency policy requirements, or to lower the network search time, reducing the device power consumption. From b06eaa4b7d78618f919a160fa0c06720c100e80f Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 23:28:27 -0600 Subject: [PATCH 11/30] Cheat sheet content minor update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 942bc8f163..8be81473ab 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -124,7 +124,7 @@ These are Cat.M and Cat.NB frequency bands that are available for use with TX62- The band configuration is available to allow the user to restrict to a specific or combination of frequency bands. It helps to operate under enforced frequency policy requirements, or to lower the network search time, reducing the device power consumption. -If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search for all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the region. +If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search within all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the region. Each country has a compatible frequency band, so it is a good practice to check the desired band is suitable for its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). From 9399c10583c56a39390ac8bd6bdbf8ca834ae6be Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 23 May 2023 23:30:44 -0600 Subject: [PATCH 12/30] Cheat sheet content minor update --- .../tutorials/cheat-sheet/cheat-sheet.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 8be81473ab..d3bf1645c7 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -124,9 +124,9 @@ These are Cat.M and Cat.NB frequency bands that are available for use with TX62- The band configuration is available to allow the user to restrict to a specific or combination of frequency bands. It helps to operate under enforced frequency policy requirements, or to lower the network search time, reducing the device power consumption. -If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search within all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the region. +If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search within all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the availability in the operating region. -Each country has a compatible frequency band, so it is a good practice to check the desired band is suitable for its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). +Each country has a compatible frequency band, so it is a good practice to check the if desired band is suitable for its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). #### Connect to Your Provider From 03c43c1552c7d8bb57c3a0dcbf4bafe264607553 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 16:03:45 -0600 Subject: [PATCH 13/30] Cheat sheet content internal table adjusted --- .../tutorials/cheat-sheet/cheat-sheet.md | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index d3bf1645c7..c3ab52e64d 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -86,18 +86,18 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). -| Command | Information | -| :----------------------------------------------------: | :----------------------------------------------------------: | -| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider. | -| `GSMClient`| Client constructor, on the examples we define it as client | -| `GSM.getTime()`|Returns the time, you can set a new one with setTime()| -| `GSM.getLocalTime()`| Returns the local time| -| `GSM.setTime()`| Set the time, it will be saved and it can be read with getTime() | -| `GSM.debug()`| After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | -| `GSMClient.connect(server,port)` | Connect to a remote server | -| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | -| `GSMClient.read()` | Returns data from the server | -| `GSMClient.stop()` | Disconnects from the server | +| Command | Information | +| :------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | +| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | +| `GSMClient` | Client constructor, on the examples we define it as client | +| `GSM.getTime()` | Returns the time, you can set a new one with setTime() | +| `GSM.getLocalTime()` | Returns the local time | +| `GSM.setTime()` | Set the time, it will be saved and it can be read with getTime() | +| `GSM.debug()` | After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | +| `GSMClient.connect(server,port)` | Connect to a remote server | +| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | +| `GSMClient.read()` | Returns data from the server | +| `GSMClient.stop()` | Disconnects from the server | #### Available Frequency Bands @@ -105,20 +105,20 @@ It is possible to establish a connection within desired frequency band for the P | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | :----------------------: | :------: | :--------------: | :------------------: | -| 0x01 | LTE 2100 | B1 | BAND_1 | -| 0x02 | LTE 1900 | B2 | BAND_2 | -| 0x04 | LTE 1800 | B3 | BAND_3 | -| 0x08 | LTE 1700 | B4 | BAND_4 | -| 0x10 | LTE 850 | B5 | BAND_5 | -| 0x80 | LTE 900 | B8 | BAND_8 | -| 0x800 | LTE 700 | B12 | BAND_12 | -| 0x1000 | LTE 700 | B13 | BAND_13 | -| 0x20000 | LTE 850 | B18 | BAND_18 | -| 0x40000 | LTE 800 | B19 | BAND_19 | -| 0x80000 | LTE 800 | B20 | BAND_20 | -| 0x1000000 | LTE 1900 | B25 | BAND_25 | -| 0x2000000 | LTE 850 | B26 | BAND_26 | -| 0x8000000 | LTE 700 | B28 | BAND_28 | +| 0x01 | LTE 2100 | B1 | BAND_1 | +| 0x02 | LTE 1900 | B2 | BAND_2 | +| 0x04 | LTE 1800 | B3 | BAND_3 | +| 0x08 | LTE 1700 | B4 | BAND_4 | +| 0x10 | LTE 850 | B5 | BAND_5 | +| 0x80 | LTE 900 | B8 | BAND_8 | +| 0x800 | LTE 700 | B12 | BAND_12 | +| 0x1000 | LTE 700 | B13 | BAND_13 | +| 0x20000 | LTE 850 | B18 | BAND_18 | +| 0x40000 | LTE 800 | B19 | BAND_19 | +| 0x80000 | LTE 800 | B20 | BAND_20 | +| 0x1000000 | LTE 1900 | B25 | BAND_25 | +| 0x2000000 | LTE 850 | B26 | BAND_26 | +| 0x8000000 | LTE 700 | B28 | BAND_28 | These are Cat.M and Cat.NB frequency bands that are available for use with TX62-W, referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its onboard TX62-W Cellular-GNSS LPWAN modem. From b42d9a75acba08ae62fac05862f2c2c14a1e208a Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 16:22:08 -0600 Subject: [PATCH 14/30] Cheat sheet content internal adjustment --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index c3ab52e64d..787e0a537a 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -87,7 +87,7 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). | Command | Information | -| :------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | +| :------------------------------------------: | :--------------------------------------------------------------------------------------: | | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | | `GSMClient` | Client constructor, on the examples we define it as client | | `GSM.getTime()` | Returns the time, you can set a new one with setTime() | From add52d2fb43e3a4aa50132466046d5dd64f3ba31 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 17:12:56 -0600 Subject: [PATCH 15/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 787e0a537a..575a9bc23a 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -1,6 +1,6 @@ --- title: 'Arduino® Portenta Cat. M1/NB IoT GNSS Shield Cheat Sheet' -description: 'Learn how to set up the Arduino® Portenta Cat. M1/NB IoT GNSS Shield and get a quick overview of its functionality. Obtain information regarding pins and how to use the different communication technologies.' +description: 'Learn how to set up the Arduino Portenta Cat. M1/NB IoT GNSS Shield and get a quick overview of its functionality. Obtain information regarding pins and how to use the different communication technologies.' tags: - Installation - Cat. M1 @@ -24,7 +24,7 @@ libraries: The **Arduino Portenta Cat. M1/NB IoT GNSS Shield** is a board that enables cellular connectivity with both Cat. M1 and NB-IoT networks. Easily track your valuable assets across the city or worldwide by choosing among GPS, GLONASS, Galileo or BeiDou Satellite navigation system. -This article is a collection of guides, API calls and tutorials that can help you get started with the Arduino® Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Arduino Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. +This article is a collection of guides, API calls and tutorials that can help you get started with the Arduino Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Arduino Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. ## Core @@ -86,6 +86,7 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). +| :------------------------------------------: | :--------------------------------------------------------------------------------------: | | Command | Information | | :------------------------------------------: | :--------------------------------------------------------------------------------------: | | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | From 7f4658ffaade7478ef2e6ccb745f50a0dab21259 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 17:24:36 -0600 Subject: [PATCH 16/30] Cheat sheet content table revert --- .../tutorials/cheat-sheet/cheat-sheet.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 575a9bc23a..043a66fa86 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -86,7 +86,6 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). -| :------------------------------------------: | :--------------------------------------------------------------------------------------: | | Command | Information | | :------------------------------------------: | :--------------------------------------------------------------------------------------: | | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | From 8136b803b70ea836666c8f303fd524df7571955f Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 21:45:59 -0600 Subject: [PATCH 17/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 043a66fa86..1a68349e49 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -86,7 +86,7 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). -| Command | Information | +| Command | Information | | :------------------------------------------: | :--------------------------------------------------------------------------------------: | | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | | `GSMClient` | Client constructor, on the examples we define it as client | @@ -99,7 +99,7 @@ This library contains some commands that are quite different, because it leverag | `GSMClient.read()` | Returns data from the server | | `GSMClient.stop()` | Disconnects from the server | -#### Available Frequency Bands +### Available Frequency Bands It is possible to establish a connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration is as follows: @@ -255,15 +255,15 @@ Make sure you go to the `arduino_secrets.h` tab and: ### API -| Command | Information | -| :--------------------------------------------------: | :----------------------------------------------------------: | -| `GPS.begin()` | Initialize the GPS modem | -| `GPS.end()` | Turn OFF the GPS modem. | -| `GPS.available()` | Check if the GPS has new data to be read. | -| `GPS.read()` | Returns a `char` with the reading from the GPS module. | -| `GPS.readAndPrint()` | Output data on the Serial Monitor, only if there is new data.| -| `GPS.readAndDrop()` | Read the data and do nothing with it. | -| `GPS.checkGNSSEngine()` | Check if the GNSS modem is receiving data correctly. | +| Command | Information | +| :---------------------: | :----------------------------------------------------------: | +| `GPS.begin()` | Initialize the GPS modem | +| `GPS.end()` | Turn OFF the GPS modem | +| `GPS.available()` | Check if the GPS has new data to be read | +| `GPS.read()` | Returns a `char` with the reading from the GPS module | +| `GPS.readAndPrint()` | Output data on the Serial Monitor, only if there is new data | +| `GPS.readAndDrop()` | Read the data and do nothing with it | +| `GPS.checkGNSSEngine()` | Check if the GNSS modem is receiving data correctly | #### Get GPS Data @@ -319,7 +319,7 @@ To do so, you can use an **NMEA parser**. This will convert messages received fr In this way, it is possible to interact with the data that you need for your application, for instance getting only latitude and longitude. You will be able to save those values into variables, instead of having the whole NMEA messages. -Open the example from the library at **Examples > 107-Arduino-NMEA-Parser > NMEA-Basic** and add the following: +Open the example from the library at **Examples > 107-Arduino-NMEA-Parser > NMEA-Basic** and add the following: Include the needed libraries. @@ -380,6 +380,7 @@ One way to save power on your project is to enable the GPS module only when it n //stop and disable the GNSS engine GPS.end(); ``` + By using this method, you don't need to initialize the GPS inside the `setup()`. ## Conclusion From 01c8d96aec46f199d9357d16c52103c25fdc33ad Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 21:59:21 -0600 Subject: [PATCH 18/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 1a68349e49..b30204b94e 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -86,18 +86,18 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). -| Command | Information | -| :------------------------------------------: | :--------------------------------------------------------------------------------------: | -| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | -| `GSMClient` | Client constructor, on the examples we define it as client | -| `GSM.getTime()` | Returns the time, you can set a new one with setTime() | -| `GSM.getLocalTime()` | Returns the local time | -| `GSM.setTime()` | Set the time, it will be saved and it can be read with getTime() | -| `GSM.debug()` | After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | -| `GSMClient.connect(server,port)` | Connect to a remote server | -| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | -| `GSMClient.read()` | Returns data from the server | -| `GSMClient.stop()` | Disconnects from the server | +| **Command** | **Information** | +|:--------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------:| +| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | +| `GSMClient` | Client constructor, on the examples we define it as client | +| `GSM.getTime()` | Returns the time, you can set a new one with setTime() | +| `GSM.getLocalTime()` | Returns the local time | +| `GSM.setTime()` | Set the time, it will be saved and it can be read with getTime() | +| `GSM.debug()` | After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | +| `GSMClient.connect(server,port)` | Connect to a remote server | +| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | +| `GSMClient.read()` | Returns data from the server | +| `GSMClient.stop()` | Disconnects from the server | ### Available Frequency Bands From b7355ea47697d6368f81446366945d7aaca04744 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:04:45 -0600 Subject: [PATCH 19/30] Cheat sheet content update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index b30204b94e..13a7e9ad67 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -256,7 +256,7 @@ Make sure you go to the `arduino_secrets.h` tab and: ### API | Command | Information | -| :---------------------: | :----------------------------------------------------------: | +| ----------------------- | ------------------------------------------------------------ | | `GPS.begin()` | Initialize the GPS modem | | `GPS.end()` | Turn OFF the GPS modem | | `GPS.available()` | Check if the GPS has new data to be read | From 586dc24904caab79e0097810931b542783ddc1a0 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:14:07 -0600 Subject: [PATCH 20/30] Cheat sheet content table update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 13a7e9ad67..b30204b94e 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -256,7 +256,7 @@ Make sure you go to the `arduino_secrets.h` tab and: ### API | Command | Information | -| ----------------------- | ------------------------------------------------------------ | +| :---------------------: | :----------------------------------------------------------: | | `GPS.begin()` | Initialize the GPS modem | | `GPS.end()` | Turn OFF the GPS modem | | `GPS.available()` | Check if the GPS has new data to be read | From 600729c0084bbef7e887fbfd39244f118161ab42 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:20:26 -0600 Subject: [PATCH 21/30] Cheat sheet content table indent patch --- .../tutorials/cheat-sheet/cheat-sheet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index b30204b94e..03d0bf7ccd 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -87,7 +87,7 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). | **Command** | **Information** | -|:--------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------:| +|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | | `GSMClient` | Client constructor, on the examples we define it as client | | `GSM.getTime()` | Returns the time, you can set a new one with setTime() | @@ -104,7 +104,7 @@ This library contains some commands that are quite different, because it leverag It is possible to establish a connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration is as follows: | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | -| :----------------------: | :------: | :--------------: | :------------------: | +| ------------------------ | -------- | ---------------- | -------------------- | | 0x01 | LTE 2100 | B1 | BAND_1 | | 0x02 | LTE 1900 | B2 | BAND_2 | | 0x04 | LTE 1800 | B3 | BAND_3 | @@ -256,7 +256,7 @@ Make sure you go to the `arduino_secrets.h` tab and: ### API | Command | Information | -| :---------------------: | :----------------------------------------------------------: | +| ----------------------- | ------------------------------------------------------------ | | `GPS.begin()` | Initialize the GPS modem | | `GPS.end()` | Turn OFF the GPS modem | | `GPS.available()` | Check if the GPS has new data to be read | From 9ba77c9f70bdaed02441df1643268f317d1907ff Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:29:15 -0600 Subject: [PATCH 22/30] Cheat sheet content table update --- .../tutorials/cheat-sheet/cheat-sheet.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 03d0bf7ccd..288b5e2014 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -86,18 +86,18 @@ To get familiar with the commands, you can take a look at the [GSM library](http This library contains some commands that are quite different, because it leverages mbed APIs. In this case, it uses the NetworkInterface, CellularContext and CellularDevice classes. For more information about API visit [https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html](https://os.mbed.com/docs/mbed-os/v6.14/apis/network-interface-apis.html). -| **Command** | **Information** | +| Command | Information | |----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| -| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | -| `GSMClient` | Client constructor, on the examples we define it as client | -| `GSM.getTime()` | Returns the time, you can set a new one with setTime() | -| `GSM.getLocalTime()` | Returns the local time | -| `GSM.setTime()` | Set the time, it will be saved and it can be read with getTime() | -| `GSM.debug()` | After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | -| `GSMClient.connect(server,port)` | Connect to a remote server | -| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | -| `GSMClient.read()` | Returns data from the server | -| `GSMClient.stop()` | Disconnects from the server | +| `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` | Unlock the SIM card using the PIN parameter and connects to the provider | +| `GSMClient` | Client constructor, on the examples we define it as client | +| `GSM.getTime()` | Returns the time, you can set a new one with setTime() | +| `GSM.getLocalTime()` | Returns the local time | +| `GSM.setTime()` | Set the time, it will be saved and it can be read with getTime() | +| `GSM.debug()` | After this command, the Serial Monitor will output more detailed info about the GSM class commands, connections, etc... | +| `GSMClient.connect(server,port)` | Connect to a remote server | +| `GSMClient.available()` | Check if the server that is connected to has some bytes ready to be read | +| `GSMClient.read()` | Returns data from the server | +| `GSMClient.stop()` | Disconnects from the server | ### Available Frequency Bands @@ -105,20 +105,20 @@ It is possible to establish a connection within desired frequency band for the P | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | ------------------------ | -------- | ---------------- | -------------------- | -| 0x01 | LTE 2100 | B1 | BAND_1 | -| 0x02 | LTE 1900 | B2 | BAND_2 | -| 0x04 | LTE 1800 | B3 | BAND_3 | -| 0x08 | LTE 1700 | B4 | BAND_4 | -| 0x10 | LTE 850 | B5 | BAND_5 | -| 0x80 | LTE 900 | B8 | BAND_8 | -| 0x800 | LTE 700 | B12 | BAND_12 | -| 0x1000 | LTE 700 | B13 | BAND_13 | -| 0x20000 | LTE 850 | B18 | BAND_18 | -| 0x40000 | LTE 800 | B19 | BAND_19 | -| 0x80000 | LTE 800 | B20 | BAND_20 | -| 0x1000000 | LTE 1900 | B25 | BAND_25 | -| 0x2000000 | LTE 850 | B26 | BAND_26 | -| 0x8000000 | LTE 700 | B28 | BAND_28 | +| 0x01 | LTE 2100 | B1 | BAND_1 | +| 0x02 | LTE 1900 | B2 | BAND_2 | +| 0x04 | LTE 1800 | B3 | BAND_3 | +| 0x08 | LTE 1700 | B4 | BAND_4 | +| 0x10 | LTE 850 | B5 | BAND_5 | +| 0x80 | LTE 900 | B8 | BAND_8 | +| 0x800 | LTE 700 | B12 | BAND_12 | +| 0x1000 | LTE 700 | B13 | BAND_13 | +| 0x20000 | LTE 850 | B18 | BAND_18 | +| 0x40000 | LTE 800 | B19 | BAND_19 | +| 0x80000 | LTE 800 | B20 | BAND_20 | +| 0x1000000 | LTE 1900 | B25 | BAND_25 | +| 0x2000000 | LTE 850 | B26 | BAND_26 | +| 0x8000000 | LTE 700 | B28 | BAND_28 | These are Cat.M and Cat.NB frequency bands that are available for use with TX62-W, referred to as the LTE Cat.M1 and Cat.NB1 Engine. The Portenta Cat. M1/NB IoT GNSS Shield is capable of the present network connectivity thanks to its onboard TX62-W Cellular-GNSS LPWAN modem. From b5b9ff869dd7cb1d0611fa746b6ab9c48a0510d0 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:39:55 -0600 Subject: [PATCH 23/30] Cheat sheet content minor update --- .../tutorials/cheat-sheet/cheat-sheet.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 288b5e2014..0bda4bd7e6 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -389,10 +389,5 @@ This cheat sheet is written as a quick reference to look up the GSM and GPS feat ## Troubleshooting -### Getting Compiling Errors Using GPS and GSM - -Make sure you included first the `GPS.h` library and then the `GSM.h` - -### Can't Upload the Sketch - -Sometimes, while the GPS module is getting readings, you will not be able to upload a new sketch. Double tap the reset button on your Portenta H7 and upload the new sketch. +- If you are getting compiling errors using GPS and GSM, make sure you included first the `GPS.h` library and then the `GSM.h`. +- Sometimes, while the GPS module is getting readings, you will not be able to upload a new sketch. Double tap the reset button on your Portenta H7 and upload the new sketch.s From c04145196a8916fc7f86307dc576164c9513da53 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Wed, 24 May 2023 22:46:26 -0600 Subject: [PATCH 24/30] Cheat sheet content minor update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 0bda4bd7e6..da65a2c857 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -390,4 +390,4 @@ This cheat sheet is written as a quick reference to look up the GSM and GPS feat ## Troubleshooting - If you are getting compiling errors using GPS and GSM, make sure you included first the `GPS.h` library and then the `GSM.h`. -- Sometimes, while the GPS module is getting readings, you will not be able to upload a new sketch. Double tap the reset button on your Portenta H7 and upload the new sketch.s +- Sometimes, while the GPS module is getting readings, you will not be able to upload a new sketch. Double tap the reset button on your Portenta H7 and upload the new sketch. From 385960f81c81fcf511992742bcdfd7437bd3a92e Mon Sep 17 00:00:00 2001 From: TaddyHC <94547080+TaddyHC@users.noreply.github.com> Date: Thu, 25 May 2023 08:13:27 -0600 Subject: [PATCH 25/30] Update content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pablo Marquínez Ferrándiz <11246294+marqdevx@users.noreply.github.com> --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index da65a2c857..7692b2ac3a 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -140,7 +140,7 @@ The following sketch will initialize the SIM card and connect to your provider n #include char pin[] = SECRET_PIN; //example "1234" -char apn[] = SECRET_APN; //example "live.provider.com" +char apn[] = SECRET_APN; //example "live.provider.com" char username[] = SECRET_USERNAME; char pass[] = SECRET_PASSWORD; From 9962d614e9c648d7daa19fc974078e9d44705bdf Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Thu, 25 May 2023 08:21:53 -0600 Subject: [PATCH 26/30] Cheat sheet content post update --- .../tutorials/cheat-sheet/cheat-sheet.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 7692b2ac3a..d8c7a1d6e2 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -1,6 +1,6 @@ --- title: 'Arduino® Portenta Cat. M1/NB IoT GNSS Shield Cheat Sheet' -description: 'Learn how to set up the Arduino Portenta Cat. M1/NB IoT GNSS Shield and get a quick overview of its functionality. Obtain information regarding pins and how to use the different communication technologies.' +description: 'Learn how to set up the Portenta Cat. M1/NB IoT GNSS Shield and get a quick overview of its functionality. Obtain information regarding pins and how to use the different communication technologies.' tags: - Installation - Cat. M1 @@ -24,11 +24,11 @@ libraries: The **Arduino Portenta Cat. M1/NB IoT GNSS Shield** is a board that enables cellular connectivity with both Cat. M1 and NB-IoT networks. Easily track your valuable assets across the city or worldwide by choosing among GPS, GLONASS, Galileo or BeiDou Satellite navigation system. -This article is a collection of guides, API calls and tutorials that can help you get started with the Arduino Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Arduino Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. +This article is a collection of guides, API calls and tutorials that can help you get started with the Portenta Cat. M1/NB IoT GNSS Shield board. You can also visit the [documentation product page for the Portenta Cat. M1/NB IoT GNSS Shield](/hardware/portenta-cat-m1-nb-iot-gnss-shield) for more in-depth tutorials about the different features. ## Core -The Arduino Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbed OS Portenta core](https://github.com/arduino/ArduinoCore-mbed). +The Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbed OS Portenta core](https://github.com/arduino/ArduinoCore-mbed). ***The libraries are included in the mbed Core version greater than 2.6.1*** @@ -74,7 +74,7 @@ Make sure you go to the `arduino_secrets.h` tab and: * Enter the PIN of your SIM card and store it in the variable `SECRET_PIN`. * Check the mobile APN of your SIM card provider, e.g "online.provider.com", and save it inside the `SECRET_APN`. You can find this information by searching online for APN + provider name. -APN stands for `Access Point Name`. An APN is a gateway between a cellular network and the Internet. +APN stands for 'Access Point Name'. An APN is a gateway between a cellular network and the Internet. After finishing this setup, compile, and upload the program. If everything went fine, you should see the HTML content of the webpage printed in the Serial Monitor. From e56a4614cf35c514b4bd57e7384c12380c382192 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Thu, 25 May 2023 08:30:04 -0600 Subject: [PATCH 27/30] Arduino IDE section merged --- .../tutorials/cheat-sheet/cheat-sheet.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index d8c7a1d6e2..77be45c838 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -34,16 +34,13 @@ The Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbe ## Installation -### Arduino IDE 1.8.X +### Arduino -The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Classic Arduino IDE 1.8.X**. To install your board, you can check out the guide below: +The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Classic Arduino IDE 1.8.X** and **Arduino IDE 2**. -- [Installing the Arduino Mbed OS Portenta Boards core](/software/ide-v1/tutorials/getting-started/cores/arduino-mbed_portenta) - -### Arduino IDE 2 - -The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Arduino IDE 2**. To install your board, you can check out the guide below: +To install your board, you can check out the guides below: +- [Installing the Arduino Mbed OS Portenta Boards core](/software/ide-v1/tutorials/getting-started/cores/arduino-mbed_portenta) - [How to use the board manager with the Arduino IDE 2](https://www.arduino.cc/en/Tutorial/getting-started-with-ide-v2/ide-v2-board-manager) ### Web Editor From 775cefebf67a84486de1ec1e0f73d80344a8d3de Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Thu, 25 May 2023 08:37:35 -0600 Subject: [PATCH 28/30] Cheat sheet content post update --- .../tutorials/cheat-sheet/cheat-sheet.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 77be45c838..597d9aa306 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -98,7 +98,9 @@ This library contains some commands that are quite different, because it leverag ### Available Frequency Bands -It is possible to establish a connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. The **list of available frequency bands** that can be used for the device's credential configuration is as follows: +It is possible to establish a connection within desired frequency band for the Portenta Cat. M1/NB IoT GNSS Shield. To do this, you need to define frequency bands for `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` by replacing `BAND_#` with desired band. + +The **list of available frequency bands** that can be used for the device's credential configuration is as follows: | 32-bit Hexadecimal Value | LTE Band | Band Designation | Argument Designation | | ------------------------ | -------- | ---------------- | -------------------- | @@ -121,7 +123,7 @@ These are Cat.M and Cat.NB frequency bands that are available for use with TX62- The band configuration is available to allow the user to restrict to a specific or combination of frequency bands. It helps to operate under enforced frequency policy requirements, or to lower the network search time, reducing the device power consumption. -If you leave the frequency band argument field blank for the `GSM.begin()` method, it will configure using the default setting, which allows it to search within all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the availability in the operating region. +If you leave the frequency band `BAND_#` field blank for the `GSM.begin(PIN, APN, USERNAME, PASSWORD, CATNB/CATM1, BAND_#)` method, it will configure using the default setting, which allows it to search within all available supported bands. The Portenta Cat. M1/NB IoT GNSS Shield will then select a compatible network automatically depending on the availability in the operating region. Each country has a compatible frequency band, so it is a good practice to check the if desired band is suitable for its region. You can check the frequency band compatibility of the region by using a website that compiles network status such as [here](https://www.frequencycheck.com/countries). @@ -152,7 +154,7 @@ void setup() { } ``` -To have a specific frequency band configured, the `GSM.begin()` method allows an additional argument field to define desired frequency band to configure, which applies to mask multiple bands to be used or searched. The following `GSM.begin()` example shows how it would look if you were to define the frequency band. +The following `GSM.begin()` example shows how it would look if you were to define the frequency band for the shield to mask multiple bands to be used or searched. ```cpp void setup() { From fec0be098a32b50ce738deeba6d9eb7749460aae Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Thu, 25 May 2023 09:33:44 -0600 Subject: [PATCH 29/30] Cheat sheet content post update --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 597d9aa306..4d6714837c 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -154,7 +154,7 @@ void setup() { } ``` -The following `GSM.begin()` example shows how it would look if you were to define the frequency band for the shield to mask multiple bands to be used or searched. +The following example shows how the `GSM.begin()` method would look if you were to define the frequency band for the shield to mask multiple bands to be used or searched. The `BAND_20` and `BAND_19` are one example of a combination of bands to configure credential to restrict the shield's network to the compatible region. It will allow to increase the network search speed and reduce the time spent seeking, saving power consumption of the device. ```cpp void setup() { From f19d74ed1a614adb6952c4f4ae189ad854ae178f Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Thu, 25 May 2023 09:49:04 -0600 Subject: [PATCH 30/30] Cheat sheet minor quick patch --- .../tutorials/cheat-sheet/cheat-sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md index 4d6714837c..38795e7bd6 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/tutorials/cheat-sheet/cheat-sheet.md @@ -34,7 +34,7 @@ The Portenta Cat. M1/NB IoT GNSS Shield uses the libraries from the [Arduino Mbe ## Installation -### Arduino +### Arduino IDE The Portenta Cat. M1/NB IoT GNSS Shield can be programmed through the **Classic Arduino IDE 1.8.X** and **Arduino IDE 2**.