| Name | sim-modem-cli JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | Easy CLI for interfacing with mobile modems |
| upload_time | 2022-12-27 23:05:03 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
modem
sms
gsm
sim
atcommands
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sim-modem-cli
A command line interface for SIM modems. It uses the [sim-modem](https://github.com/jonamat/sim-modem) library to communicate with the modem through AT commands. Tested with Simcom SIM7600G-H on Raspberry PI Zero W. The commands could be different for other modems.
## Installation
### From pip
```bash
python3 -m pip install sim-modem-cli
```
## Usage
```bash
sim-modem-cli <command> address [<args>...] [--options]
```
### Options
| Option | Description |
| ---------- | -------------------- |
| --help | Show help message |
| --version | Show the version |
| --baudrate | The baudrate to use. |
| --timeout | The timeout to use. |
| --debug | Enable debug mode. |
### Commands
| Command | Arguments | Description |
| ------------------------------- | ------------------------------------------ | --------------------------------------------------- |
| ***Hardware related commands*** | | |
| get_model_identification | | Get the model identification |
| get_manufacturer_identification | | Get the manufacturer identification |
| get_serial_number | | Get the serial number |
| get_firmware_version | | Get the firmware version |
| get_volume | | Get the volume. The volume range is between 0 and 5 |
| set_volume | int volume (1-5) | Set the volume. The volume must be between 0 and 5 |
| improve_tdd | | Decrease TDD Noise effect |
| enable_echo_suppression | | Enable echo suppression |
| disable_echo_suppression | | Disable echo suppression |
| ***Network related commands*** | | |
| get_network_registration_status | | Get the network registration status |
| get_network_mode | | Get the network mode |
| get_network_name | | Get the network name |
| get_network_operator | | Get the network operator |
| get_signal_quality | | Get the signal quality |
| get_signal_quality_db | | Get the signal quality in dB |
| get_signal_quality_range | | Get the signal quality as a range |
| get_phone_number | | Get the phone number |
| get_sim_status | | Get the SIM status |
| set_network_mode | auto \| gsm_only \| lte_only \| no_lte | Set the network |
| ***Calls related commands*** | | |
| call | Number to call (with international prefix) | Call a number |
| answer | | Answer a call |
| hangup | | Hangup a call |
| ***SMS related commands*** | | |
| get_sms_list | | Get the list of SMS |
| empty_sms | | Empty the SMS storage |
| send_sms str, message: str | Number, message | Send an SMS |
| get_sms | SMS index | Get an SMS by ID |
| delete_sms | SMS index | Delete an SMS by ID |
| ***GPS related commands*** | | |
| get_gps_status | | Get the GPS status |
| start_gps | | Start the GPS |
| stop_gps | | Stop the GPS |
| get_gps_coordinates | | Get the GPS coordinates |
## License
[MIT](LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "sim-modem-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "modem,sms,gsm,sim,atcommands",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f1/42/3887437bec254192233101fe9ef309334f7435714b5a4f1ac5fe3bb9c3da/sim-modem-cli-1.0.2.tar.gz",
"platform": null,
"description": "# sim-modem-cli\n\nA command line interface for SIM modems. It uses the [sim-modem](https://github.com/jonamat/sim-modem) library to communicate with the modem through AT commands. Tested with Simcom SIM7600G-H on Raspberry PI Zero W. The commands could be different for other modems.\n\n## Installation\n\n### From pip\n\n```bash\npython3 -m pip install sim-modem-cli\n```\n\n## Usage\n\n```bash\nsim-modem-cli <command> address [<args>...] [--options] \n```\n\n### Options\n\n| Option | Description |\n| ---------- | -------------------- |\n| --help | Show help message |\n| --version | Show the version |\n| --baudrate | The baudrate to use. |\n| --timeout | The timeout to use. |\n| --debug | Enable debug mode. |\n\n### Commands\n\n| Command | Arguments | Description |\n| ------------------------------- | ------------------------------------------ | --------------------------------------------------- |\n| ***Hardware related commands*** | | |\n| get_model_identification | | Get the model identification |\n| get_manufacturer_identification | | Get the manufacturer identification |\n| get_serial_number | | Get the serial number |\n| get_firmware_version | | Get the firmware version |\n| get_volume | | Get the volume. The volume range is between 0 and 5 |\n| set_volume | int volume (1-5) | Set the volume. The volume must be between 0 and 5 |\n| improve_tdd | | Decrease TDD Noise effect |\n| enable_echo_suppression | | Enable echo suppression |\n| disable_echo_suppression | | Disable echo suppression |\n| ***Network related commands*** | | |\n| get_network_registration_status | | Get the network registration status |\n| get_network_mode | | Get the network mode |\n| get_network_name | | Get the network name |\n| get_network_operator | | Get the network operator |\n| get_signal_quality | | Get the signal quality |\n| get_signal_quality_db | | Get the signal quality in dB |\n| get_signal_quality_range | | Get the signal quality as a range |\n| get_phone_number | | Get the phone number |\n| get_sim_status | | Get the SIM status |\n| set_network_mode | auto \\| gsm_only \\| lte_only \\| no_lte | Set the network |\n| ***Calls related commands*** | | |\n| call | Number to call (with international prefix) | Call a number |\n| answer | | Answer a call |\n| hangup | | Hangup a call |\n| ***SMS related commands*** | | |\n| get_sms_list | | Get the list of SMS |\n| empty_sms | | Empty the SMS storage |\n| send_sms str, message: str | Number, message | Send an SMS |\n| get_sms | SMS index | Get an SMS by ID |\n| delete_sms | SMS index | Delete an SMS by ID |\n| ***GPS related commands*** | | |\n| get_gps_status | | Get the GPS status |\n| start_gps | | Start the GPS |\n| stop_gps | | Stop the GPS |\n| get_gps_coordinates | | Get the GPS coordinates |\n\n\n\n## License\n\n[MIT](LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easy CLI for interfacing with mobile modems",
"version": "1.0.2",
"split_keywords": [
"modem",
"sms",
"gsm",
"sim",
"atcommands"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0a46cbed93c1b965158fbfc064cdc50d",
"sha256": "a92fdb4501eb44146d7783f33e04917e6038c9d9536b83a598c0708f2bcb92c0"
},
"downloads": -1,
"filename": "sim_modem_cli-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a46cbed93c1b965158fbfc064cdc50d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4777,
"upload_time": "2022-12-27T23:05:01",
"upload_time_iso_8601": "2022-12-27T23:05:01.602789Z",
"url": "https://files.pythonhosted.org/packages/ce/f8/bbf239e055e9d5acd37722f4e0ead6b3ab28713f21cc1adb8276566da035/sim_modem_cli-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "a466840bb0f31181e45c8d2c89b43fd9",
"sha256": "478024ab0af4d884128d6f1c222a5f921fda8325f0a2b270ec192382cb6e7615"
},
"downloads": -1,
"filename": "sim-modem-cli-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "a466840bb0f31181e45c8d2c89b43fd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4549,
"upload_time": "2022-12-27T23:05:03",
"upload_time_iso_8601": "2022-12-27T23:05:03.517235Z",
"url": "https://files.pythonhosted.org/packages/f1/42/3887437bec254192233101fe9ef309334f7435714b5a4f1ac5fe3bb9c3da/sim-modem-cli-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-27 23:05:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sim-modem-cli"
}
