Revision 0:4858efb34078, committed 2019-04-22

Comitter:

wajahat.abbas@u-blox.com

Date:

Mon Apr 22 11:34:03 2019 +0500

Child:

1:cae5c9c56a2f

Commit message:

Initial check-in for PSM example

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,385 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2017 u-blox
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "mbed.h"
+#include "UbloxATCellularInterface.h"
+#include "OnboardCellularInterface.h"
+#include "UbloxATCellularInterfaceN2xx.h"
+
+// You must select the correct interface library for your board, by
+// uncommenting the correct line below. Supported combinations are
+// indicated with a "Y" in the table below.
+//
+//                            C030_U201   C030_N211      C027
+// UbloxATCellularInterface       Y            -           Y
+// OnboardCellularInterface       Y            -           Y
+// UbloxATCellularInterfaceN2xx   -            Y           -
+// Note: the N211 module supports only UDP, not TCP
+
+// OnboardCellularInterface uses LWIP and the PPP cellular interface
+// on the mbed MCU, while using UbloxATCellularInterface and
+// UbloxATCellularInterfaceN2xx uses an IP stack on the cellular
+// module and hence uses less RAM (significant on C027).  This also
+// allows other AT command operations (e.g. sending an SMS) to happen
+// during a data transfer (for which you should replace the
+// UbloxATCellularInterface library with the UbloxATCellularInterfaceExt
+// library).  However, it is slower than using the LWIP/PPP on the mbed
+// MCU interface since more string parsing is required.
+#define INTERFACE_CLASS  UbloxATCellularInterface
+//#define INTERFACE_CLASS  OnboardCellularInterface
+//#define INTERFACE_CLASS  UbloxATCellularInterfaceN2xx
+
+// The credentials of the SIM in the board.  If PIN checking is enabled
+// for your SIM card you must set this to the required PIN.
+#define PIN "0000"
+
+// Network credentials.  You should set this according to your
+// network/SIM card.  For C030 non-N2xx boards, leave the parameters as NULL
+// otherwise, if you do not know the APN for your network, you may
+// either try the fairly common "internet" for the APN (and leave the
+// username and password NULL), or you may leave all three as NULL and then
+// a lookup will be attempted for a small number of known networks
+// (see APN_db.h in mbed-os/features/netsocket/cellular/utils).
+#define APN         NULL
+#define USERNAME    NULL
+#define PASSWORD    NULL
+
+
+// Uncomment the following line to enable Icellular Current measurement.
+// Current drawn by modem is printed on serial every 2 seconds.
+//#define CURRENT_MEASUREMENT
+
+// LEDs
+DigitalOut ledRed(LED1, 1);
+DigitalOut ledGreen(LED2, 1);
+DigitalOut ledBlue(LED3, 1);
+
+// The user button
+volatile bool buttonPressed = false;
+#ifdef TARGET_UBLOX_C030_R412M
+volatile bool modem_asleep = false;
+#ifdef CURRENT_MEASUREMENT
+AnalogIn ain_icellular(MDMCURRENTSENSE);
+Thread icell_thread;
+#endif
+#endif
+
+static void good() {
+    ledGreen = 0;
+    ledBlue = 1;
+    ledRed = 1;
+}
+
+static void bad() {
+    ledRed = 0;
+    ledGreen = 1;
+    ledBlue = 1;
+}
+
+static void event() {
+    ledBlue = 0;
+    ledRed = 1;
+    ledGreen = 1;
+}
+
+static void pulseEvent() {
+    event();
+    wait_ms(500);
+    good();
+}
+
+static void ledOff() {
+    ledBlue = 1;
+    ledRed = 1;
+    ledGreen = 1;
+}
+
+static void printNtpTime(char * buf, int len)
+{
+    time_t timestamp = 0;
+    struct tm *localTime;
+    char timeString[25];
+    time_t TIME1970 = 2208988800U;
+
+    if (len >= 43) {
+        timestamp |= ((int) *(buf + 40)) << 24;
+        timestamp |= ((int) *(buf + 41)) << 16;
+        timestamp |= ((int) *(buf + 42)) << 8;
+        timestamp |= ((int) *(buf + 43));
+        timestamp -= TIME1970;
+        localTime = localtime(&timestamp);
+        if (localTime) {
+            if (strftime(timeString, sizeof(timeString), "%a %b %d %H:%M:%S %Y", localTime) > 0) {
+                printf("NTP timestamp is %s.\n", timeString);
+            }
+        }
+    }
+}
+
+static void cbButton()
+{
+    buttonPressed = true;
+    //pulseEvent();
+}
+
+void init_modem(INTERFACE_CLASS *interface) {
+    int x;
+
+    for (x = 0; interface->connect(PIN) != 0; x++) {
+        if (x > 0) {
+            bad();
+            printf("Retrying (have you checked that an antenna is plugged in and your APN is correct?)...\n");
+        }
+    }
+}
+#ifdef TARGET_UBLOX_C030_R412M
+void psm_going_in_cb(void *param)
+{
+    printf("PSM callback function:: Modem going in to sleep\n");
+    modem_asleep = true;
+}
+#ifdef CURRENT_MEASUREMENT
+float calculate_icellular_samples() {
+    float ain=0.0f;
+    float icellular_val;
+    const int c_number_of_analog_samples = 50;
+
+    ain = 0;
+    for(int i = 0; i < c_number_of_analog_samples; i++) {
+        ain = (ain + ain_icellular.read());
+        Thread::wait(2);
+    }
+    ain = ain/c_number_of_analog_samples;
+    icellular_val = (ain*1.8*1000)/7.0f;
+
+
+    printf("Voltage in mV: %f\n", icellular_val * 7.0f);
+    printf("Current draw in mA: %f\n\n", icellular_val);
+
+    return icellular_val;
+}
+
+void icell_thread_handler() {
+
+    while(1) {
+        Thread::wait(2000);
+        calculate_icellular_samples();
+    }
+}
+#endif
+#endif
+
+/* This example program for the u-blox C030-R410M board instantiates
+ * the UbloxATCellularInterface or OnboardCellularInterface and uses it
+ * to make a simple sockets connection to a server, using 2.pool.ntp.org
+ * for UDP and developer.mbed.org for TCP. It also showcases the 3GPP PSM
+ * feature. For a more comprehensive example, where higher layer protocols
+ * make use of the same sockets interface, see example-ublox-mbed-client.
+ * Progress may be monitored with a serial terminal running at 9600 baud.
+ * The LED on the C030 board will turn green when this program is
+ * operating correctly, pulse blue when a sockets operation is completed
+ * and turn red if there is a failure.
+ */
+int main()
+{
+#ifdef TARGET_UBLOX_C030_R412M
+#ifdef CURRENT_MEASUREMENT
+    //current monitoring using Icellular
+    icell_thread.start(icell_thread_handler);
+#endif
+    int status = 0, pt = 0, at = 0;
+#endif
+    INTERFACE_CLASS *interface = new INTERFACE_CLASS();
+    // If you need to debug the cellular interface, comment out the
+    // instantiation above and uncomment the one below.
+    // For the N2xx interface, change xxx to MBED_CONF_UBLOX_CELL_BAUD_RATE,
+    // while for the non-N2xx interface change it to MBED_CONF_UBLOX_CELL_N2XX_BAUD_RATE.
+//    INTERFACE_CLASS *interface = new INTERFACE_CLASS(MDMTXD, MDMRXD,
+//                                                     xxx,
+//                                                     true);
+#ifndef TARGET_UBLOX_C030_N211
+    TCPSocket sockTcp;
+#endif
+    UDPSocket sockUdp;
+    SocketAddress udpServer;
+    SocketAddress udpSenderAddress;
+    SocketAddress tcpServer;
+    char buf[1024];
+    int x;
+#ifdef TARGET_UBLOX_C027
+    // No user button on C027
+    InterruptIn userButton(NC);
+#else
+    InterruptIn userButton(SW0);
+#endif
+
+    // Attach a function to the user button
+    userButton.rise(&cbButton);
+
+    good();
+    printf("Initializing modem, please wait.\n");
+    if (interface->init(PIN) == false) //setup modem
+    {
+        bad();
+        printf("Failed to Initialize modem\n");
+        while(1);
+    }
+    printf("Initialization complete.\n");
+    pulseEvent();
+
+#ifdef TARGET_UBLOX_C030_R412M
+    printf("Enabling PSM...\n");
+    if (interface->set_power_saving_mode(120, 30)) { //enable PSM
+        printf("PSM enabled. Attaching CB function and rebooting the module\n");
+        interface->attach_cb_psm_going_in(&psm_going_in_cb, NULL); //register callback
+
+        //reset modem so that PSM settings can take effect
+        interface->reboot_modem();
+        wait_ms(5000); //give modem a little time
+
+        printf("please wait up to 180 seconds for network registration to complete...\n");
+        //try to re-init modem and perform registration
+        for (x = 0; interface->connect(PIN) != 0; x++) {
+            if (x > 0) {
+                bad();
+                printf("Retrying (have you checked that an antenna is plugged in and your APN is correct?)...\n");
+            }
+        }
+
+        interface->get_power_saving_mode(&status, &pt, &at); //read assigned values
+        printf("PSM status: %s\nAssigned Periodic TAU: %d\nAssigned Active time: %d\n", status ? "enabled" : "disabled", pt, at);
+        pulseEvent();
+    }
+
+    //sometimes modem goes in to PSM before we can do any UDP/TCP transfers
+    if (modem_asleep == true) {
+        printf("Modem is in PSM, waking up and initializing it\n");
+        interface->wakeup_modem(); //this wakes up the modem and also CellularBase gets synced with modem state.
+        init_modem(interface);
+        modem_asleep = false;
+        printf("Initialization complete\n");
+    }
+#endif
+
+    printf("Getting the IP address of \"developer.mbed.org\" and \"2.pool.ntp.org\"...\n");
+    if ((interface->gethostbyname("2.pool.ntp.org", &udpServer) == 0) &&
+        (interface->gethostbyname("developer.mbed.org", &tcpServer) == 0)) {
+        pulseEvent();
+
+        udpServer.set_port(123);
+        printf("\"2.pool.ntp.org\" address: %s on port %d.\n", udpServer.get_ip_address(), udpServer.get_port());
+        printf("\"developer.mbed.org\" address: %s on port %d.\n", tcpServer.get_ip_address(), tcpServer.get_port());
+        tcpServer.set_port(80);
+
+        printf("Performing socket operations in a loop (until the user button is pressed on C030 or forever on C027)...\n");
+        while (!buttonPressed) {
+#ifdef TARGET_UBLOX_C030_R412M
+            if (modem_asleep == true) {
+                printf("Modem is in PSM, waking up and initializing it\n");
+                interface->wakeup_modem(); //this wakes up the modem and also CellularBase gets synced with modem state.
+                init_modem(interface);
+                modem_asleep = false;
+                printf("Initialization complete\n");
+                wait_ms(5000);
+            } else {
+#endif
+                printf("Opening a UDP socket...\n");
+                if ((sockUdp.open(interface)) == 0) {
+                    // UDP Sockets
+                    pulseEvent();
+                    printf("UDP socket open.\n");
+                    sockUdp.set_timeout(20000);
+                    printf("Sending time request to \"2.pool.ntp.org\" over UDP socket...\n");
+                    memset (buf, 0, sizeof(buf));
+                    *buf = '\x1b';
+                    if (sockUdp.sendto(udpServer, (void *) buf, 48) == 48) {
+                        pulseEvent();
+                        printf("Socket send completed, waiting for UDP response...\n");
+                        x = sockUdp.recvfrom(&udpSenderAddress, buf, sizeof (buf));
+                        if (x > 0) {
+                            pulseEvent();
+                            printf("Received %d byte response from server %s on UDP socket:\n"
+                                "-------------------------------------------------------\n",
+                                x, udpSenderAddress.get_ip_address());
+                            printNtpTime(buf, x);
+                            printf("-------------------------------------------------------\n");
+                        }
+                    }
+                    printf("Closing socket...\n");
+                    sockUdp.close();
+                    pulseEvent();
+                    printf("Socket closed.\n");
+                }
+#ifndef TARGET_UBLOX_C030_N211
+                printf("Opening a TCP socket...\n");
+                if ((sockTcp.open(interface)) == 0) {
+                    // TCP Sockets
+                    pulseEvent();
+                    printf("TCP socket open.\n");
+                    sockTcp.set_timeout(10000);
+                    printf("Connecting socket to %s on port %d...\n", tcpServer.get_ip_address(), tcpServer.get_port());
+                    if (sockTcp.connect(tcpServer) == 0) {
+                        pulseEvent();
+                        printf("Connected, sending HTTP GET request to \"developer.mbed.org\" over socket...\n");
+                        strcpy (buf, "GET /media/uploads/mbed_official/hello.txt HTTP/1.0\r\n\r\n");
+                        // Note: since this is a short string we can send it in one go as it will
+                        // fit within the default buffer sizes.  Normally you should call sock.send()
+                        // in a loop until your entire buffer has been sent.
+                        if (sockTcp.send((void *) buf, strlen(buf)) == (int) strlen(buf)) {
+                            pulseEvent();
+                            printf("Socket send completed, waiting for response...\n");
+                            x = sockTcp.recv(buf, sizeof (buf));
+                            if (x > 0) {
+                                pulseEvent();
+                                printf("Received %d byte response from server on TCP socket:\n"
+                                    "----------------------------------------------------\n%.*s"
+                                    "----------------------------------------------------\n",
+                                        x, x, buf);
+                            }
+                        }
+                    }
+                    printf("Closing socket...\n");
+                    sockTcp.close();
+                    pulseEvent();
+                    printf("Socket closed.\n");
+                }
+#ifdef TARGET_UBLOX_C030_R412M
+                while(modem_asleep == false) { //modem is awake, let it go to sleep again
+                    printf("Waiting for modem to go to PSM sleep\n");
+                    wait_ms(5000);
+                }
+            }
+#endif /* TARGET_UBLOX_C030_R412M */
+#endif /* TARGET_UBLOX_C030_N211 */
+
+            wait_ms(5000);
+#ifndef TARGET_UBLOX_C027
+            printf("\n\n[Checking if user button has been pressed]\n");
+#endif
+        }
+
+        pulseEvent();
+        printf("User button was pressed, stopping...\n");
+        interface->disconnect();
+        ledOff();
+        printf("Stopped.\n");
+    } else {
+        bad();
+        printf("Unable to get IP address of \"developer.mbed.org\" or \"2.pool.ntp.org\".\n");
+    }
+}
+
+// End Of File

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-os.lib	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,1 @@
+https://github.com/ARMmbed/mbed-os/#57d8915a899a59999d7e2a9695e20a8a18cb54bd

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed_app.json	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,9 @@
+{
+    "target_overrides": {
+        "*": {
+            "lwip.ppp-enabled": true,
+            "platform.stdio-convert-newlines": true
+        }
+    }
+}
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ublox-at-cellular-interface-n2xx.lib	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,1 @@
+https://developer.mbed.org/teams/ublox/code/ublox-at-cellular-interface-n2xx/#7fb0bbdc4242

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ublox-at-cellular-interface.lib	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,1 @@
+https://os.mbed.com/teams/ublox/code/ublox-at-cellular-interface
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ublox-cellular-base-n2xx.lib	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,1 @@
+https://developer.mbed.org/teams/ublox/code/ublox-cellular-base-n2xx/#1afe5ed24f0c

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ublox-cellular-base.lib	Mon Apr 22 11:34:03 2019 +0500
@@ -0,0 +1,1 @@
+https://os.mbed.com/users/Wajahat/code/ublox-cellular-base_PSM/
\ No newline at end of file