LwGSM latest-develop documentation

Welcome to the documentation for version latest-develop.

LwGSM is generic, platform independent, library to control SIM800/SIM900 or SIM7000/SIM7020 (NB-Iot LTE) devices from SIMCom. Its objective is to run on master system, while SIMCom device runs official AT commands firmware developed and maintained by SIMCom.

Features

  • Supports SIM800/SIM900 (2G) and SIM7000/SIM7020 (NB-Iot LTE) modules

  • Platform independent and very easy to port

    • Development of library under Win32 platform

    • Provided examples for ARM Cortex-M or Win32 platforms

  • Written in C language (C99)

  • Allows different configurations to optimize user requirements

  • Supports implementation with operating systems with advanced inter-thread communications

    • Currently only OS mode is supported

    • 2 different threads handling user data and received data

      • First (producer) thread (collects user commands from user threads and starts the command processing)

      • Second (process) thread reads the data from GSM device and does the job accordingly

  • Allows sequential API for connections in client and server mode

  • Includes several applications built on top of library

    • MQTT client for MQTT connection

  • User friendly MIT license

Requirements

  • C compiler

  • Supported GSM Physical device

Contribute

Fresh contributions are always welcome. Simple instructions to proceed:

  1. Fork Github repository

  2. Respect C style & coding rules used by the library

  3. Create a pull request to develop branch with new features or bug fixes

Alternatively you may:

  1. Report a bug

  2. Ask for a feature request

License

MIT License

Copyright (c) 2020 Tilen MAJERLE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.