Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/netsocket/CellularBase.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* Copyright (c) 2017 ARM Limited
demayer 0:6bf0743ece18 2 *
demayer 0:6bf0743ece18 3 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 4 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 5 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 6 *
demayer 0:6bf0743ece18 7 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 8 *
demayer 0:6bf0743ece18 9 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 10 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 12 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 13 * limitations under the License.
demayer 0:6bf0743ece18 14 */
demayer 0:6bf0743ece18 15
demayer 0:6bf0743ece18 16 #ifndef CELLULAR_BASE_H
demayer 0:6bf0743ece18 17 #define CELLULAR_BASE_H
demayer 0:6bf0743ece18 18
demayer 0:6bf0743ece18 19 #include "netsocket/NetworkInterface.h"
demayer 0:6bf0743ece18 20
demayer 0:6bf0743ece18 21 /** CellularBase class
demayer 0:6bf0743ece18 22 *
demayer 0:6bf0743ece18 23 * Common interface that is shared between Cellular interfaces
demayer 0:6bf0743ece18 24 */
demayer 0:6bf0743ece18 25 class CellularBase: public NetworkInterface {
demayer 0:6bf0743ece18 26
demayer 0:6bf0743ece18 27 public:
demayer 0:6bf0743ece18 28
demayer 0:6bf0743ece18 29 /** Set the Cellular network credentials
demayer 0:6bf0743ece18 30 *
demayer 0:6bf0743ece18 31 * Please check documentation of connect() for default behaviour of APN settings.
demayer 0:6bf0743ece18 32 *
demayer 0:6bf0743ece18 33 * @param apn Access point name
demayer 0:6bf0743ece18 34 * @param uname optionally, Username
demayer 0:6bf0743ece18 35 * @param pwd optionally, password
demayer 0:6bf0743ece18 36 */
demayer 0:6bf0743ece18 37 virtual void set_credentials(const char *apn, const char *uname = 0,
demayer 0:6bf0743ece18 38 const char *pwd = 0) = 0;
demayer 0:6bf0743ece18 39
demayer 0:6bf0743ece18 40 /** Set the pin code for SIM card
demayer 0:6bf0743ece18 41 *
demayer 0:6bf0743ece18 42 * @param sim_pin PIN for the SIM card
demayer 0:6bf0743ece18 43 */
demayer 0:6bf0743ece18 44 virtual void set_sim_pin(const char *sim_pin) = 0;
demayer 0:6bf0743ece18 45
demayer 0:6bf0743ece18 46 /** Start the interface
demayer 0:6bf0743ece18 47 *
demayer 0:6bf0743ece18 48 * Attempts to connect to a Cellular network.
demayer 0:6bf0743ece18 49 *
demayer 0:6bf0743ece18 50 * @param sim_pin PIN for the SIM card
demayer 0:6bf0743ece18 51 * @param apn optionally, access point name
demayer 0:6bf0743ece18 52 * @param uname optionally, Username
demayer 0:6bf0743ece18 53 * @param pwd optionally, password
demayer 0:6bf0743ece18 54 * @return NSAPI_ERROR_OK on success, or negative error code on failure
demayer 0:6bf0743ece18 55 */
demayer 0:6bf0743ece18 56 virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0,
demayer 0:6bf0743ece18 57 const char *uname = 0,
demayer 0:6bf0743ece18 58 const char *pwd = 0) = 0;
demayer 0:6bf0743ece18 59
demayer 0:6bf0743ece18 60 /** Start the interface
demayer 0:6bf0743ece18 61 *
demayer 0:6bf0743ece18 62 * Attempts to connect to a Cellular network.
demayer 0:6bf0743ece18 63 * If the SIM requires a PIN, and it is not set/invalid, NSAPI_ERROR_AUTH_ERROR is returned.
demayer 0:6bf0743ece18 64 *
demayer 0:6bf0743ece18 65 * @return NSAPI_ERROR_OK on success, or negative error code on failure
demayer 0:6bf0743ece18 66 */
demayer 0:6bf0743ece18 67 virtual nsapi_error_t connect() = 0;
demayer 0:6bf0743ece18 68
demayer 0:6bf0743ece18 69 /** Stop the interface
demayer 0:6bf0743ece18 70 *
demayer 0:6bf0743ece18 71 * @return 0 on success, or error code on failure
demayer 0:6bf0743ece18 72 */
demayer 0:6bf0743ece18 73 virtual nsapi_error_t disconnect() = 0;
demayer 0:6bf0743ece18 74
demayer 0:6bf0743ece18 75 /** Check if the connection is currently established or not
demayer 0:6bf0743ece18 76 *
demayer 0:6bf0743ece18 77 * @return true/false If the cellular module have successfully acquired a carrier and is
demayer 0:6bf0743ece18 78 * connected to an external packet data network using PPP, isConnected()
demayer 0:6bf0743ece18 79 * API returns true and false otherwise.
demayer 0:6bf0743ece18 80 */
demayer 0:6bf0743ece18 81 virtual bool is_connected() = 0;
demayer 0:6bf0743ece18 82
demayer 0:6bf0743ece18 83 /** Get the local IP address
demayer 0:6bf0743ece18 84 *
demayer 0:6bf0743ece18 85 * @return Null-terminated representation of the local IP address
demayer 0:6bf0743ece18 86 * or null if no IP address has been received
demayer 0:6bf0743ece18 87 */
demayer 0:6bf0743ece18 88 virtual const char *get_ip_address() = 0;
demayer 0:6bf0743ece18 89
demayer 0:6bf0743ece18 90 /** Get the local network mask
demayer 0:6bf0743ece18 91 *
demayer 0:6bf0743ece18 92 * @return Null-terminated representation of the local network mask
demayer 0:6bf0743ece18 93 * or null if no network mask has been received
demayer 0:6bf0743ece18 94 */
demayer 0:6bf0743ece18 95 virtual const char *get_netmask() = 0;
demayer 0:6bf0743ece18 96
demayer 0:6bf0743ece18 97 /** Get the local gateways
demayer 0:6bf0743ece18 98 *
demayer 0:6bf0743ece18 99 * @return Null-terminated representation of the local gateway
demayer 0:6bf0743ece18 100 * or null if no network mask has been received
demayer 0:6bf0743ece18 101 */
demayer 0:6bf0743ece18 102 virtual const char *get_gateway() = 0;
demayer 0:6bf0743ece18 103
demayer 0:6bf0743ece18 104 };
demayer 0:6bf0743ece18 105
demayer 0:6bf0743ece18 106 #endif //CELLULAR_BASE_H
demayer 0:6bf0743ece18 107
demayer 0:6bf0743ece18 108 /** @}*/