Manuels d'utilisation pour Digi International Inc XB3C1

Table des matières

• Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide

  9
  • Applicable firmware and hardware

    9
  • SIM cards

    9
• Getting started with the XBee Smart Modem Development Kit

  10
  • Identify the kit contents

    11
  • XBIB-U-DEV reference

    12
  • Cellular service

    13
  • Connect the hardware

    14
  • Configure the device using XCTU

    15
    • Add a device

      15
    • Check for cellular registration and connection

      16
    • Update to the latest firmware

      16
  • Send an SMS message to a phone

    18
    • Debugging

      19
  • Connect to the ELIZA server

    20
    • Debugging

      21
  • Connect to the echo server

    22
    • Debugging

      23
  • Connect to the Daytime server

    24
    • Debugging

      25
  • Connect to a TCP/IP address

    26
    • Debugging

      27
  • Perform a (GET) HTTP request

    28
    • Debugging

      29
  • Get started with MQTT

    30
    • Example: MQTT connect

      30
    • Send a connect packet

      32
    • Example: send messages (publish) with MQTT

      34
    • Example: receive messages (subscribe) with MQTT

      34
    • Use MQTT over the XBee Cellular Modem with a PC

      35
  • Get started with CoAP

    39
    • CoAP terms

      39
    • CoAP quick start example

      39
    • Configure the device

      40
    • Example: manually perform a CoAP request

      40
    • Example: use Python to generate a CoAP message

      41
  • Configure the XBee Smart Modem using Digi Remote Manager

    44
    • Create a Remote Manager account

      44
    • Get the XBee Smart Modem IMEI number

      44
    • Add a XBee Smart Modem to Remote Manager

      44
    • Update the firmware

      45
  • Software libraries

    45
• Get started with MicroPython

  46
  • About MicroPython

    47
    • Why use MicroPython

      47
  • MicroPython on the XBee Smart Modem

    47
  • Use XCTU to enter the MicroPython environment

    47
  • Use the MicroPython Terminal in XCTU

    48
  • Example: hello world

    48
  • Example: turn on an LED

    48
  • Example: code a request help button

    49
    • Enter MicroPython paste mode

      50
    • Catch a button press

      50
    • Send a text (SMS) when the button is pressed

      52
    • Add the time the button was pressed

      53
  • Exit MicroPython mode

    54
  • Other terminal programs

    54
    • Tera Term for Windows

      54
  • Use picocom in Linux

    55
• Technical specifications

  57
  • Interface and hardware specifications

    58
  • RF characteristics

    58
  • Networking specifications

    58
  • Power requirements

    58
  • Power consumption

    59
  • Electrical specifications

    59
  • Regulatory approvals

    60
• Hardware

  61
  • Mechanical drawings

    62
  • Pin signals

    62
    • Pin connection recommendations

      63
  • RSSI PWM

    64
  • SIM card

    64
  • The Associate LED

    64
• Antenna recommendations

  66
  • Antenna connections

    67
  • Antenna placement

    68
• Design recommendations

  69
  • Cellular component firmware upgrades

    70
  • USB Direct design

    70
  • Power supply considerations

    70
  • Add a capacitor to the RESET line

    70
  • Heat considerations and testing

    71
  • Heat sink guidelines

    71
  • Add a fan to provide active cooling

    73
• Cellular connection process

  74
  • Connecting

    75
  • Cellular network

    75
  • Data network connection

    75
  • Data communication with remote servers (TCP/UDP)

    75
  • Disconnecting

    75
  • SMS encoding

    76
• Modes

  77
  • Select an operating mode

    78
  • Transparent operating mode

    79
  • API operating mode

    79
  • Bypass operating mode

    79
    • Enter Bypass operating mode

      79
    • Leave Bypass operating mode

      80
    • Restore cellular settings to default in Bypass operating mode

      80
  • USB direct mode

    80
    • Enable USB direct mode

      80
  • Command mode

    80
    • Enter Command mode

      81
    • Send AT commands

      81
    • Apply command changes

      82
    • Make command changes permanent

      82
    • Exit Command mode

      82
• Sleep modes

  83
  • About sleep modes

    84
  • Normal mode

    84
  • Pin sleep mode

    84
  • Cyclic sleep mode

    84
  • Cyclic sleep with pin wake up mode

    84
  • Airplane mode

    84
  • Connected sleep mode

    84
  • The sleep timer

    85
  • MicroPython sleep behavior

    85
• Serial communication

  86
  • Serial interface

    87
  • Serial data

    87
  • UART data flow

    87
  • Serial buffers

    87
  • CTS flow control

    88
  • RTS flow control

    88
