|
Coming soon |
Click here for Cellular overview
1. Introduction
This wiki page contains the information to ease the user's trip in ST Cellular software. When the information is already present in a databrief or a user manual, this wiki only redirects on those reference documents. So this wiki does not contain all the information but help you to find it.
2. X-CUBE-CELLULAR versions
From the beginning, version V1.0.0 in mid-2018 the SW content and the hardware support increased continuously. The current version is the V5.2.0. In the next version V6.0.0 we will focus on the Cellular middleware that is to say all the SW will be reworked and we will ease customers integration in their applications. Only one application with multiple possibilities that directly use X-CUBE-CELLULAR API without other middlewares will be delivered. All the extra application (HTTP/S, MQTT/S ...) will be delivered by other means. Further more the low-power will be introduced. For the deliveries complete description (SW and supported HW), refer to Release Notes included in the X-CUBE package.
3. What is X-CUBE-CELLULAR
What is X-CUBE-CELLULAR used for ? It is used to allow applications to send and receive data on the cellular network using BSD API sockets.
Do not forget the official web page on X-CUBE-CELLULAR on st.com. You will have access to multiple resources (software, documents, ...).
The X-CUBE-CELLULAR consists of a set of libraries and application examples for STM32L4 Series MCUs acting as hosts for cellular connectivity applications.
The colors help to understand the different parts, Green for applications, light Blue for Middlewares, dark Blue for HAL, Purple for hardware.
Note that above the Cellular Middleware there is the Network_Library Middleware, it abstracts the cellular, Wifi, Ethernet ... So an application using Network_Library APIs, running on a bearer can be easily ported on another technology. Also note it is not mandatory to use Network_Library APIs, an application only using cellular can directly use X-CUBE-CELLULAR APIs.
4. Provided applications in V5.2.0
Several applications are provided as examples:
- The PING client application to test the access to a remote machine
- The ECHO client application to provide an example of connection and data exchanges using the TCP or UDP (connected or not-connected mode) socket protocols
- The HTTP client application to exchange data between the device and the cloud using the HTTP protocol
- The MQTT client application to exchange data between the device and the cloud using the MQTT protocol (it uses TCP)
- The COM client application to test the access to COM library services such as read information from ICC
- The CUSTOM client application, an empty application already pre-integrated in X-CUBE-CELLULAR. It is provided to ease customers development.
By default, only one application is started at boot: ECHO client.
Indeed PING client is more a command than an application so it starts when the command is entered.
It is the same for COM client, it is a command.
HTTP client is by default stopped, to start it just enters the following command: http on (http off to stop it).
CUSTOM client must be activated with the compilation switch, once activated by default this application only displays a message in which the user may add his own content.
MQTT client is more complicated to activate because it uses Network_Library and MbedTLS Middlewares but it is easy following the README.txt. See below more details about MQTT client.
The X-CUBE-CELLULAR also contains modular tools like Command (to interact with the firmware through the terminal) and setup menu (to set parameters in the firmware to avoid a new compilation).
5. What is the Getting started user manual
This user manual is a simple and short document to read first. It explains the basis: to connect the hardware, to activate the eSIM, to program the firmware on the board and to run it; all this information in less than 10 pages.
6. How To ...
This part is a guideline to describe How To make main activities with X-CUBE-CELLULAR. All information are merged in the X-CUBE-CELLULAR How To Wiki page
7. FAQ
All the Frequently Asked Questions are listed in the dedicated X-CUBE-CELLULAR F.A.Q page