https://github.com/freertos/freertos-cellular-interface-community-supported-ports

https://github.com/freertos/freertos-cellular-interface-community-supported-ports

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/freertos/freertos-cellular-interface-community-supported-ports
• Owner: FreeRTOS
• License: mit
• Created: 2021-11-10T16:51:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-29T08:02:16.000Z (almost 2 years ago)
• Last Synced: 2023-03-03T23:00:31.071Z (almost 2 years ago)
• Language: C
• Size: 130 KB
• Stars: 4
• Watchers: 15
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## FreeRTOS Cellular Interface Community Supported Ports

This repository contains the cellular module ports supported by FreeRTOS community members. We welcome your contribution to expand the catalog of modems.

### How to Contribute a Cellular Module Port

1. Fork the ```FreeRTOS/FreeRTOS-Cellular-Interface``` repository.

2. Write code for a new cellular module.  

    For details, see [Porting the Cellular Interface Library to another Modem](https://www.freertos.org/cellular-porting-guide.html).

3. Create a new folder for the new cellular module in the root folder.

4. Create a ```README.md``` file and place it at the top level of the new module port folder. Ensure the```README.md``` describes the following:

    1. Hardware information: Give the reader a cellular module introduction and the steps to setup the hardware environment.

    2. Objectives: Tell the reader a high-level summary of what steps they need to take and how to use this port. 

    3. Relevant information: Tell the reader what they should read or take care if they would like to dive deeper.

5. [Optional] If you are contributing a new cellular module with supporting demos, create a new demo in the cellular demo repository and update the ```README.md``` in the root folder.

6. Raise a Pull Request (PR). Maintainers and other contirbutors will review your PR. Please be proactive in the conversation and make the requested changes as soon as possible. The code will be merged after the PR is approved. 

## License

The FreeRTOS Cellular Interface library is distributed under MIT open source license. The code in this repository is licensed under the MIT License. See the [LICENSE](https://github.com/FreeRTOS/FreeRTOS-Kernel-Community-Supported-Ports/blob/main/LICENSE) file.