• AT commands

  89
  • MicroPython commands

    90
    • PS (Python Startup)

      90
    • PY (MicroPython Command)

      90
  • Special commands

    91
    • AC (Apply Changes)

      91
    • FR (Force Reset)

      91
    • RE command

      92
    • WR command

      92
  • Cellular commands

    92
    • PH (Phone Number)

      92
    • S# (ICCID)

      92
    • IM (IMEI)

      93
    • MN (Operator)

      93
    • MV (Modem Firmware Version)

      93
    • DB (Cellular Signal Strength)

      93
    • AN (Access Point Name)

      93
    • OA (Operating APN)

      94
    • AM (Airplane Mode)

      94
    • DV (Antenna Diversity)

      94
  • Network commands

    95
    • IP (IP Protocol)

      95
    • TL (SSL/TLS Protocol Version)

      95
    • TM (IP Client Connection Timeout)

      95
    • TS (IP Server Connection Timeout)

      96
    • DO (Device Options)

      96
    • EQ (Device Cloud FQDN)

      96
  • Addressing commands

    97
    • SH (Serial Number High)

      97
    • SL (Serial Number Low)

      97
    • DL (Destination Address)

      97
    • P# (Destination Phone Number)

      97
    • N1 (DNS Address)

      98
    • N2 (DNS Address)

      98
    • DE (Destination Port)

      98
    • TD (Text Delimiter)

      98
    • MY (Module IP Address)

      99
    • LA (Lookup IP Address of FQDN)

      99
    • OD (Operating Destination Address)

      99
    • C0 (Source Port)

      99
  • Serial interfacing commands

    100
    • BD (Baud Rate)

      100
    • NB (Parity)

      101
    • SB (Stop Bits)

      101
    • RO (Packetization Timeout)

      101
    • FT (Flow Control Threshold)

      101
    • AP (API Enable)

      102
  • I/O settings commands

    102
    • D0 (DIO0/AD0)

      102
    • D1 (DIO1/AD1)

      103
    • D2 (DIO2/AD2)

      103
    • D3 (DIO3/AD3)

      104
    • D4 (DIO4)

      104
    • D5 (DIO5/ASSOCIATED_INDICATOR)

      105
    • D6 (DIO6/RTS)

      105
    • D7 (DIO7/CTS)

      105
    • D8 (DIO8/SLEEP_REQUEST)

      106
    • P0 (DIO10/PWM0 Configuration)

      107
    • P1 (DIO11/PWM1 Configuration)

      107
    • P2 (DIO12 Configuration)

      108
    • PD (Pull Direction)

      108
    • PR (Pull-up/down Resistor Enable)

      109
    • M0 (PWM0 Duty Cycle)

      109
  • I/O sampling commands

    110
    • TP (Temperature)

      110
  • Sleep commands

    110
    • SM (Sleep Mode)

      110
    • SP (Sleep Period)

      111
    • ST (Wake Time)

      111
    • SO (Sleep Options)

      111
  • Command mode options

    112
    • CC (Command Sequence Character)

      112
    • CT (Command Mode Timeout)

      112
    • GT (Guard Times)

      112
  • Firmware version/information commands

    112
    • VR (Firmware Version)

      112
    • VL (Verbose Firmware Version)

      113
    • HV (Hardware Version)

      113
    • AI (Association Indication)

      113
    • HS (Hardware Series)

      114
    • CK (Configuration CRC)

      114
  • Diagnostic interface commands

    114
    • DI (Device Cloud Indicator)

      114
    • CI (Protocol/Connection Indication)

      114
  • Execution commands

    116
    • NR (Network Reset)

      116
    • !R (Modem Reset)

      117
    • IS (Force Sample)

      117
• Operate in API mode

  119
  • API mode overview

    120
  • Use the AP command to set the operation mode

    120
  • API frame format

    120
    • API operation (AP parameter = 1)

      120
    • API operation with escaped characters (AP parameter = 2)

      121
  • Frame descriptions

    124
    • AT Command - 0x08

      124
    • Transmit (TX) SMS - 0x1F

      125
    • Transmit (TX) Request: IPv4 - 0x20

      126
    • AT Command Response - 0x88

      127
    • Transmit (TX) Status - 0x89

      128
    • Modem Status - 0x8A

      129
    • Receive (RX) Packet: SMS - 0x9F

      130
    • Receive (RX) Packet: IPv4 - 0xB0

      131
• Socket behavior

  132
  • Supported sockets

    133
  • Secure Sockets Layer (SSL) certificate checking

    133
  • Socket timeouts

    133
  • Socket limits in API mode

    133
  • Enable incoming TCP connections

    133
  • API mode behavior for outgoing TCP and SSL connections

    134
  • API mode behavior for outgoing UDP data

    134
  • API mode behavior for incoming TCP connections

    135
  • API mode behavior for incoming UDP data

    135
  • Transparent mode behavior for outgoing TCP and SSL connections

    135
  • Transparent mode behavior for outgoing UDP data

    136
  • Transparent mode behavior for incoming TCP connections

    136
  • Transparent mode behavior for incoming UDP connections

    136
• Troubleshooting

  137
  • Cannot find the serial port for the device

    138
    • Condition

      138
    • Solution

      138
  • Correct a macOS Java error

    140
    • Condition

      140
    • Solution

      140
  • Unresponsive cellular component in Bypass mode

    141
    • Condition

      141
    • Solution

      141
  • Not on expected network after APN change

    142
    • Condition

      142
    • Solution

      142
  • Syntax error at line 1

    142
    • Solution

      142
  • Error Failed to send SMS

    142
    • Solution

      142
• Regulatory information

  143
  • Modification statement

    144
  • Interference statement

    144
  • FCC Class B digital device notice

    144
  • RF exposure

    145
  • FCC-approved antennas

    145
    • Bluetooth antennas

      145
    • Dipole antennas

      145
    • Flex PCB antennas

      145
    • Cellular antennas

      146
  • Labeling requirements for the host device

    146