Daniel Lee / Mbed OS mbed-os-example-cellular-TPB23

This is an example based on mbed-os cellular APIs that demonstrates a TCP or UDP echo transaction with a public echo server. Included TPB23 NB-IoT module which is can use LGU+ in Korea.

This example is showing how to use the NB-IoT(SECOM TPB23 module) of LGU plus network in Korea. The NB-IoT module' seller provided a document on how to start based on Mbed OS 5.11. (Created by CodeZoo) This guide has been supported to the latest os version which included 5.12 ~ 5.15.

  • if you need specific version of Mbed OS, please revision of TPB23_Driver and check it out.
  • Pelion ready example code is here!

Requirement

462 320 320

320

Tested with

1. Import the application into your desktop 

mbed import http://os.mbed.com/users/Daniel_Lee/code/mbed-os-example-cellular-TPB23/

cd mbed-os-example-cellular-TPB23

2. Compile and program 

mbed compile -t <toolchain> -m <TARGET_BOARD>

(supported toolchains : GCC_ARM / ARM / IAR)

3. Download binary to a target board

4. Result 

mbed-os-example-cellular


Built: Aug  7 2019, 06:10:47


[MAIN], plmn: NULL
Establishing connection
[00000001ms][INFO][CELL]: New CellularContext  (20000a08)
[00000002ms][INFO][CELL]: CellularContext plmn NULL
[00000003ms][INFO][CELL]: CellularContext connect
[00000036ms][INFO][CELL]: RSSI -69 dBm
[00000036ms][INFO][CELL]: Start connecting (timeout 1 s)
[00000087ms][INFO][CELL]: RSSI -69 dBm
[00000116ms][INFO][CELL]: Modem ready
[00000146ms][INFO][CELL]: RSSI -69 dBm
[00000146ms][INFO][CELL]: Setup SIM (timeout 1 s)
[00001233ms][INFO][CELL]: Looked up APN internet
[00001362ms][ERR ][CELL]: AT error code 50
[00001362ms][WARN][CELL]: Packet domain event reporting set failed!
[00001393ms][INFO][CELL]: RSSI -65 dBm
[00001393ms][INFO][CELL]: Network registration (timeout 180 s)
[00001443ms][INFO][CELL]: Registering network => Attaching network
[00001473ms][INFO][CELL]: RSSI -65 dBm
[00001473ms][INFO][CELL]: Attaching network (timeout 60 s)
[00001601ms][INFO][CELL]: Found PDP context 1
[00001649ms][INFO][CELL]: Activate PDP context 1


Connection Established.
[00001671ms][INFO][CELL]: Socket 0 open
[00001707ms][INFO][CELL]: Socket 1 open
[00001748ms][INFO][CELL]: Socket create id: 1
[00001883ms][INFO][CELL]: Socket 1 sent 43 bytes to 8.8.8.8 port 53
[00004311ms][INFO][CELL]: Socket 1 recv 59 bytes from 8.8.8.8 port 53
[00004331ms][INFO][CELL]: Close socket: 1 error: 0
[00004331ms][INFO][CELL]: Socket 1 closed
[00004373ms][INFO][CELL]: Socket create id: 1
TCP: connected with echo.mbedcloudtesting.com server
[00004448ms][INFO][CELL]: Socket 0 sent 4 bytes to 52.215.34.155 port 7
TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
[00007560ms][INFO][CELL]: Socket 0 recv 4 bytes
[00007580ms][INFO][CELL]: Close socket: 1 error: 0
[00007580ms][INFO][CELL]: Socket 0 closed
Received from echo server 4 Bytes
[00007581ms][INFO][CELL]: CellularContext disconnect()
[00007630ms][INFO][CELL]: cb: CellularContext disconnected


Success. Exiting

SERCOMM/TPB23/SERCOMM_TPB23.cpp@45:63eba30af193, 2019-08-07 (annotated)

