diff --git a/Power_Tree_Max_Carrier.svg b/Power_Tree_Max_Carrier.svg new file mode 100644 index 0000000000..35f1836b37 --- /dev/null +++ b/Power_Tree_Max_Carrier.svg @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierPowerTree.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierPowerTree.svg diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/compatibility.yml b/content/hardware/04.pro/carriers/portenta-max-carrier/compatibility.yml new file mode 100644 index 0000000000..58560c68ec --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/compatibility.yml @@ -0,0 +1,12 @@ +software: + - arduino-ide-v1 + - arduino-ide-v2 + - arduino-cli + - iot-cloud + - web-editor +hardware: + boards: + - portenta-h7 + - portenta-h7-lite + - portenta-h7-lite-connected + - portenta-x8 diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierAssembly.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierAssembly.png new file mode 100644 index 0000000000..45b9b613e7 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierAssembly.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBlockDiagram.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBlockDiagram.svg new file mode 100644 index 0000000000..06a8e317af --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBlockDiagram.svg @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutline.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutline.png new file mode 100644 index 0000000000..30ac4ead74 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutline.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutlineHoles.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutlineHoles.png new file mode 100644 index 0000000000..8cdd6c671d Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierBoardOutlineHoles.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierConnectors.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierConnectors.png new file mode 100644 index 0000000000..dd08f450ec Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierConnectors.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierDesignators.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierDesignators.png new file mode 100644 index 0000000000..00e8cd0e42 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierDesignators.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierPowerTree.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierPowerTree.svg new file mode 100644 index 0000000000..7c1b2a7650 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierPowerTree.svg @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierShowcase.png b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierShowcase.png new file mode 100644 index 0000000000..043b2d4794 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/assets/maxCarrierShowcase.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md new file mode 100644 index 0000000000..c9e4dc5c22 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/datasheet/datasheet.md @@ -0,0 +1,502 @@ +--- +identifier: ABX00043 +title: Arduino® Portenta Max Carrier +type: pro +author: Ali Jahangiri +--- + +![Max Carrier board](assets/maxCarrierShowcase.png) + +# Description +Enable edge AI for high performance industrial, building automation and robotics applications with the Arduino® Portenta Max Carrier. The Arduino® Portenta Max Carrier transforms the Arduino® Portenta family into a standardized industrial platform, ready for use as a single board computer or as a reference design. The Arduino® Portenta Max Carrier provides easy access to the onboard peripherals of the Arduino® Portenta X8 including Gigabit Ethernet, microSD and PCIe. This board further augments the capabilities of the Arduino® Portenta X8 with Fieldbus, LoRa®, 4G, Cat-M1 and NB-IoT connectivity providing a platform for Industry 4.0. + +# Target areas: +Industry 4.0, prototyping, robotics, data logging + +# Features +**Note**: This board needs the Arduino® Portenta X8 for full functionality. Not all features are available with the Arduino® Portenta H7. + +* **High Density connectors compatible with Portenta family** +* **Memory** + * Flash memory (2Mb QSPI) + * Micro SD Card slot +* **Power** + * Power Jack for external supply (6-36V) + * On-board 18650 Li-ion battery connector with battery charger (3.7V). It can be used as backup power source if the external power supply fails. +* **Wireless modules** + * Murata CMWX1ZZABZ-078 LoRa® module, SMA connector for antenna + * SARA-R412M-02B (4G/Cat-M1/NBIoT), micro SIM, SMA connector for antenna +* **Connectors** + * 2x USB A female connectors + * 1x Gigabit Ethernet connector (RJ45) + * 1x FD-Can on RJ11 + * 1x mini PCIe + * 1x Serial RS232/422/485 on RJ12 +* **Audio** + * 3x audio jacks: stereo line in, mic in, HP line out + * 1x speaker connector +* **Debugging** + * On board JLink OB / Blackmagic probe + +# Contents + +## The Board +### Application Examples +The Arduino® Portenta Max Carrier provides the user with almost limitless possibilities to create edge computing applications. Together with the Arduino® Portenta X8, there is a wide range of application options. + +**Industrial IoT:** The Portenta Max Carrier enables connectivity between the Portenta boards and Fieldbus (MODBUS/CAN bus). Join the Industry 4.0 bandwagon with edge computing and a range of connectivity options to increase the revenue on your specific application. Remotely control machinery through the Arduino IoT Cloud or your own choice of third-party services without concern for vendor lock-in and identify process bottlenecks with continuous flow monitoring. The low power consumption and integrated Li-ion battery power management ensure reliable operation even in the face of external power failures. + +**Digital Smart Kiosk:** Develop fully-fledged Information Kiosks, Point of Sales devices or other HMI solutions with the Portenta Max Carrier. Increase the productivity and satisfaction of your personnel and customers with real time information. The Portenta Max Carrier can be part of your solution for real time assessment of production environments, just-in-time management of warehouses, patient centric healthcare experiences and mobility management with a streamlined development process + +**Reference Design:** The Arduino Portenta Max Carrier is a great reference design for developing your own custom products around the Portenta ecosystem that conforms to the industry standard specifications. Arduino Pro also provides full development, production and operation support to develop solutions tailored to your business needs. + +### Accessories (Not Included) +* Mini PCIe expansion boards +* SIM card +* 3.7V 18650 Li-ion battery +* microSD card + +### Related Products +* Portenta H7 (Partial support) +* Portenta X8 + +### Solution Overview +![Carrier assembly](assets/maxCarrierAssembly.png) + +*Example of a typical application for a solution including the Portenta Max Carrier and Portenta X8 with posts mounted.* + +## Ratings + +### Recommended Operating Conditions +| Symbol | Description | Min | Typ | Max | Unit | +| --------------------- | ------------------------- | --- | --- | ---- | ---- | +| T | Thermal limits *(1)* | -20 | 25 | 85 | °C | +| VPWR_IN_12 | Power Jack Input Voltage | 6 | 7 | 36 | V | +| PMax | Maximum Power Consumption | - | - | 5000 | mW | + +> (1) RF performance of the SARA-R4 modem above 65°C may be affected, although module is fully functional + +## Functional Overview + +### Block Diagram +![Block Diagram](assets/maxCarrierBlockDiagram.svg) + +### Board Topology +![Board topology](assets/maxCarrierDesignators.png) + +| **Ref.** | **Description** | **Ref.** | **Description** | +| -------- | ------------------------------------------------------ | -------------- | --------------------------------------------------------- | +| U1 | SARA-R412M-02B 4G LTE/Cat-M1/NB-IoT Modem IC | U2 | CS42L52-CNZ Stereo Codec IC | +| U3 | USB2514Bi/M2 4-port USB 2.0 Hub IC | U4 | SP335EER1-L RS232/RS485/RS422 Transceiver IC | +| U5 | TJA1049 CAN Transceiver IC | U6 | MPM3550EGLE Non-isolated DC-DC IC | +| U7 | NCP383 Current Limiting IC | U8,U20,U21,U22 | SN74LVC1T45 Bi-directional logic level converter IC | +| U9 | DSC6111HI2B 12MHz MEMS Oscillator IC | U10 | SN74LVC1G125 Single Bus Buffer Gate IC | +| U11 | BQ24195RGET 4.5A Single Cell Charger IC | U12 | AP7311 1.8V 150mA LDO Linear Regulator IC | +| U13 | TPS54620 6A Buck Regulator IC | U14 | AP2112K-3.3TRG1 3.3V 600mA LDO Regulator IC | +| U15 | STM32F405RG 168MHz 32 bit ARM Cortex-M4 MCU IC | U16-U19 | 74LVC1G157 Single 2-input multiplexer IC | +| U23 | CMWX1ZZABZ-078 Murrata LoRa® module | U24, U25 | LM73100 Ideal Diode with Reverse Polarity Protection | +| J1, J2 | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | J3 | Right-Angle SMA Connector for Modem | +| J4 | 2-1734248-0 FPC Connector | J5 | FW-20-05-G-D-254-150 Signal Break | +| J6 | 615006138421 RS232/RS485 Connector | J7 | 615006138421 CAN Connector | +| J8 | 1759546-1 Mini PCIe Connector | J9 | Right-Angle SMA Connector for LoRa® | +| J10 | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | J11 | 114-00841-68 Micro SD Connector | +| J12 | SJ-3524-SMT-TR 3.5mm Headphone Out | J13 | SJ-3524-SMT-TR 3.5mm Line In Right | +| J14 | SJ-3524-SMT-TR 3.5mm Line In Left | J15 | 61400826021 2-port USB 2.0 Female Connector | +| J16 | 254TR Positive Li-ion Terminal | J17 | TRJK7003A97NL Gigabit Ethernet Connector | +| J18 | 254TR Negative Li-ion Terminal | | | +| J20 | 110990030 Connector for Speaker | X1 | PJ-102A 5.5mm Power Jack Adapter | +| CN1 | FTSH-105-01-F-DV 10-pin JTAG Header | CN2 | Debug Header | +| CN3 | LoRa® Debug Header | SIM1 | 2199337-5 microSIM Card Holder (for on-board modem) | +| SW1 | 218-2LPST Boot Select Switch | SW2 | 218-2LPST Switch *(2)* | +| PB1 | PTS820J25KSMTRLFS Power On Button | PB2 | PTS820J25KSMTRLFS Reset Button | + +### Debugger +Debugging capabilities are integrated directly into the Portenta Max Carrier and are accessible via microUSB (J10). The J-link debugger is compatible with the Segger® J-Link OB and Blackmagic probes, driven by the STM32F405RGT6 controller (U15). In addition to providing access to the Portenta board JTAG ports, different sniffer channels for I2C, CAN and UART lines. The debugger firmware can be updated via SWD on CN3. Additionally, headers for debugging the LoRa® are accessible via CN2 with SWD. + +### Audio +The Arduino Portenta Max Carrier enables connection connections to analog audio channels. This is done through the low power CS42L52 stereo CODEC providing ADC/DAC between analog signals and the I2S protocol. An internal Class D amplifier eliminates the need for external audio amplification circuitry. Configuration of the CS42L52 is achieved over I2C. The CS42L52 IC operates over the 1V8 rail. + +There are four analog audio interfaces accessible on the Portenta Max Carrier: + +* 1x audio jack for right line (J13) +* 1x audio jack for left line in (J14) +* 1x audio jack for stereo headphone line out (J12) +* 1x connector for speaker out (J20) + +**Note:** Audio not supported with the Portenta H7. + +### Cell Modem +The SARA-R412M-02B (U1) is a multi-region modem capable of connecting to 2G/Cat-M1/NBIoT networks worldwide. A dedicated SMA connector (J3) allows for an external antenna. The chip operates over the 1V8 power line. A microSIM slot is available (SIM1). SN74LVC1T45 bidirectional logic level shifters (U8, U20, U21, U22) act as middleware for connecting to 3V3 serial connections. The chip is powered by 3V8 and an internal regulator provides 1V8 that is used for the SIM card and the I/O. The corresponding SIM card slot for the cell modem is on the top side of the board, directly adjacent to the module. + +> (2) Functionality dependent upon connected Portenta board. Check the respective datasheet. + +### LoRa® Module +The Portenta Max Carrier provides long range wireless connectivity for low bandwidth applications with the on-board Murata CMWX1ZZABZ-078 LoRa® transceiver module (U23). This module operates on 3V3. A dedicated SMA connector (J9) allows for an external antenna. Serial wire debug (SWD) headers are accessible via CN2. + +### Mini PCIe +The Arduino Portenta Max Carrier includes one female mini PCI Express card slot (J8). The connector is right angled and the board includes 2 removable standoffs for external module support. To use the spacer, add the plastic spacer on the top side of the board then attach the M2.5 screw from the back together with the washer. The Max Carrier supports two different Mini PCIe sizes. Pins 8, 10, 12 and 14 are reserved for UIM (in this case SIM). + +**Note:** USB, I2C and SIM functionality over PCIe is available only for the X8. Full PCIe functionality not provided at this time. + +### USB +The Arduino Portenta Max Carrier also includes a USB 2.0 Hi-Speed Hub controller based on the USB2514B/M2 (U3) that manages the 2 USB devices from the USB type A connector (J15) plus the LoRa® (U23) and PCIe (J8) modules. J15 is protected by a NCP383LMUAJAATXG (U7) power switch and current limiter. + +### Ethernet +The Gigabit Ethernet physical interface (J17) is directly connected to the high density connector to the Portenta board. The connector includes an activity LED indication (orange) and speed indication (green). + +**Note:** Gigabit Ethernet functionality is only supported on the Portenta X8. + +### Serial Transceiver +The Arduino Portenta Max Carrier includes a multi-protocol transceiver supporting RS-232, RS-485, and RS-422 serial standards (configurable) based on the SP335 IC. It is connected to a 6P6C Connector (RJ11, RJ12, RJ14, RJ25). + +Default configuration: +* Full Duplex +* 232 protocol +* No data rate limit +* Enabled + +### CAN Transceiver +The Arduino Portenta Max Carrier includes a high speed CAN transceiver based on the TJA1049T/3J IC. It is connected to a 4P4C connector (RJ9, RJ10, RJ22). + +### Micro SD Card Slot +The on board Micro SD card can be used for data logging operations. + +### FEATURES SUPPORTED BY PORTENTA BOARDS +The supported features depend upon your choice of Portenta board used together with the Portenta Max Carrier. + +| Function | Portenta H7 Support | Portenta X8 Support | Notes | +| ------------------------ | ------------------- | ------------------- | ------------------------------------------------ | +| USB Host | USB 1.0 | USB 2.0 | Max Speed: USB 1.0 - 12 Mbps, USB 2.0 - 480 Mbps | +| Ethernet | Fast Ethernet | 1 Gbps | Fast Ethernet - 100 Mbps | +| CAN | Yes | Yes | | +| Mini PCIe (USB) | USB 1.0 | USB 2.0 | Max Speed: USB 1.0 - 12 Mbps, USB 2.0 - 480 Mbps | +| Mini PCIe (PCIe) | No | PCIe 2.0 | Portenta H7 only supports USB based PCIe cards | +| Battery Charger | Yes | Yes | | +| LoRa® | Yes | Yes | | +| NBIoT/CatM1/2G | Yes | Yes | Communication with modem is via USB | +| Camera | No | MIPI up to 4 lanes | | +| Audio | Limited | Yes | No firmware support for the H7 | +| RS232/422/485 | Yes | Yes | | +| on board JTAG debugging | Yes | No | | +| on board console to USB | Yes | Yes | | +| on board bus sniffing | Limited | Limited | Only hardware support | + + +### Power Tree +![Power tree](assets/maxCarrierPowerTree.svg) + +The Portenta Max Carrier can either be powered through the power jack (X1) or a 18650 Li-ion/LiPo battery (J16, J18). The battery is charged while the minimum input voltage to X1 is met. The MPM3550EGLE (U6) provides a +5V rail to power the peripherals. This IC also provides power to the BQ24195RGET IC (U11) that manages the Li-ion battery and boosts the voltage to +5V. U11 also determines the battery status. + +The power source can be determined by querying the System Status Register of U11 and check the PG_STAT field. PG_STAT = 1 means the board is powered with a power source on VBUS. Please refer to the IC [datasheet](/resources/datasheets/bq24195-datasheet.pdf) for further details. + +Priority is with the jack delivered power. The battery charger IC also outputs a +3V8 power rail that powers the modem (U1). The +5V power rail provides power to the Portenta board that regulates the voltage with its onboard buck converter to +3V3. The +3V3 power rail supplies power to the LoRa module (U23), 4-port USB hub (U3), microSD module (J11) and Fieldbus circuitry (U4). Audio is powered by a dedicated AP7311 LDO regulator that provides a low noise +1V8 power rail. + +The debugger circuitry has a dedicated power supply AP2112K (U14) that runs off the micro USB voltage from J10. This enables the debugger to operate even if the Portenta board is not inserted. + +Voltage range and max current are provided as a general guideline only. Consult converter datasheet for specific details. + +## Board Operation +**Note:** This board is intended to operate together with Portenta X8 (see section 1.4 Solution Overview). For more information see Portenta X8 datasheet + +## Connector Pinouts +### LoRa® Header (CN2) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | ---------------------- | +| 1 | +3V3 | Power | +3V3 Power Rail | +| 2 | LoRa_SWDIO | Digital | LoRa® SWD Data Line | +| 3 | GND | Power | Ground | +| 4 | LoRa_SWCLK | Digital | LoRa® SWD Clock Line | +| 5 | GND | Power | Ground | +| 6 | NC | NC | Not Connected | +| 7 | NC | NC | Not Connected | +| 8 | NC | NC | Not Connected | +| 9 | GND | Power | Ground | +| 10 | LORA_RST | Digital | LoRa® module reset pin | + +### Debug Header (CN3) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | --------------- | +| 1 | 3V3_BDG | Power | +3V3 Power Rail | +| 2 | DBG_SWDIO | Digital | SWD Data Line | +| 3 | GND | Power | Ground | +| 4 | DBG_SWCLK | Digital | SWD Clock Line | +| 5 | GND | Power | Ground | +| 6 | NC | NC | Not Connected | +| 7 | NC | NC | Not Connected | +| 8 | NC | NC | Not Connected | +| 9 | GND | Power | Ground | +| 10 | RST | Digital | Reset pin | + +### JTAG Header (CN1) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | ---------------------- | +| 1 | +3V3 | Power | +3V3 Power Rail | +| 2 | JTAG_SWD | Digital | JTAG SWD Data Line | +| 3 | GND | Power | Ground | +| 4 | JTAG_SCK | Digital | JTAG Clock Line | +| 5 | GND | Power | Ground | +| 6 | JTAG_SWO | Digital | JTAG Trace Data Line | +| 7 | NC | NC | Not Connected | +| 8 | JTAG_TDI | Digital | JTAG Test Data In Line | +| 9 | JTAG_TRST | Digital | JTAG Test Reset Line | +| 10 | JTAG_RST | Digital | JTAG Reset Line | + +### USB DBG0 (J10) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | ------------ | ----------------------- | +| 1 | VBUS | Power | Connected to +5V_DBG | +| 2 | D- | Differential | USB differential data - | +| 3 | D+ | Differential | USB differential data + | +| 4 | ID | Digital | Not Connected | +| 5 | GND | Power | Ground | + +### Speaker Connector (J20) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | --------------------------- | +| 1 | SPK_OUTA+ | Analog | Speaker A Positive Terminal | +| 2 | SPK_OUTA- | Analog | Speaker A Negative Terminal | +| 3 | SPK_OUTB+ | Analog | Speaker B Positive Terminal | +| 4 | SPK_OUTB- | Analog | Speaker B Negative Terminal | + +### Header Connector (J5) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | --------------------------------- | +| 1 | +3V3 | Power | +3V3 Power Rail | +| 2 | GND | Power | Ground | +| 3 | VREF_P | Analog | Positive Analog Voltage Reference | +| 4 | VREF_N | Analog | Negative Analog Voltage Reference | +| 5 | A0 | Analog | Analog Input 0 | +| 6 | A1 | Analog | Analog Input 1 | +| 7 | A2 | Analog | Analog Input 2 | +| 8 | A3 | Analog | Analog Input 3 | +| 9 | A4 | Analog | Analog Input 4 | +| 10 | A5 | Analog | Analog Input 5 | +| 11 | A6 | Analog | Analog Input 6 | +| 12 | A7 | Analog | Analog Input 7 | +| 13 | GND | Power | Ground | +| 14 | GND | Power | Ground | +| 15 | SAI_CK | Digital | SAI Clock Line | +| 16 | CS | Digital | SPI1 Clock Select | +| 17 | SAI_FS | Digital | SAI Frame Synchronization | +| 18 | CK | Digital | SPI1 Clock Line | +| 19 | SAI_D0 | Digital | SAI Data Line 0 | +| 20 | MISO | Digital | SPI Main In Secondary Out | +| 21 | SAI_D1 | Digital | SAI Data Line 1 | +| 22 | MOSI | Digital | SPI1 Main Out Secondary In | +| 23 | SPDIF_TX | Digital | SPDIF Transmission | +| 24 | TX | Digital | Serial3 Transmission | +| 25 | SPDIF_RX | Digital | SPDIF Receive | +| 26 | RX | Digital | Serial3 Receive | +| 27 | SDA | Digital | I2C1 Data Line | +| 28 | RTS | Digital | Serial3 Ready To Send | +| 29 | SCL | Digital | I2C1 Clock Line | +| 30 | CTS | Digital | Serial3 Clear To Send | +| 31 | +3V8 | Power | +3V8 Power Rail | +| 32 | SDA | Digital | I2C2 Dala Line | +| 33 | PWM0 | Digital | PWM Output 0 | +| 34 | SCL | Digital | I2C2 Clock Line | +| 35 | PWM1 | Digital | PWM Output 1 | +| 36 | +5V | Power | +5V Power Rail | +| 37 | PWM2 | Digital | PWM Output 2 | +| 38 | CAN1_TX | Digital | CAN Transmission Line | +| 39 | PWM3 | Digital | PWM Output 3 | +| 40 | CAN1_RX | Digital | CAN Receive Line | + +### microSD Module +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | ------------------------------------------- | +| 1 | DATA2 | Digital | Data bit 2 | +| 2 | CD/DAT3/SS | Digital | Chip Select/Data Line 3 | +| 3 | CMD/MOSI | Digital | Main Out Secondary In/Command-Response Line | +| 4 | VDD | Power | +3V3 Power Rail | +| 5 | CLK/SCK | Digital | Clock | +| 6 | VSS | Power | Ground | +| 7 | DAT0/MISO | Digital | Main In Secondary Out/Data bit 0 | +| 8 | DAT1 | Digital | Data bit 1 | +| CD1 | CD1 | Power | Card Detect | +| CD2 | CD2 | Power | Ground | +| G2 | GND | Power | Ground | +| G3 | GND | Power | Ground | + +### 4P4C CAN Connector (J7) +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | ------------ | ---------------------------- | +| 1 | +5V | Power | +5V (fused) | +| 2 | CANL | Differential | CAN Differential Signal Low | +| 3 | CANH | Differential | CAN Differential Signal High | +| 4 | GND | Power | Ground | + +### 6P6C Serial Connector (J6) +Note: Functions of pins 2-5 are dependent upon the configured protocol for the SP335 + +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | -------- | --------------- | +| 1 | GND | Power | Ground | +| 2 | Z | Digital | SP335 Out 1 | +| 3 | Y | Digital | SP335 Out 2 | +| 4 | A | Digital | SP335 In 2 | +| 5 | B | Digital | SP335 In 1 | +| 6 | GND | Power | Ground | + + +### PCIe Connector +**Note:** Only USB, I2C and USIM is available. PCIe functionality is reserved for future use and is not supported at this time + +| Pin | **Function** | **Type** | **Description** | +| --- | ------------ | ------------ | --------------------------------------- | +| 1 | NC | NC | Not Connected | +| 2 | +3V3_PCIE | Power | +3V3 Power Rail | +| 3 | NC | NC | Not Connected | +| 4 | GND | Power | Ground | +| 5 | NC | NC | Not Connected | +| 6 | NC | NC | Not Connected | +| 7 | PCIE_CLKREQ | Digital | PCIe Clock Request Signal | +| 8 | UIM_PWR | Power | SIM Power | +| 9 | GND | Power | Ground | +| 10 | UIM_DATA | Digital | SIM Data Line | +| 11 | mPCIe_CK_N | Differential | PCIe Clock Differential Negative | +| 12 | UIM_CLK | Digital | SIM Clock Signal | +| 13 | mPCIe_CK_P | Differential | PCIe Clock Differential Positive | +| 14 | UIM_RST | Digital | SIM Reset Signal | +| 15 | GND | Power | Ground | +| 16 | NC | NC | Not Connected | +| 17 | NC | NC | Not Connected | +| 18 | GND | Power | Ground | +| 19 | NC | NC | Not Connected | +| 20 | NC | NC | Not Connected | +| 21 | GND | Power | Ground | +| 22 | mPCIe_RST | Digital | PCIe Reset Signal | +| 23 | mPCIe_RX_N | Differential | PCIe Receive Differential Negative | +| 24 | NC | NC | Not Connected | +| 25 | mPCIe_RX_P | Differential | PCIe Receive Differential Positive | +| 26 | GND | Power | Ground | +| 27 | GND | Power | Ground | +| 28 | NC | NC | Not Connected | +| 29 | GND | Power | Ground | +| 30 | SCL | Digital | I2C Clock Line | +| 31 | mPCIe_TX_N | Differential | PCIe Transmission Differential Negative | +| 32 | SDA | Digital | I2C Data Line | +| 33 | mPCIe_RX_P | Differential | PCIe Transmission Differential Positive | +| 34 | GND | Power | Ground | +| 35 | GND | Power | Ground | +| 36 | USB_DN | Differential | USB Data Differential Negative | +| 37 | NC | NC | Not Connected | +| 38 | USB_DP | Differential | USB Differential Positive | +| 39 | +3V3_PCIE | Power | +3V3 Power Rail | +| 40 | GND | Power | Ground | +| 41 | +3V3_PCIE | Power | +3V3 Power Rail | +| 42 | NC | NC | Not Connected | +| 43 | NC | NC | Not Connected | +| 44 | NC | NC | Not Connected | +| 45 | NC | NC | Not Connected | +| 46 | NC | NC | Not Connected | +| 47 | NC | NC | Not Connected | +| 48 | NC | NC | Not Connected | +| 49 | NC | NC | Not Connected | +| 50 | GND | Power | Ground | +| 51 | NC | NC | Not Connected | +| 52 | +3V3_PCIE | Power | +3V3 Power Rail | + +## Mechanical Information +### Board Outline +![Board outline](assets/maxCarrierBoardOutline.png) + +### Mounting Holes +![Mounting holes](assets/maxCarrierBoardOutlineHoles.png) + +### Connector Positions +![Connectors outline](assets/maxCarrierConnectors.png) + +## Certifications +### Declaration of Conformity CE DoC (EU) +We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA). + +### Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 +Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment. + +| Substance | **Maximum limit (ppm)** | +| -------------------------------------- | ----------------------- | +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl} phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions : No exemptions are claimed. + +Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC. + +### Conflict Minerals Declaration +As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regards to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder, or as a component in metal alloys. As part of our reasonable due diligence Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas. + +## FCC Caution +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + + (1) This device may not cause harmful interference + + (2) this device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. + +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. + +3. This equipment should be installed and operated with minimum distance 20cm between the radiator & your body. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + + (1) this device may not cause interference + + (2) this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes : + + (1) l’ appareil nedoit pas produire de brouillage + + (2) l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** +English +This equipment should be installed and operated with minimum distance 20 cm between the radiator and your body. + +French: +Lors de l’ installation et de l’ exploitation de ce dispositif, la distance entre le radiateur et le corps est d ’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85℃ and shouldn’t be lower than -40℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +| Frequency bands | Typical Output Power | +| -------------------- | -------------------- | +| 2.4 GHz, 40 channels | TBC | + +## Company Information +| Company name | Arduino SRL | +| --------------- | -------------------------------------------- | +| Company Address | Via Andrea Appiani 25, 20900 Monza MB, Italy | + +## Reference Documentation +| Reference | **Link** | +| -------------------------------- | ---------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | https://www.arduino.cc/en/Main/Software | +| Arduino IDE (Cloud) | https://create.arduino.cc/editor | +| Cloud Web Editor Getting Started | https://docs.arduino.cc/cloud/iot-cloud/tutorials/iot-cloud-getting-started/ | +| Arduino Pro Website | https://www.arduino.cc/pro | +| Library Reference | https://www.arduino.cc/reference/en/ | +| Online Store | https://store.arduino.cc/ | +| Arduino Max Carrier Docs | https://docs.arduino.cc/hardware/portenta-max-carrier | + +## Revision History +| Date | **Revision** | **Changes** | +| ---------- | ------------ | ------------- | +| xx/02/2022 | 1 | First Release | diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-full-pinout.pdf b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-full-pinout.pdf new file mode 100644 index 0000000000..c8c4a9e3af Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-full-pinout.pdf differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-schematics.pdf b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-schematics.pdf new file mode 100644 index 0000000000..269634152a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-schematics.pdf differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-step.zip b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-step.zip new file mode 100644 index 0000000000..9d1959cbbe Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/downloads/ABX00043-step.zip differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/essentials.md b/content/hardware/04.pro/carriers/portenta-max-carrier/essentials.md new file mode 100644 index 0000000000..f3c1f0e6cc --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/essentials.md @@ -0,0 +1,32 @@ + + + A quick guide to installing your board with the Arduino IDE. + + + + + + Bluetooth 4.0 includes both traditional Bluetooth, now labeled "Bluetooth Classic", and the Bluetooth Low Energy (Bluetooth LE, or BLE) + + + The complete Arduino sketches from the Pro tutorials. + + + Read files and/or output sound. + + + Enables sending and receiving data using the RS485 standard. + + + + + + Built-in Examples are sketches included in the Arduino IDE and demonstrate all basic Arduino commands. + + + Discover interesting articles, principles and techniques related to the Arduino ecosystem. + + + Arduino programming language can be divided in three main parts: functions, values (variables and constants), and structure. + + \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/features.md b/content/hardware/04.pro/carriers/portenta-max-carrier/features.md new file mode 100644 index 0000000000..2e1537fa32 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/features.md @@ -0,0 +1,35 @@ + + +The **Portenta Max Carrier** includes a wide range of features to give you flexibility in designing your next intelligent kiosk or edge computer powerhouse. Always stay connected with different connectivity options. + + + + + + The Portenta Max Carrier expands upon the computational capabilities of the Portenta X8. + + + + + Enable 4G, Cat-M1, NB-IoT and LoRa® connectivity in your Industry 4.0 solution. Send and receive texts, or communicate via internet protocols including TCP, UDP and HTTPS. + + + + + NB-IoT and LTE-M coverage includes many regions, such as Europe, North & South America and large parts of Asia. + + + + + Access a wide range of I/O including high density connectors, Gigabit Ethernet, mini PCIe (PCI Express), 3.5mm audio in/out as well as Serial RS232/422/485 + + + + Make solutions faster with the in application Black Magic probe debugger. + + + + The Portenta Max Carrier includes an onboard 18650 Li-ion/LiPo battery holder and power management circuitry. + + + \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/image.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/image.svg new file mode 100644 index 0000000000..ed7de8f2b7 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/image.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/interactive/ABX00043-pinout.png b/content/hardware/04.pro/carriers/portenta-max-carrier/interactive/ABX00043-pinout.png new file mode 100644 index 0000000000..f85651b94f Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/interactive/ABX00043-pinout.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/product.md b/content/hardware/04.pro/carriers/portenta-max-carrier/product.md new file mode 100644 index 0000000000..f1bafec6e9 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/product.md @@ -0,0 +1,8 @@ +--- +title: Portenta Max Carrier +url_shop: https://store.arduino.cc/portenta-max-carrier +url_guide: /tutorials/portenta-max-carrier/getting-started +core: arduino:mbed_portenta +--- + +Transform your Portenta board to a edge computer solution with the Portenta Max Carrier. diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.md new file mode 100644 index 0000000000..b61571a8da --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.md @@ -0,0 +1 @@ +This is the technical specifications for the Portenta Max Carrier. Not all functionality is supported on the Portenta H7. \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.yml b/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.yml new file mode 100644 index 0000000000..8843e829c8 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tech-specs.yml @@ -0,0 +1,28 @@ +Board: + Name: Arduino® Portenta Max Carrier + SKU: ABX00043 +Audio: + Mic: 3.5 mm + Line in: 3.5 mm + Headphone: 3.5 mm headphone output + Speaker: "Speaker connector (Grove format)" +Connectivity: + Cellular module: SARA-R412M-02B (4G/Cat-M1/NBIoT) + LoRa® module: Murata CMWX1ZZABZ-078 LoRa® module + Ethernet: 1x Gigabit Ethernet connector (RJ45) + SIM: 2x nano SIM card module +Connectors: + CAN-BUS: RJ11 + Serial: RS232/422/485 RJ12 + USB host: 2x USB 2.0 + PCIe: mini PCIe with removable posts +Power: + Input voltage: 6-36 V + Operating logic level: 3.3V/5V + Battery Support: 3.7V 18650 Li-ion/LiPo +Memory: + Removable media: 1x microSD +Dimensions: + Weight: 85 gr + Width: 101.6 mm + Length: 101.6 mm \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Connect-H7-to-Max-carrier.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Connect-H7-to-Max-carrier.svg new file mode 100644 index 0000000000..3233c43526 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Connect-H7-to-Max-carrier.svg @@ -0,0 +1,2871 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Sim-card-and-antenna-on-Max-carrier.svg b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Sim-card-and-antenna-on-Max-carrier.svg new file mode 100644 index 0000000000..59909f8f15 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/Sim-card-and-antenna-on-Max-carrier.svg @@ -0,0 +1,1998 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/result-serial-monitor.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/result-serial-monitor.png new file mode 100644 index 0000000000..a62afbc826 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/result-serial-monitor.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/set-radio-technology-sm.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/set-radio-technology-sm.png new file mode 100644 index 0000000000..540113e90c Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/assets/set-radio-technology-sm.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/content.md new file mode 100644 index 0000000000..87a770d067 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/catM1-and-NBIoT/content.md @@ -0,0 +1,188 @@ +--- +title: 'Using NB-IoT or Cat-M1 with the Portenta Max Carrier' +difficulty: easy +description: "Learn how to connect the Portenta Max Carrier to the internet with NB-IoT or Cat-M1 technology" +tags: + - Installation + - CATM1 + - NBIOT +author: 'Benjamin Dannegård' +hardware: + - hardware/04.pro/boards/portenta-h7 + - hardware/04pro/carriers/portenta-max-carrier + - _snippets/hardware/sim-card +software: + - ide-v1 + - ide-v2 + - web-editor +--- + +## Introduction + +The Portenta Max carrier adds a lot of functionality to the Portenta H7. With the Portenta Max Carrier it is possible to use NB-IoT and Cat-M1 technology. In this tutorial we will show to connect to GSM with the Portenta Max carrier and the Portenta H7. + +***Note: This tutorial was created in Sweden, and as a result, the available networks are only Swedish network operators. The results will vary depending on what location you are in.*** + +## Goals + +The goals of this project are: + +- Learn how to connect the board and the carrier. +- Connect to the GSM network with Cat-M1 or NB-IoT. +- Print HTML content in the Serial Monitor. + +## Hardware & Software Needed + +- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)). +- [Portenta H7](https://store.arduino.cc/products/portenta-h7) +- Antenna with GSM 850 / 900 / 1800 / 1900 MHz range and the ability to connect via SMA +- DC 4.5-20V power supply with barrel jack. +- [Portenta Max carrier](https://store.arduino.cc/products/portenta-max-carrier) + +## Instructions + +### Circuit + +For this tutorial we need to plug the Portenta H7 into the Max Carrier, like shown in the image below. By attaching the Portenta H7 board to the HD connectors on top of the Portenta Max Carrier. Press firmly to let it snap in. Once attached, plug the Portenta H7 into your computer using a USB C cable. + +![Connecting the Portenta H7 and Max Carrier](assets/Connect-H7-to-Max-carrier.svg) + +And we also need to insert a SIM card and connect an antenna to the Max Carrier, like shown in the image below. Put the SIM card into the SIM card slot at the top of the Carrier, the same side where the Portenta H7 is located. Next to the SIM card slot there is an antenna SMA connector where you will need to screw on your antenna. + +![SIM card slot and antenna connector](assets/Sim-card-and-antenna-on-Max-carrier.svg) + +After everything else is connected, connect a power cable to the barrel jack. The one right next to the SMA antenna connector. + +### Arduino IDE + +In the Arduino IDE, make sure you have the latest **Portenta mbed os Core** installed. Found in **Tools > Board: > boards manager...**. + +We will also need two libraries to be installed, **MKRNB** and **arduino_bq24195**. You can find these in the **Library manager** in the Arduino IDE. We will be using example sketches from the **MKRNB** library. The **arduino_bq24195** library allows us to control and configuration the BQ24195 PMIC used on the Portenta Max Carrier. + +### NB-IoT or Cat-M1 + +NB-IoT is a radio technology deployed over mobile networks which is especially suited for indoor coverage, low cost, long battery life, and large number of devices. While Cat-M1 supports downlink and uplink speeds up to 1 Mbps with a latency of 50 to 100 ms and can be used for realtime-communication. Cat-M1 is ideal if you are interested in tracking things such as logistics and transportation. Make sure the technology that you choose is supported by your service provider. + +### Switching Between NB-IoT and Cat-M1 + +If you prefer to use one communication technology over the other, then this can be changed with the simple use of one sketch. Open the **ChoseRadioAccessTechnology** sketch located in the **MKRNB** examples. When this sketch is uploaded, open the serial monitor. You will now get options for what technology you prefer to use in the serial monitor. Follow the steps and wait for the sketch to say that it is finished. The board will now use the preferred technology and we can move on to upload other sketches. + +![Serial monitor for sketch](assets/set-radio-technology-sm.png) + +### Programming the Board + +Now open the **NBWebClient** example, this is located inside the **MKRNB**. The full sketch will also be included later in this tutorial. This sketch will connect the our setup to a website and print its content in the serial monitor. + +This sketch uses a secret.h file to store sensitive information, like the PIN code for the SIM card. First we need to go to the **arduino_secrets.h** tab and enter our PIN code into the **Secret_pinnumber** variable. + +The **char server[]** variable will decide what website the setup will connect to and print in the serial monitor. Feel free to try different sites and see the difference in the result. In this tutorial we will use the default **example.org**. + +The sketch will also set the port it uses for connecting with **int port = 80;**. This is the default connection port. If the connection is not being established or if you know the specific port you want to connect to, then change this variable to a more appropriate value. + +### Result of Sketch + +When the sketch is uploaded, open the serial monitor to see the result. You will get error messages in the serial monitor if there is some issue along the way. When it works you should see something similar to what is shown below. + +![Result in the serial monitor](assets/result-serial-monitor.png) + +### Full Sketch + +```cpp + +// libraries +#include + +#include "arduino_secrets.h" +// Please enter your sensitive data in the Secret tab or arduino_secrets.h +// PIN Number +const char PINNUMBER[] = SECRET_PINNUMBER; + +// initialize the library instance +NBClient client; +GPRS gprs; +NB nbAccess; + +// URL, path and port (for example: example.org) +char server[] = "example.org"; +char path[] = "/"; +int port = 80; // port 80 is the default for HTTP + +void setup() { + // initialize serial communications and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + Serial.println("Starting Arduino web client."); + // connection state + boolean connected = false; + + // After starting the modem with NB.begin() + // attach to the GPRS network with the APN, login and password + while (!connected) { + if ((nbAccess.begin(PINNUMBER) == NB_READY) && + (gprs.attachGPRS() == GPRS_READY)) { + connected = true; + } else { + Serial.println("Not connected"); + delay(1000); + } + } + + Serial.println("connecting..."); + + // if you get a connection, report back via serial: + if (client.connect(server, port)) { + Serial.println("connected"); + // Make a HTTP request: + client.print("GET "); + client.print(path); + client.println(" HTTP/1.1"); + client.print("Host: "); + client.println(server); + client.println("Connection: close"); + client.println(); + } else { + // if you didn't get a connection to the server: + Serial.println("connection failed"); + } +} + +void loop() { + // if there are incoming bytes available + // from the server, read them and print them: + if (client.available()) { + Serial.print((char)client.read()); + } + + // if the server's disconnected, stop the client: + if (!client.available() && !client.connected()) { + Serial.println(); + Serial.println("disconnecting."); + client.stop(); + + // do nothing forevermore: + for (;;) + ; + } +} +``` + +### Troubleshoot + +If the code is not working, there are some common issues we can troubleshoot: + +- We have entered the wrong pin number. +- We are out of coverage (no signal). You can run the example sketch **Scan available networks** to see if there is coverage. +- SIM card may not be activated. + +## Next Step + +- The Portenta Max Carrier offers a lot of features when used with the Portenta H7. If you want to learn more about the Portenta Max Carriers peripherals and features, check out our [Getting Started guide for Max Carrier and Portenta H7](/tutorials/getting-started-with-H7). + +- If you are interested in trying out more of the Max Carriers connectivity options. Be sure to check out our tutorial on how to use [LoRa with the Max Carrier and Portenta H7](/tutorials/lora-tutorial). + +## Conclusion + +In this tutorial we went through how to connect the Portenta H7 and Portenta Max Carrier, with peripherals to be able to use the carriers GSM feature. We then learned how to set a preference between NB-IoT or Cat-M1 technology. And at the end we tested so everything works by running an example sketch on our setup. \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_hd_ttn_connectors.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_hd_ttn_connectors.png new file mode 100644 index 0000000000..987524a2f8 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_hd_ttn_connectors.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_boot_sel.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_boot_sel.png new file mode 100644 index 0000000000..1c54f1ecbb Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_boot_sel.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_1.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_1.png new file mode 100644 index 0000000000..0ef2a90cd1 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_1.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_2.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_2.png new file mode 100644 index 0000000000..87eb1afb9a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_2.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_3.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_3.png new file mode 100644 index 0000000000..4caa50de02 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_3.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_4.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_4.png new file mode 100644 index 0000000000..c54e000909 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_console_4.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_firmware_1.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_firmware_1.png new file mode 100644 index 0000000000..027e4e096a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_firmware_1.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_library.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_library.png new file mode 100644 index 0000000000..cafcf35c7a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_library.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png new file mode 100644 index 0000000000..d9694f1347 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_module.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_power.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_power.png new file mode 100644 index 0000000000..80e0b9cb3a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/assets/mc_ard_ttn_power.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md new file mode 100644 index 0000000000..d15a4cdc7f --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/connecting-to-ttn/content.md @@ -0,0 +1,280 @@ +--- +title: Connecting the Portenta Max Carrier to The Things Network +description: This tutorial explains how to connect your Portenta Max Carrier to the Things Network(TTN) using its onboard LoRaWAN® module. +difficulty: intermediate +tags: + - IoT + - LoRaWAN® +author: Taddy Chung, José Bagur +libraries: + - name: MKRWAN +hardware: + - hardware/04.pro/boards/portenta-h7 +software: + - ide-v1 + - ide-v2 +--- + +## Overview + +This tutorial explains how to connect your [Arduino® Max Carrier](http://store.arduino.cc/portenta-max-carrier), with an [Arduino® Portena H7](https://store.arduino.cc/products/portenta-h7) to The Things Network (TTN) using its onboard LoRaWAN® module. The article will focus on achieving communication between the Max Carrier and an application on TTN. + +## Goals + +* Enable LoRaWAN® connectivity on the Arduino® Portenta Max Carrier. +* Establish a connection between the Arduino® Portenta Max Carrier and TTN. + + +### Required Hardware and Software + +- [Arduino® Portena H7](https://store.arduino.cc/products/portenta-h7). +- [Arduino® Portenta Max Carrier](http://store.arduino.cc/portenta-max-carrier). +- 868-915 MHz antenna with SMA connector. +- USB-C cable (either USB-A to USB-C or USB-C to USB-C). +- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)). +- [Arduino MKRWAN library](https://github.com/arduino-libraries/MKRWAN). +- An active account in [TTN](https://www.thethingsnetwork.org/). + +## The Arduino® Portenta Max Carrier LoRaWAN® Module + +The Arduino® Portenta Max Carrier provides you with an unlimited range of applications, from robotics and medical devices to industrial or automotive applications; the Max Carrier possibilities are endless. One feature that boosts Portenta's Max Carrier possibilities is its **onboard LoRaWAN® module**, the [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078) from Murata®. LoRaWAN® is a Low Power Wide Area Network (LPWAN) designed to connect low power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. + +![CMWX1ZZABZ-078 LoRaWAN® module in the Portenta Max Carrier.](assets/mc_ard_ttn_module.png) + +***For more in-depth information about LoRa® and LoRaWAN®, please read [The Arduino Guide to LoRa® and LoRaWAN®](/learn/communication/lorawan-101).*** + +## Connecting to TTN + +Let's start sending data to TTN using the Portenta Max Carrier LoRaWAN® module. To do this, you will need a TTN account and to be in the range of a public TTN gateway. You can check the [world map](https://www.thethingsnetwork.org/map) of public gateways connected to TTN and see if your region already has a gateway installed. If not, consider installing one! + +***Check out [this](https://www.thethingsnetwork.org/docs/gateways/) article from TTN, where you can find how to buy or build your gateway to extend TTN coverage in your region.*** + +To connect your Portenta Max Carrier to TTN, we must follow these steps: + +1. Hardware setup. +2. Software setup. +3. Arduino® Portenta Max Carrier provisioning. +4. Create an application in TTN. +5. Send a message to a TTN application. + +Let's start! + +### 1. Setting up the Hardware + +Begin by attaching the Arduino® Portenta H7 board to the high-density connectors of the Arduino® Portenta Max Carrier, as shown in the image below: + +![CMWX1ZZABZ-078 LoRaWAN® module in the Portenta Max Carrier.](assets/mc_ard_hd_ttn_connectors.png) + +To power the CMWX1ZZABZ-078 LoRaWAN® module of the Portenta Max Carrier, you can use the **DC power jack** (with a 4.5V to 36V external DC power supply) of the Portenta Max Carrier or a **18650 3.7V Li-Ion battery**, connected to the Portenta Max Carrier battery clips; you can power the module also directly from the USB-C connector of the Portenta H7 board. **Also, do not forget to attach an 868-915 MHz antenna to the SMA connector (J9) on the Max Carrier**. + +![Power sources and LoRa® antenna connector in the Portenta Max Carrier.](assets/mc_ard_ttn_power.png) + +***Using the LoRaWAN® module of the Portenta Max Carrier without an antenna may damage it. Please, do not forget to connect a suitable antenna to the dedicated SMA connector (J9) on the Portenta Max Carrier.*** + +Now you can connect the Portenta H7 board to your computer using a USB-C cable. **Don't forget to change the position of the BOOT DIP switch (SW1) to OFF** ; otherwise, you will not be able to program your Portenta H7 board when attached to the Portenta Max Carrier. + +![Power sources and LoRa® antenna connector in the Portenta Max Carrier.](assets/mc_ard_ttn_boot_sel.png) + +### 2. Setting up the Software + +You can use several Arduino libraries with the CMWX1ZZABZ-078 LoRaWAN® module from Murata®; we recommend the [MKRWAN library](https://github.com/arduino-libraries/MKRWAN), developed by the Arduino Team. The MKRWAN library provides you with the APIs to communicate with LoRa® and LoRaWAN® networks using the CMWX1ZZABZ-078 module. You can use this library in the Arduino IDE, both [online](https://create.arduino.cc/editor) and [offline](https://www.arduino.cc/en/software). + +If you are using the online IDE, you don't need to do anything; the library is already installed and ready to be used. If you are using the offline IDE, you must install the library **manually**. Installing the library can be done quickly by navigating to **Tools > Manage Libraries...** and then in the **Library Manager** search for **MKRWAN** library by Arduino; remember to install the latest version of the libraries. You can also access the Library Manager using the left toolbar of the IDE, as shown in the image below: + +![Library Manager in the Arduino IDE 2.](assets/mc_ard_ttn_library.png) + +***Currently, there are two versions of the MKRWAN library. We recommend using the MKRWAN_v1 library since MKRWAN_v2 library is still in beta phase.*** + +To use the MKRWAN library with the Portenta Max Carrier, you must define `PORTENTA_CARRIER` before the library inclusion, as shown below: + +```arduino +#define PORTENTA_CARRIER +#include +``` + +#### 2.1 Updating the LoRaWAN® Module Firmware + +The LoRaWAN® module firmware of the Portenta Max Carrier **must be updated** before its first use. This can be done using the example sketch `MKRWANFWUpdate_standalone` of the MKRWAN library. You can open this example by navigating to **File > Examples > MKRWAN**. Before uploading the sketch to the Portenta H7 board, open the `MKRWANFWUpdate_standalone.ino` file and define `PORTENTA_CARRIER` before the library inclusion, as shown in the image below: + +![Library Manager in the Arduino IDE 2.](assets/mc_ard_ttn_firmware_1.png) + +Upload the sketch, open the Serial Monitor and wait for the firmware update to finish. You should see a confirmation message when the process is done. + + +### 3. Provisioning the Arduino® Portenta Max Carrier + +Device provisioning is a process comparable to bank card numbering. Let's think about bank cards; bank cards numbers start with a six-digit vendor ID number that indicates who allocated and controls the card's security; the remaining digits are unique numbers associated with a specific card. Devices with LoRa® and LoRaWAN® capabilities have a similar system; the **Join Server Unique Identifier** (usually referred to as `JoinEUI`) is a number that manages the security and authorizes the device in a network, while the **Device Unique Identifier** (usually referred to as `DevEUI`) is a unique number that identifies the device. The `JoinEUI` and `DevEUI` are required to send information to TTN; the `JoinEUI` number is provided by the network (in this case TTN) while the `DevEUI` is provided by the manufacturer of the device's LoRa® module. + +The following sketch let's you find out what is the `DevEUI` of your Portenta Max Carrier: + +```arduino +#define PORTENTA_CARRIER +#include + +auto region = US915; + +LoRaModem modem(Serial1); + +void setup() { + Serial.begin(115200); + while(!Serial1); + + if(!modem.begin(region)) { + Serial.println("Failed to start the module..."); + while(1) {} + } + + Serial.print("Your Portenta Max Carrier DevEUI is: "); + Serial.println(modem.deviceEUI()); +} + +void loop() {} +``` + +The only line you may need to change before uploading the code is the one that sets the frequency: + +```arduino +auto region = US915; +``` + +Set the frequency designator according to your country. You can find more information about frequency plans definitions used in TTN [here](https://www.thethingsnetwork.org/docs/lorawan/frequency-plans/). After you upload the sketch to your Portenta H7 board, you should see the Portenta Max Carrier `DevEUI` in the Arduino IDE Serial Monitor as shown below: + +```arduino +Your Portenta Max Carrier DevEUI is: a861XXXXXXXXXXXX +``` + +Now, let's use the `DevEUI` number from your Portenta Max Carrier to create an application in TTN. + +### 3. Creating an Application in TTN + +To send information to TTN, first we need to **create an application and register a device with it**. Navigate to TTN portal and sign in; after signing in, click on **Create an application**. If you already created an application, click on **Go to applications**. + +![TTN console welcome page.](assets/mc_ard_ttn_console_1.png) + +Now click on **Create an application**. You will need to add the following information: + +* **Owner**: the person or organization that owns the application. +* **Application ID**: a unique identifier for your application (must be lowercase and without spaces). + +Complete both fields and click on **Create application**. Now you will be redirected to the application dashboard that shows information of the newly created application. + +![Application dashboard in TTN.](assets/mc_ard_ttn_console_2.png) + +Now, scroll to **End devices** in the left toolbar and then click on **Add end device**; a registration page for end devices will open. + +![Registering an end device in TTN.](assets/mc_ard_ttn_console_3.png) + +On the registration page, click on **Manually**; you will have to add the following information for your Portenta Max Carrier: + +* **Frequency plan**: choose a region according to your country. +* **LoRaWAN® version**: 1.0.2. +* **Regional Parameters version**: 1.0.2. + +Click on Show advanced activation, **LoRaWAN class and cluster settings** and choose: + +* **Activation mode**: Over the air activation (OTAA). +* **Additional LoRaWAN class capabilities**: None (class A only). +* **Network defaults**: Use network's default MAC settings. + +Leave the **Cluster settings** option unchecked. Then continue with the following information: + +* **DevEUI**: fill it with the `DevEUI` number of your Portenta Max Carrier you found [before](#3-provisioning-the-arduino-portenta-max-carrier). +* **AppEUI**: fill it with zeros or enter your own. +* **AppKey**: generate one or enter your own. +* **Device ID**: A custom identifier for your board, must be lowercase and without spaces. + +Click on **Register end device**; this will take you to a **Device Overview** page where you will see all the information related to the device. Now, you will use some of this information with your Portenta Max Carrier to send data to TTN. + +![Device overview in TTN.](assets/mc_ard_ttn_console_4.png) + +### 4. Sending Data to an Application in TTN + +Now, let's start sending information to TTN. The following sketch enables you to join and send data to TTN using the Over the Air (OTAA) device activation method. You will need to define your TTN application's AppEUI and AppKey numbers in the `arduino_secrets.h` file before uploading the code: + +```arduino +#define PORTENTA_CARRIER +#include +#include "arduino_secrets.h" + +auto region = US915; + +LoRaModem modem(Serial1); + +void setup() { + Serial.begin(115200); + while (!Serial); + Serial.println(F("Portenta Max Carrier LoRaWAN Example (OTAA)")); + + if (!modem.begin(region)) { + Serial.println(F("Failed to start the module...")); + while (1) {} + }; + + Serial.print(F("Your Portenta Max Carrier module version is: ")); + Serial.println(modem.version()); + + if (modem.version() != ARDUINO_FW_VERSION) { + Serial.println(F("Please make sure that the modem's firmware is updated.")); + Serial.println(F("To update the module's firmware, open and upload the 'MKRWANFWUpdate_standalone.ino' sketch.")); + } + + Serial.print(F("Your Portenta Max Carrier DevEUI is: ")); + Serial.println(modem.deviceEUI()); + + appKey.trim(); + appEui.trim(); + + int connected = modem.joinOTAA(appEui, appKey); + + if (!connected) { + Serial.println("Something went wrong; are you indoor? Move near a window and retry..."); + while (1) {} + } + + delay(5000); + + modem.setPort(3); + modem.beginPacket(); + modem.print("HelLoRa World!"); + int errorCode = modem.endPacket(true); + if (errorCode > 0) { + Serial.println("Data sent correctly!"); + } else { + Serial.println("Error sending data..."); + } +} + +void loop() { + while (modem.available()) { + Serial.write(modem.read()); + } + modem.poll(); +} +``` + +The `arduino_secrets.h` file which contains AppEUI and AppKey numbers for the TTN applications can be defined as following code. AppEUI and AppKey information is found on the End device page of the TTN Application. + +```arduino +String appEui = "xxxxxxxxxxxxxxxx"; +String appKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; +``` + +If data was sent correctly to TTN, you should see the following messages in the Arduino IDE Serial Monitor: `Data sent correctly!` + +In your device overview dashboard on TTN, you should see changes in data activity every time a new message is sent. + +## Conclusion + +You have now successfully configured and used the onboard LoRaWAN® module of your Portenta Max Carrier. You also have learned how to correctly setup a TTN application and enable LoRaWAN® connectivity between a TTN application and the Portenta Max Carrier. + +### Next Steps + +- Scale up the usage of Portenta Max Carrier by using its additional peripherals and turning them into interesting industrial-grade projects, taking advantage of LoRaWAN® connectivity. + +## Troubleshooting + +While working on the sketch or when tried to upload the sketch, the Arduino IDE might show some errors preventing to proceed on the development. You can try the following troubleshooting tips to solve the commonly known issues: + +* If the sketch upload process fails, check if your Portenta H7 is in bootloader mode. To put the Portenta H7 into Bootloader mode, double-press its RESET button and verify that the green LED is waving. After this, you can try re-uploading the sketch. +* Check the position of the BOOT DIP switch of the Portenta Max Carrier. If the Portenta H7 gets into bootloader mode immediately after power-on, including when connected via USB-C, change the position of the BOOT DIP switch to OFF. +* If the Arduino IDE fails to compile the sketch, check if you have defined `PORTENTA_CARRIER` before the MKRWAN library inclusion. \ No newline at end of file diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_antenna_sma.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_antenna_sma.png new file mode 100644 index 0000000000..f278b5ea51 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_antenna_sma.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_audio_line.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_audio_line.png new file mode 100644 index 0000000000..1370253b12 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_audio_line.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_boot_sel.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_boot_sel.png new file mode 100644 index 0000000000..1c54f1ecbb Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_boot_sel.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_conn_module.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_conn_module.png new file mode 100644 index 0000000000..fb2a78adc9 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_conn_module.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_debug_conn.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_debug_conn.png new file mode 100644 index 0000000000..66344447e9 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_debug_conn.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_hd_connectors.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_hd_connectors.png new file mode 100644 index 0000000000..987524a2f8 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_hd_connectors.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power.png new file mode 100644 index 0000000000..8c5d93162a Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power_tree.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power_tree.png new file mode 100644 index 0000000000..b96774a792 Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_power_tree.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_storage_conn.png b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_storage_conn.png new file mode 100644 index 0000000000..b0f6871d9b Binary files /dev/null and b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/assets/mc_ard_storage_conn.png differ diff --git a/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/content.md b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/content.md new file mode 100644 index 0000000000..2a6e7a5123 --- /dev/null +++ b/content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/getting-started/content.md @@ -0,0 +1,347 @@ +--- +title: Getting Started with the Portenta Max Carrier +description: This tutorial give you an overview of the core features of the Portenta Max Carrier. +difficulty: Beginner +tags: + - Getting Started +author: José Bagur, Taddy Chung +hardware: + - hardware/04.pro/boards/portenta-h7 + - hardware/04.pro/carriers/portenta-max-carrier +software: + - ide-v1 + - ide-v2 +--- + +## Overview + +The Arduino® Portenta Max Carrier provides developers an unlimited range of applications, from robotics and medical devices to industrial or automotive applications; the Portenta Max Carrier possibilities are endless. The Portenta Max Carrier can be used as a single-board computer (SBC) or reference design. It couples the Arduino® Portenta H7 board as a central high-performance unit, granting Edge AI and cutting edge connectivity features into an industry-standard embedded Next Unit of Computing (eNUC) form factor ready. In this tutorial, you will learn about the core features of the Portenta Max Carrier and how to get started with it. + +## Goals + +- Describe the core features of the Portenta Max Carrier. +- Describe the power sources of the Portenta Max Carrier. +- Describe the relevant peripherals, headers, and connectors of the Portenta Max Carrier. + +## Required Hardware and Software + +- [Arduino® Portenta H7](https://store.arduino.cc/products/portenta-h7). +- [Arduino® Portenta Max Carrier](http://store.arduino.cc/portenta-max-carrier). +- USB-C cable (either USB-A to USB-C or USB-C to USB-C). +- LoRa® antenna (868-915MHz) with SMA connector. +- LTE antenna (698-960/1710-2690MHz) with SMA connector. +- 3.7V 2600mAh 18650 Li-Ion battery. +- DC 4.5-20V power supply with barrel jack. +- Micro SD Card +- [Arduino IDE (online or offline)](https://www.arduino.cc/en/software). + +## Instructions + +### 1. Get to Know the Portenta Max Carrier + +The Portenta Max Carrier was designed to augment the capabilities of the Arduino® Portenta H7 board and provide easy access to its onboard peripherals. It is designed to enable research and develop industrial grade advanced applications, from fast prototyping to a deployable robust single board computer. The Portenta Max Carrier establishes connection with Portenta H7 via High Density connectors. This interface grants access to extensive modules and peripherals on-board Portenta Max Carrier. + +In this tutorial, we will describe the following features of the Portenta Max Carrier: + +- Power distribution. +- Connectors. +- On-board memory units. +- Wireless connectivity. +- Audio interfaces. +- On-board debugger. + +#### 1.1. Power Distribution + +The Arduino® Portenta Max Carrier provides several peripherals and modules to cover a wide spectrum of applications. For these peripherals and modules to be powered up and run, the Arduino® Portenta Max Carrier bases on a sophisticated electric power distribution architecture. To power the Portenta Max Carrier, you can use the **barrel jack** connector (X1) or a **3.7V 18650 Li-Ion battery** connected to the Portenta Max Carrier's battery clips (J16 and J18). You can also power the Portenta Max Carrier directly from the USB-C connector of the Portenta H7 board. + +You can see the detailed Portenta Max Carrier's power tree in the image below: + +![Portenta Max Carrier Power Distribution](assets/mc_ard_power_tree.png) + +The Portenta Max Carrier's power inputs are indicated in the following image: + +![Portenta Max Carrier Power Input](assets/mc_ard_power.png) + +These power feed line options power up different peripherals and modules depending on the line configuration. The Portenta H7 powered by USB-C cable while attached to Portenta Max Carrier enables Audio, LoRa, USB Hub, SD ports, Camera, and Fieldbus including the Debugger while it is also possible to upload the Code. This power line use case will be useful to develop and debug the code. + +**If the Arduino IDE throws an error failing to upload the Code, please put the Portenta H7 in Bootloader Mode before uploading.** + +The external power supply goes through [**MPM3550EGLE**](https://www.mouser.com/datasheet/2/277/MPS_05172019_MPM3550E_r1.0-1595120.pdf), which is a DC/DC power module, to provide +5V to power up the peripherals and the modules. The module provides the power to [**BQ24195RGET**](https://www.ti.com/lit/ds/symlink/bq24195.pdf?HQS=dis-mous-null-mousermode-dsf-pf-null-wwe&ts=1647034752895&ref_url=https%253A%252F%252Fwww.mouser.com%252F), which is a battery charge and power path management, and it is used in Portenta Max Carrier for the Li-Ion battery source and to boost the voltage to +5V. The battery charger IC feeds the power to Modem above all the peripherals and modules mentioned previously. The external power supply has the highest priority in the power line. + +A Micro USB port is available for debbugging on the Arduino® Portenta Max Carrier. The debugging module is a separate segment, and it is powered by Micro USB port using its own power supply [**AP2112K**](https://www.diodes.com/assets/Datasheets/AP2112.pdf), which is a low-dropout linear regulator. The debugger is available for use without the Portenta H7 paired to the Portenta Max Carrier. + +#### 1.2. Connectors + +The Portenta Max carrier is equipped with a wide spectrum of connectors for expandability. The following table will show briefly the connectors that are available on the Portenta Max Carrier. + +| Connector (Ref.) | Description | +| ----------------------------------- | --------------------------------------------------------- | +| **USB Hub (U3)** | USB2514Bi/M2 4-port USB 2.0 Hub IC | +| **LoRa® Header (CN2)** | Debug Header | +| **Debug Header (CN3)** | LoRa® Debug Header | +| **High Density Connectors (J1,J2)** | DF40HC(3.5)-80DS-0.4V(51) High Density Connectors | +| **Modem SMA Connector (J3)** | Right-Angle SMA Connector for Modem | +| **LoRa® SMA Connector (J9)** | Right-Angle SMA Connector for LoRa® | +| **FPC Connector (J4)** | 2-1734248-0 FPC Connector | +| **JTAG Header (CN1)** | FTSH-105-01-F-DV 10-pin JTAG Header | +| **USB DBG0 (J10)** | ZX62-AB-5PA(31) Micro USB Debugger Connector with VBUS | +| **USB DBG1 (J19)** | ZX62-AB-5PA(31) Micro USB Debugger Connector without VBUS | +| **Grove Connector for Audio (J20)** | 110990030 Grove Connector for a Speaker | +| **Header Connector (J5)** | FW-20-05-G-D-254-150 Signal Break | +| **4P4C CAN Connector (J7)** | J6 615006138421 RS232/RS485 Connector J7 6 | +| **6P6C Serial Connector (J6)** | 615006138421 RS232/RS485 Connector | +| **PCIe Connector (J8)** | 1759546-1 Mini PCIe Connector | +| **Micro SD Connector (J11)** | 114-00841-68 Micro SD Connector | +| **Ethernet Connector (J17)** | TRJK7003A97NL Gigabit Ethernet Connector | + +***PCIe connector is available on-board. However, only USB and I2C is available for use at the moment.*** + +It is worth noting that a 4P4C connector establishes the connection to the **CAN Transceiver** based on a [TJA1049T/3J](https://www.mouser.com/datasheet/2/302/TJA1049-1127979.pdf) IC. + +The **Serial Transceiver** based on [SP335](https://assets.maxlinear.com/web/documents/sp335e.pdf) IC, which is a multi-protocol transceiver with support for RS-232, RS-485, and RS-422. It establishes connection via 6P6C connector and its default configurations are as follows: + +- Full Duplex +- 232 Protocol +- No Data Rate Limit +- Enabled + +#### 1.3. Onboard Memory Units + +The Portenta Max Carrier equips two different memory units on-board: Flash Memory and Mini SD Card slot. + +![Portenta Max Carrier Storage Option](assets/mc_ard_storage_conn.png) + +**On-Board Flash Memory** + +- The Flash memory on-board the Portenta Max Carrier has 2MB of storage via QSPI (Quad Serial Peripheral Interface). + +***For more information on how to use the Flash Memory storage, please follow this [guide](https://docs.arduino.cc/tutorials/portenta-h7/por-ard-flash) to get most out of the Flash Memory*** + +**Mini SD Card slot** + +- The Mini SD card interface grants the possibility to extend the storage size. It can be used to process hefty amount of log data, which can be from sensors or programmed on-board computer registry. + +***To learn on how to use the Mini SD card slot to expand the storage size, please follow this [guide](https://docs.arduino.cc/learn/programming/sd-guide)*** + +***If it requires to reduce library size and uses FAT16/FAT32 formats, please look into this [library](https://github.com/greiman/SdFat), created and maintained by Bill Greiman*** + +#### 1.4. Wireless Connectivity + +The Portenta Max Carrier has on-board Murata CMWX1ZZABZ-078 LoRaWAN® Module and SARA-R412M-02B Cell Modem as the following image below: + +![Portenta Max Carrier Connectivity Module](assets/mc_ard_conn_module.png) + +#### LoRaWAN® Module - Murata CMWX1ZZABZ-078 +One of the notable features of Portenta Max Carrier is the Murata [CMWX1ZZABZ-078](https://www.murata.com/products/connectivitymodule/lpwa/overview/lineup/type-abz-078) that enables LoRaWAN® connectivity. LoRaWAN® is a Low Power Wide Area Network (LPWAN) designed to connect low power devices to the Internet. It was developed to meet and fulfill Internet of Things (IoT) devices' requirements, such as low-power consumption and low data throughput. + +Depending on the region, it will require to use the appropriate antenna for the respective frequencies. The common frequencies are 915 MHz for North America and Australia, and 863 MHz for European region. Frequencies are on a range, so for example Australia region it is possible to use 928 MHz compatible antenna and configuration. + +***For more in-depth information about LoRa® and LoRaWAN®, please read [The Arduino Guide to LoRa® and LoRaWAN®](https://docs.arduino.cc/learn/communication/lorawan-101).*** + +The LoRa® Connection tutorial with in-depth details on how to power up the module and establish connection to The Things Network (TTN), please go [here]() for more information. + +#### Cell Modem - SARA-R412M-02B + +The Portenta Max Carrier carries a cellular modem SARA-R412M-02B to carry out tasks requiring general network connectivity. This cellular modem is capable of establishing **2G / Cat-M1 / NB-IoT** connections globally. It is powered by bidirectional logic level shifter SN74LVC1T45 and an internal regulator, implemented for the use of SIM card and I/O. The cellular modem requires SIM card integration, which can be fulfilled by intriducing SIM card in the available microSIM slot (SIM1). The modem has dedicated SMA connector (J3) for the antenna. + +***Please DO NOT USE the cellular modem without the external antenna attached to the SMA connector. It might damage the Portenta Max Carrier if used without.*** + +To begin using the modem, it will require some packages to be installed beforehand. Given the network technology, Cat-M1 and NB-IoT, it will require the use of `GSMClient` library. If the library is not installed or needs to be updated, please make sure to have the `Arduino Mbed OS Portenta Core` up to date from the board manager. + +We will use the `arduino_secrets.h` header file for PIN and APN configuration of the SIM card that will be inserted into microSIM slot on-board Portenta Max Carrier. Following code pieces are to be used to initialize the GSM and set the general network configuration. + +```cpp +// Initializes GSM +GSM.begin(pin, apn, username, pass, CATNB); + +// Establishes connection to desired server +client.connect(server, port); +``` + +Inside the `GSM.begin(pin, apn, username, pass, CATNB)` function, where CATNB is the fifth argument of the function, must be defined to which network technology will be used. + +- To use the NB-IoT network technology, please use `CATNB` as the argument +- To use the Cat-M1 network technology, please use `CATM1` as the argument + +For the `client.connect(server, port);` function, the port is predefined as `80`. It is required to define the server, and the port argument if necessary, to successfully carry out the operation. + +The antenna connectors for both LoRaWAN® and cellular modem with the microSIM slot are indicated as the following image: + +![Portenta Max Carrier Antenna Connectors and microSIM Slot](assets/mc_ard_antenna_sma.png) + +#### Ethernet Connection + +The Portenta Max Carrier has a physical Ethernet interface on-board, which is directly connected via High-Density Connectors of the Portenta board. The connector provides network activity status and speed indication via LED indicator. The 10/100 Ethernet is supported and Gigabit connection is reserved for future use at the moment. The physical interface is indicated visually with the previous image showing antenna connectors and microSIM slot. + +#### 1.5. Audio Interfaces + +The Portenta Max Carrier features a stereo CODEC, the [CS42L52](https://www.mouser.com/datasheet/2/76/CS42L52_F2-1141287.pdf) from Cirrus Logic®. The CS42L52 is a 24-bit, low-power stereo CODEC that can provide up to 1W per channel of Class D stereo/mono amplification to external speakers (8-ohm stereo speakers and 4-ohm mono speakers) or enough power to drive 44mW per channel into stereo headphones. There are four analog audio interfaces in the Portenta Max Carrier, as shown in the image below: + +![Portenta Max Carrier Audio Connectors](assets/mc_ard_audio_line.png) + +You can use [this](https://www.digikey.ca/en/products/detail/adafruit-industries-llc/5244/16056943) cable assembly and make your mono speaker. The CS42L52 stereo CODEC operates using an I2C interface, with the CODEC acting as a secondary device. + +Arduino Portenta H7 establishes I2C interface using the `Wire` library included in `ArduinoCore-mbed` package. The Arduino Portenta Max Carrier, while having paired the Portenta H7 via High-Density Connectors, can be expanded via Header Connector J5 for I2C interface interoperability. External modules requiring I2C interface can be established via header Connector J5 with up to 2 available I2C bridges. + +***For more information on I2C protocol, please have a look at this [guide to Arduino & the I2C Protocol (Two Wire)](https://docs.arduino.cc/learn/communication/wire)*** + +#### 1.6. Onboard Debugger + +Part of the development process, debugging process is crucial and it is required step if we are aiming now to work with industrial grade devices. The Portenta Max Carrier provides discrete debugging capability on-board. The feature can be accessed via micro USB to J-Link debugger. + +It is driven by STM32F405RGT6 controller and compatible with Segger® J-Link OB and Blackmagic probes. The module itself does not require Portenta H7 to be attached on the Portenta Max Carrier, meaning it does not require VBUS. + +***For more in-depth information about Debugging, please read [Debugging Fundamentals](https://docs.arduino.cc/learn/microcontrollers/debugging).*** + +The following image indicates the connectors that enables and allows to establish connection to Portenta Max Carrier's on-board debugger. + +![Portenta Max Carrier On-Board Debugger Connections](assets/mc_ard_debug_conn.png) + +### 2. Basic Setup of the Portenta Max Carrier +The Portenta Max Carrier only requires the Portenta H7 as main unit to be able to use it. External components are required to enable the on-board module's capability and correct operation, such as cellular modem and LoRaWAN® connectivity. As the Portenta H7 is the central control unit of the Portenta Max Carrier, it will need to have the latest **Arduino Mbed OS Portenta Core** installed. + +In case it is not installed or requires an update, it is possible to navigate under **Tools > Board > Board Manager** and search for the `Arduino Mbed OS Portenta Core` and proceed with the update. + +To take advantage of Portenta Max Carrier's Power Architecture, an important physical configuration requires to be verified. A DIP Switch for Boot mode selection is present on the Portena Max Carrier board. It requires to set **BOOT_SEL** to select between 2 boot addresses, which will enable Portenta H7 and Max Carrier to run the firmware. **BOOT** parameter will switch the Portenta H7 state into Boot mode. + +Every time it initiates at Boot mode, the Portenta H7 will fade the Green LED to indicate its state. This will help to understand the board is in Boot mode and not turned off due to unavailable electric supply as it shutted off. As the power lines are alive even if the board shows no indication of operating instance. + +![Portenta Max Carrier Power DIP Switch](assets/mc_ard_boot_sel.png) + +### 3. The Circuit + +The Arduino® Portenta Max Carrier uses the Arduino® Portenta H7 as the main central processing unit and that powers up the carrier's modules mentioned above. Both systems possess High-Density Connectors to establish communication interface in between. It is simple as attaching the Portenta H7 to Portenta Max Carrier's High-Density Connectors. The following connection scheme shows how exactly the device is paired with correct orientation. + +![Portenta Max Carrier Hardware Setup](assets/mc_ard_hd_connectors.png) + +Rest of the connection population will depend on the development requirement. It is important that if the connectivity modules are to be utilized, respective antennas should be attached before powering up. Otherwise, the Portenta Max Carrier may suffer from severe electronic hardware damage. Such details are drawn on the table with briefly mentioned content above in `1.4. Wireless Connectivity` section. + +### 4. Getting up to Pro with Development Environment + +For all the information detailed as above for it to be used, we will need to develop the code and flash it to the system. It is possible to use following development environment designed by Arduino®. + +#### 4.1. Using Arduino® IDE 2 + +The Arduino® IDE 2 allows the developers to design and upload the code to Portenta H7 in offline. It will also help you with organizing packages needed to program the Portenta H7. It will require a USB-C Type cable that will allow to connect and program the Portenta H7. In [here](https://www.arduino.cc/en/software), you will be able to find the latest version of the Arduino IDE 2. + +***If you want to know how to setup the Arduino® IDE 2 adequately, please look into [Quick Guide to Arduino® IDE 2.0](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing)*** + +#### 4.2. Using Arduino® Web Editor + +All Arduino® boards work Out-of-the-Box with the Arduino® Web Editor, and the Portenta H7 with Portenta Max Carrier is no exception. The Arduino® Web Editor requires online connection with Arduino® account and a simple plugin to be able to develop on. The features are always up-to-date and support every Arduino® boards. By following this [link to Arduino® Web Editor](https://create.arduino.cc/editor), you will be able to access and begin developing the code. + +***If you want to know how to get started with Arduino® Web Editor, please look into [Getting started with the Web Editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor)*** + +#### 4.3. Using Arduino® IoT Cloud + +The Arduino® boards that are IoT enabled, can use the Arduino® IoT Cloud to develop automated system and a feedback system that gathers useful data for analysis purposes. By following this [link to Arduino® IoT Cloud](https://create.arduino.cc/iot/things), you will be able to access and begin developing the code. + +***If you want to know how to get started with Arduino® IoT Cloud, please look into [Getting Started With the Arduino® IoT Cloud](https://docs.arduino.cc/cloud/iot-cloud/tutorials/iot-cloud-getting-started)*** + +### 5. Portenta Max Carrier Quick Peripheral Table +The following peripheral table will help you guide through quickly about the select available connectors on Portenta Max Carrier. + +| PERIPHERAL | PIN | FUNCTION | TYPE | DESCRIPTION | +| -------------------------- | --------- | ------------- | ------- | ----------------------------------- | +| **LoRa® Header (CN2)** | | | | | +| | 1 | +3V3 | Power | +3V3 Power Rail | +| | 2 | LoRa_SWDIO | Digital | LoRa® SWD Data Line | +| | 3, 5, 9 | GND | Power | Ground | +| | 6 ~ 8 | NC | NC | Not Connected | +| | 4 | LoRa_SWCLK | Digital | LoRa® SWD Clock Line | +| | 10 | LORA_RST | Digital | LoRa® module reset pin | +| **Debug Header (CN3)** | | | | | +| | 1 | 3V3_DBG | Power | +3V3 Power Rail | +| | 2 | DBG_SWDIO | Digital | SWD Data Line | +| | 3, 5, 9 | GND | Power | Ground | +| | 4 | DBG_SWCLK | Digital | SWD Clock Line | +| | 6 ~ 8 | NC | NC | Not Connected | +| | 10 | RST | Digital | Reset Pin | +| **JTAG Header (CN1)** | | | | | +| | 1 | 3V3 | Power | +3V3 Power Rail | +| | 2 | JTAG_SWD | Digital | JTAG SWD Data Line | +| | 3, 5 | GND | Power | Ground | +| | 4 | JTAG_SCK | Digital | JTAG Clock Line | +| | 6 | JTAG_SWO | Digital | JTAG Trace Data Line | +| | 7 | NC | NC | Not Connected | +| | 8 | JTAG_TDI | Digital | JTAG Test Data In Line | +| | 9 | JTAG_TRST | Digital | JTAG Test Reset Line | +| | 10 | JTAG_RST | Digital | JTAG Reset Line | +| **Header Connector (J5)** | | | | | +| | 1 | 3V3 | Power | +3V3 Power Rail | +| | 2, 13, 14 | GND | Power | Ground | +| | 3 | VREF_P | Analog | Positive Analog Voltage Reference | +| | 4 | VREF_N | Analog | Negative Analog Voltage Reference | +| | 5 ~ 12 | A0 ~ A7 | Analog | Analog input 0 ~ 7 | +| | 15 | SAI_CK | Digital | SAI Clock Line | +| | 16 | CS | Digital | SPI1 Clock Select | +| | 17 | SAI_FS | Digital | SAI Frame Synchronization | +| | 18 | CK | Digital | SPI1 Clock Line | +| | 19 | SAI_D0 | Digital | SAI Data Line 0 | +| | 20 | MISO | Digital | SPI Main In Secondary Out | +| | 21 | SAI_D1 | Digital | SAI Data Line 1 | +| | 22 | MOSI | Digital | SPI1 Main Out Secondary In | +| | 23 | SPDIF_TX | Digital | SPDIF Transmission | +| | 24 | TX | Digital | Serial3 Transmission | +| | 25 | SPDIF_RX | Digital | SPDIF Receive | +| | 26 | RX | Digital | Serial3 Receive | +| | 27 | SDA | Digital | I2C1 Data Line | +| | 28 | RTS | Digital | Serial3 Ready to Send | +| | 29 | SCL | Digital | I2C1 Clock Line | +| | 30 | CTS | Digital | Serial3 Clear to Send | +| | 31 | 3V8 | Power | +3V8 Power Rail | +| | 32 | SDA | Digital | I2C2 Data Line | +| | 33 | PWM0 | Digital | PWM Output 0 | +| | 34 | SCL | Digital | I2C2 Clock Line | +| | 35 | PWM1 | Digital | PWM Output 1 | +| | 36 | 5V | Power | +5V Power Rail | +| | 37 | PWM2 | Digital | PWM Output 2 | +| | 38 | CAN1_TX | Digital | CAN Transmission Line | +| | 39 | PWM3 | Digital | PWM Output 3 | +| | 40 | CAN1_RX | Digital | CAN Receive Line | +| **4P4C CAN Connector (J7)**| | | | | +| | 1 | 5V | Power | +5V (Fused) | +| | 2 | CANL | Diff. | CAN Differential Signal Low | +| | 3 | CANH | Diff. | CAN Differential Signal High | +| | 4 | GND | Power | Ground | +| **6P6C Serial Conn. (J6)** | | | | | +| | 1 | GND | Power | Ground | +| | 2 | Z | Digital | SP335 Out 1 | +| | 3 | Y | Digital | SP335 Out 2 | +| | 4 | A | Digital | SP335 In 2 | +| | 5 | B | Digital | SP335 In 1 | +| | 6 | GND | Power | Ground | +| **PCIe Connector (J8)** | | | | | +| | 1, 3, 5, 6, 8, 10, 12, 14, 16, 17, 19, 20, 24, 28, 37, 42 ~ 49, 51 | NC | NC | Not Connected | +| | 2, 39, 41, 52 | 3V3_PCIE | Power | +3V3 Power Rail | +| | 3, 9, 15, 18, 21, 26, 27, 29, 34, 35, 40, 50 | GND | Power | Ground | +| | 7 | PCIE_CLKREQ | Digital | PCIE Clock Request Signal | +| | 11 | mPCIe_CK_N | Diff. | PCIe Clock Differential Negative | +| | 13 | mPCIe_CK_P | Diff. | PCIe Clock Differential Positive | +| | 22 | mPCIe_RST | Digital | PCIe Reset Signal | +| | 23 | mPCIe_RX_N | Diff. | PCIe Receive Differential Negative | +| | 25 | mPCIe_RX_N | Diff. | PCIe Receive Differential Positive | +| | 30 | SCL | Digital | I2C Clock Line | +| | 31 | mPCIe_TX_N | Diff. | PCIe Transmission Differential Negative | +| | 32 | SDA | Digital | I2C Data Line | +| | 33 | mPCIe_TX_P | Diff. | PCIe Transmission Differential Positive | +| | 36 | USB_DN | Diff. | USB Data Differential Negative | +| | 38 | USB_DN | Diff. | USB Differential Positive | + +***These are a quick reference to commonly used interfaces and if custom connectors are to be used, above quick peripheral table will assist you to verify the correct polarity of connector pins.*** + +## Conclusion +You now have a quickstart guide of the Portenta Max Carrier with its rich modules and peripherals to design and implement real world solutions. The Portenta Max Carrier provides wide spectrum of tools and ports to enable a scalable design solution. With this guide, you now also acquired brief knowledge about the Portenta Max Carrier and will be able to solidify the requirements and devise more clearly. + +### Next Steps +In-depth guides for each distinctive module on-board Portenta Max Carrier can be found under each section of the features listed previously on this guide. + +## Troubleshooting +One may encounter issues setting up and initializing for the first time the Portenta Max Carrier. Following troubleshooting will help you with the possible issues that might occur in the beginning. + +- When sketch upload fails, please check if the Portenta H7 attached to Portenta Max Carrier is in bootloader mode. Double-press the RESET button and the Green LED will be waving, indicating it has entered bootloader mode. Please retry uploading the sketch afterward. + +- Verify that the BOOT DIP switch of the Portenta Max Carrier has been configured to an address. Otherwise, the paired Portenta H7 will go into bootloader mode after power-on and it will not initialize the program. + + + diff --git a/content/hardware/05.nicla/boards/nicla-vision/datasheet/assets/niclaVisionTopTopology.svg b/content/hardware/05.nicla/boards/nicla-vision/datasheet/assets/niclaVisionTopTopology.svg index d4517a6f52..157c6843b6 100644 --- a/content/hardware/05.nicla/boards/nicla-vision/datasheet/assets/niclaVisionTopTopology.svg +++ b/content/hardware/05.nicla/boards/nicla-vision/datasheet/assets/niclaVisionTopTopology.svg @@ -1,704 +1,704 @@ - - - - - -Created by potrace 1.16, written by Peter Selinger 2001-2019 - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + +Created by potrace 1.16, written by Peter Selinger 2001-2019 + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/resources/datasheets/bq24195-datasheet.pdf b/static/resources/datasheets/bq24195-datasheet.pdf new file mode 100644 index 0000000000..c253908a13 Binary files /dev/null and b/static/resources/datasheets/bq24195-datasheet.pdf differ