Pi7600: Python Library and REST API for SIM7600 (Simcom says the AT commands are compatible with the 8200 and 8260 5g models as well)
Pi7600 is a Python library and FastAPI-based REST API for managing the SIM7600 4G HAT from Waveshare on systems like the Raspberry Pi. The project enables various operations for modem control, including:
- Checking modem information and status
- Retrieving host system details
- Managing SMS messages (send, read, delete)
- Executing raw AT commands
- Accessing GPS data
This tool integrates various modules such as GPS, SMS, and Settings to provide comprehensive control over the modem, all while supporting asynchronous execution for improved performance.
- Modem Information: Retrieve network and device status asynchronously.
- Host System Information: Fetch system details like hostname, kernel version, and architecture.
- SMS Management: Send, read, and delete SMS messages with asynchronous support.
- AT Command Interface: Execute raw AT commands and get modem responses asynchronously.
- GPS Data: Access GPS coordinates via the SIM7600 module asynchronously.
Detailed installation instructions will be provided in the future once the project reaches a stable release.
To run the API, use the FastAPI server powered by uvicorn:
uvicorn main:app --reloadThis starts the API server at http://localhost:8000.
- Method:
GET - Description: Returns modem information, including AT command checks, signal quality, SIM status, network registration, and GPS info.
Example Request:
curl -X GET http://localhost:8000/Response:
{
"at": "OK",
"cnum": "+11234567890",
"csq": "+CSQ: 15,99",
"cpin": "+CPIN: READY",
"creg": "+CREG: 0,1",
"cops": "+COPS: 0,0,\"Home\",7",
"gpsinfo": "GPS is active but no signal was found",
"data": "OK",
"dns": "OK",
"apn": "fast.t-mobile.com"
}- Method:
GET - Description: Fetches host system details like hostname, kernel version, and architecture.
Example Request:
curl -X GET http://localhost:8000/infoResponse:
{
"hostname": "raspberrypi",
"uname": "5.10.17-v7l+",
"date": "Tue Sep 17 22:48:47 2024",
"arch": "armv7l"
}- Method:
GET - Description: Reads SMS messages from the modem. Supports querying all messages or by specific types (e.g., "REC READ").
Example Request:
curl -X GET "http://localhost:8000/sms?msg_query=ALL"Response:
[
{
"message_index": "1",
"message_type": "REC READ",
"message_originating_address": "+1234567890",
"message_destination_address": null,
"message_date": "2024-09-17",
"message_time": "22:48:47",
"message_contents": "Hello World"
}
]- Method:
POST - Description: Sends an SMS message to the specified phone number.
Example Request:
curl -X POST -H "Content-Type: application/json" \
-d '{"number":"+1234567890","msg":"Hello World"}' \
"http://localhost:8000/sms"Response:
{
"response": true
}- Method:
DELETE - Description: Deletes an SMS by its message index.
Example Request:
curl -X DELETE http://localhost:8000/sms/delete/1Response:
{
"response": "Success"
}- Method:
POST - Description: Sends raw AT commands to the modem and retrieves the response.
Example Request:
curl -X POST -H "Content-Type: application/json" \
-d '{"cmd":"AT+CSQ"}' \
"http://localhost:8000/at"Response:
"OK"FastAPI provides built-in interactive documentation to explore the API endpoints:
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
These pages allow you to explore and test the API directly from the browser.
Contributions are welcome! Feel free to open an issue or submit a pull request if you have suggestions or improvements.
MIT license
Note: This project is under active development, and documentation will be updated as features are added.