Committer:
Daniel_Lee
Date:
Wed Aug 07 06:31:31 2019 +0000
Revision:
45:63eba30af193
Child:
46:387c2d922a4a
Update for Mbed OS 5.12.x; This code was tested on Mbed OS 5.12.2, please check code revision!

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Daniel_Lee 45:63eba30af193 1 /*
Daniel_Lee 45:63eba30af193 2 * Copyright (c) 2017, Arm Limited and affiliates.
Daniel_Lee 45:63eba30af193 3 * SPDX-License-Identifier: Apache-2.0
Daniel_Lee 45:63eba30af193 4 *
Daniel_Lee 45:63eba30af193 5 * Licensed under the Apache License, Version 2.0 (the "License");
Daniel_Lee 45:63eba30af193 6 * you may not use this file except in compliance with the License.
Daniel_Lee 45:63eba30af193 7 * You may obtain a copy of the License at
Daniel_Lee 45:63eba30af193 8 *
Daniel_Lee 45:63eba30af193 9 * http://www.apache.org/licenses/LICENSE-2.0
Daniel_Lee 45:63eba30af193 10 *
Daniel_Lee 45:63eba30af193 11 * Unless required by applicable law or agreed to in writing, software
Daniel_Lee 45:63eba30af193 12 * distributed under the License is distributed on an "AS IS" BASIS,
Daniel_Lee 45:63eba30af193 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Daniel_Lee 45:63eba30af193 14 * See the License for the specific language governing permissions and
Daniel_Lee 45:63eba30af193 15 * limitations under the License.
Daniel_Lee 45:63eba30af193 16 */
Daniel_Lee 45:63eba30af193 17
Daniel_Lee 45:63eba30af193 18 #include "SERCOMM_TPB23_CellularNetwork.h"
Daniel_Lee 45:63eba30af193 19 #include "SERCOMM_TPB23_CellularContext.h"
Daniel_Lee 45:63eba30af193 20 #include "SERCOMM_TPB23_CellularInformation.h"
Daniel_Lee 45:63eba30af193 21 #include "SERCOMM_TPB23.h"
Daniel_Lee 45:63eba30af193 22 #include "CellularLog.h"
Daniel_Lee 45:63eba30af193 23
Daniel_Lee 45:63eba30af193 24 #define CONNECT_DELIM "\r\n"
Daniel_Lee 45:63eba30af193 25 #define CONNECT_BUFFER_SIZE (1280 + 80 + 80) // AT response + sscanf format
Daniel_Lee 45:63eba30af193 26 #define CONNECT_TIMEOUT 8000
Daniel_Lee 45:63eba30af193 27
Daniel_Lee 45:63eba30af193 28 using namespace events;
Daniel_Lee 45:63eba30af193 29 using namespace mbed;
Daniel_Lee 45:63eba30af193 30
Daniel_Lee 45:63eba30af193 31 static const intptr_t cellular_properties[AT_CellularBase::PROPERTY_MAX] = {
Daniel_Lee 45:63eba30af193 32 AT_CellularNetwork::RegistrationModeLAC, // C_EREG
Daniel_Lee 45:63eba30af193 33 AT_CellularNetwork::RegistrationModeDisable, // C_GREG
Daniel_Lee 45:63eba30af193 34 AT_CellularNetwork::RegistrationModeDisable, // C_REG
Daniel_Lee 45:63eba30af193 35 1, // AT_CGSN_WITH_TYPE
Daniel_Lee 45:63eba30af193 36 1, // AT_CGDATA
Daniel_Lee 45:63eba30af193 37 0, // AT_CGAUTH
Daniel_Lee 45:63eba30af193 38 1, // AT_CNMI
Daniel_Lee 45:63eba30af193 39 1, // AT_CSMP
Daniel_Lee 45:63eba30af193 40 1, // AT_CMGF
Daniel_Lee 45:63eba30af193 41 1, // AT_CSDH
Daniel_Lee 45:63eba30af193 42 1, // PROPERTY_IPV4_STACK
Daniel_Lee 45:63eba30af193 43 0, // PROPERTY_IPV6_STACK
Daniel_Lee 45:63eba30af193 44 0, // PROPERTY_IPV4V6_STACK
Daniel_Lee 45:63eba30af193 45 0, // PROPERTY_NON_IP_PDP_TYPE
Daniel_Lee 45:63eba30af193 46 1, // PROPERTY_AT_CGEREP
Daniel_Lee 45:63eba30af193 47 };
Daniel_Lee 45:63eba30af193 48
Daniel_Lee 45:63eba30af193 49 SERCOMM_TPB23::SERCOMM_TPB23(FileHandle *fh) : AT_CellularDevice(fh)
Daniel_Lee 45:63eba30af193 50 {
Daniel_Lee 45:63eba30af193 51 AT_CellularBase::set_cellular_properties(cellular_properties);
Daniel_Lee 45:63eba30af193 52 }
Daniel_Lee 45:63eba30af193 53
Daniel_Lee 45:63eba30af193 54 nsapi_error_t SERCOMM_TPB23::get_sim_state(SimState &state)
Daniel_Lee 45:63eba30af193 55 {
Daniel_Lee 45:63eba30af193 56 _at->lock();
Daniel_Lee 45:63eba30af193 57 _at->flush();
Daniel_Lee 45:63eba30af193 58 _at->cmd_start("AT+NCCID?");
Daniel_Lee 45:63eba30af193 59 _at->cmd_stop();
Daniel_Lee 45:63eba30af193 60 _at->resp_start("+NCCID:");
Daniel_Lee 45:63eba30af193 61 if (_at->info_resp()) {
Daniel_Lee 45:63eba30af193 62 state = SimStateReady;
Daniel_Lee 45:63eba30af193 63 } else {
Daniel_Lee 45:63eba30af193 64 tr_warn("SIM not readable.");
Daniel_Lee 45:63eba30af193 65 state = SimStateUnknown; // SIM may not be ready yet
Daniel_Lee 45:63eba30af193 66 }
Daniel_Lee 45:63eba30af193 67 _at->resp_stop();
Daniel_Lee 45:63eba30af193 68 return _at->unlock_return_error();
Daniel_Lee 45:63eba30af193 69 }
Daniel_Lee 45:63eba30af193 70
Daniel_Lee 45:63eba30af193 71 AT_CellularNetwork *SERCOMM_TPB23::open_network_impl(ATHandler &at)
Daniel_Lee 45:63eba30af193 72 {
Daniel_Lee 45:63eba30af193 73 return new SERCOMM_TPB23_CellularNetwork(at);
Daniel_Lee 45:63eba30af193 74 }
Daniel_Lee 45:63eba30af193 75
Daniel_Lee 45:63eba30af193 76 AT_CellularContext *SERCOMM_TPB23::create_context_impl(ATHandler &at, const char *apn, bool cp_req, bool nonip_req)
Daniel_Lee 45:63eba30af193 77 {
Daniel_Lee 45:63eba30af193 78 return new SERCOMM_TPB23_CellularContext(at, this, apn, cp_req, nonip_req);
Daniel_Lee 45:63eba30af193 79 }
Daniel_Lee 45:63eba30af193 80
Daniel_Lee 45:63eba30af193 81 AT_CellularInformation *SERCOMM_TPB23::open_information_impl(ATHandler &at)
Daniel_Lee 45:63eba30af193 82 {
Daniel_Lee 45:63eba30af193 83 return new SERCOMM_TPB23_CellularInformation(at);
Daniel_Lee 45:63eba30af193 84 }
Daniel_Lee 45:63eba30af193 85
Daniel_Lee 45:63eba30af193 86 nsapi_error_t SERCOMM_TPB23::init()
Daniel_Lee 45:63eba30af193 87 {
Daniel_Lee 45:63eba30af193 88 _at->lock();
Daniel_Lee 45:63eba30af193 89 _at->flush();
Daniel_Lee 45:63eba30af193 90 _at->cmd_start("AT");
Daniel_Lee 45:63eba30af193 91 _at->cmd_stop_read_resp();
Daniel_Lee 45:63eba30af193 92
Daniel_Lee 45:63eba30af193 93 _at->cmd_start("AT+CMEE="); // verbose responses
Daniel_Lee 45:63eba30af193 94 _at->write_int(1);
Daniel_Lee 45:63eba30af193 95 _at->cmd_stop_read_resp();
Daniel_Lee 45:63eba30af193 96
Daniel_Lee 45:63eba30af193 97 return _at->unlock_return_error();
Daniel_Lee 45:63eba30af193 98 }
Daniel_Lee 45:63eba30af193 99
Daniel_Lee 45:63eba30af193 100 #if MBED_CONF_SERCOMM_TPB23_PROVIDE_DEFAULT
Daniel_Lee 45:63eba30af193 101 #include "UARTSerial.h"
Daniel_Lee 45:63eba30af193 102 CellularDevice *CellularDevice::get_default_instance()
Daniel_Lee 45:63eba30af193 103 {
Daniel_Lee 45:63eba30af193 104 static UARTSerial serial(MBED_CONF_SERCOMM_TPB23_TX, MBED_CONF_SERCOMM_TPB23_RX, MBED_CONF_SERCOMM_TPB23_BAUDRATE);
Daniel_Lee 45:63eba30af193 105 static SERCOMM_TPB23 device(&serial);
Daniel_Lee 45:63eba30af193 106 return &device;
Daniel_Lee 45:63eba30af193 107 }
Daniel_Lee 45:63eba30af193 108 #endif