Jim Flynn / Mbed OS aws-iot-device-sdk-mbed-c

Changes to enabled on-line compiler

platform/ezconnect/BG96-driver/README.md@0:082731ede69f, 2018-05-30 (annotated)

Committer:
JMF
Date:
Wed May 30 20:59:51 2018 +0000
Revision:
0:082731ede69f
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:082731ede69f 1 # Mbed OS v5.x Network Interface driver for Quectel BG96
JMF 0:082731ede69f 2
JMF 0:082731ede69f 3 ## Specifying library configuration and settings
JMF 0:082731ede69f 4
JMF 0:082731ede69f 5 The following settings configure the I/O settings for the BG96 Driver. The
JMF 0:082731ede69f 6 current settings are for the AVNET RSR1157 NbIOT BG96 expansion board. If you
JMF 0:082731ede69f 7 use a different board, the settings maydiffer.
JMF 0:082731ede69f 8
JMF 0:082731ede69f 9 ```json
JMF 0:082731ede69f 10 {
JMF 0:082731ede69f 11 "name": "BG96_library",
JMF 0:082731ede69f 12 "config": {
JMF 0:082731ede69f 13 "bg96_reset": {
JMF 0:082731ede69f 14 "help": "RESET pin for the BG96",
JMF 0:082731ede69f 15 "value": "D7"
JMF 0:082731ede69f 16 },
JMF 0:082731ede69f 17 "bg96_wake": {
JMF 0:082731ede69f 18 "help": "Wake pin to BG96",
JMF 0:082731ede69f 19 "value": "D11"
JMF 0:082731ede69f 20 },
JMF 0:082731ede69f 21 "bg96_pwrkey": {
JMF 0:082731ede69f 22 "help": "pwr key input to BG96",
JMF 0:082731ede69f 23 "value": "D10"
JMF 0:082731ede69f 24 },
JMF 0:082731ede69f 25 "bg96_tx": {
JMF 0:082731ede69f 26 "help": "TX pin for serial connection to BG96",
JMF 0:082731ede69f 27 "value": "D8"
JMF 0:082731ede69f 28 },
JMF 0:082731ede69f 29 "bg96_rx": {
JMF 0:082731ede69f 30 "help": "RX pin for serial connection to BG96",
JMF 0:082731ede69f 31 "value": "D2"
JMF 0:082731ede69f 32 }
JMF 0:082731ede69f 33 }
JMF 0:082731ede69f 34 }
JMF 0:082731ede69f 35 ```
JMF 0:082731ede69f 36
JMF 0:082731ede69f 37 ## Specifing the application configuration settings
JMF 0:082731ede69f 38
JMF 0:082731ede69f 39 In the mbed_app.json file that is used with this driver, the following settings are
JMF 0:082731ede69f 40 needed.
JMF 0:082731ede69f 41
JMF 0:082731ede69f 42 ```json
JMF 0:082731ede69f 43 {
JMF 0:082731ede69f 44 "macros": ["DEFAULT_APN=\"m2m.com.attz\""
JMF 0:082731ede69f 45 ],
JMF 0:082731ede69f 46 "config": {
JMF 0:082731ede69f 47 "bg96_debug": {
JMF 0:082731ede69f 48 "help" : "enable or disable WNC debug messages.",
JMF 0:082731ede69f 49 "value": 0
JMF 0:082731ede69f 50 },
JMF 0:082731ede69f 51 "bg96-debug-setting": {
JMF 0:082731ede69f 52 "help" : "bit value 1 and/or 2 enable WncController debug output, bit value 4 enables mbed driver debug output.",
JMF 0:082731ede69f 53 "value": "0x84"
JMF 0:082731ede69f 54 }
JMF 0:082731ede69f 55 },
JMF 0:082731ede69f 56 "target_overrides": {
JMF 0:082731ede69f 57 "*": {
JMF 0:082731ede69f 58 "platform.stdio-baud-rate": 115200,
JMF 0:082731ede69f 59 "platform.stdio-convert-newlines": true
JMF 0:082731ede69f 60 }
JMF 0:082731ede69f 61 }
JMF 0:082731ede69f 62 }
JMF 0:082731ede69f 63 ```
JMF 0:082731ede69f 64 ### Default APN
JMF 0:082731ede69f 65
JMF 0:082731ede69f 66 The macro DEFAULT_APN is the APN that will be used when the connect method is called with no argments (if you
JMF 0:082731ede69f 67 don't specify an APN in your code).
JMF 0:082731ede69f 68
JMF 0:082731ede69f 69 ### Debug settings
JMF 0:082731ede69f 70
JMF 0:082731ede69f 71 The bg96_debug setting enables or disabled debug output from the driver.
JMF 0:082731ede69f 72
JMF 0:082731ede69f 73 The bg96-debug-settings allow you to select various types of debug output. It is a bit-field with the following settings:
JMF 0:082731ede69f 74
JMF 0:082731ede69f 75 0x04 - Driver Enter/Exit debug information
JMF 0:082731ede69f 76 0x08 - Driver Event Queue debug information
JMF 0:082731ede69f 77 0x20 - Dump Driver Arrays
JMF 0:082731ede69f 78 0x80 - Trace AT command execution
JMF 0:082731ede69f 79
JMF 0:082731ede69f 80 ### Overriding settings
JMF 0:082731ede69f 81
JMF 0:082731ede69f 82 The driver is designed to use a baud rater of 115200 so this must be specified (it will default to 9600 otherwise). The
JMF 0:082731ede69f 83 convert-newlines helps terminal output format by removing the requirment to modify the terminal program settings.
JMF 0:082731ede69f 84