Skip to main content

Command-line interface for sending AT (ATtention) commands via serial port to GSM shield module.

Project description

SMS-cli

Command-line tool for sending commands via serial port to GSM shield module

Description

Command-line tool for sending AT (ATtention) commands via serial port to GSM Shield module. This tool is written in python3 and it is supported on any platform (Windows/Linux/MacOS). Before using tool you must have GSM Shield module connected to serial port, and it must have proper SIM card inserted with enough credits to send SMS messages.

Installation

Tool can be installed using pip3 command:

pip3 install sms-cli

Or you can install it directly form this project source:

python3 build.py

pip3 install dist/sms-cli-{version}.tar.gz

After installation, tool will be added to system path and can be used to send messages and read inbox.

Usage

All commands

usage: sms-cli [-h] [-v] [-b BAUD] [-p PORT] {send,read,delete,check} ...

execute AT commands on GSM shield module via serial port

positional arguments:
  {send,read,delete,check}
    send                send SMS message to destination
    read                read all inbound SMS messages from inbox, or just one
                        using index
    delete              delete specific message from storage
    check               check connectivity with GSM shield module

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         print version number
  -b BAUD, --baud BAUD  specify baud rate
  -p PORT, --port PORT  specify port device type

Check

usage: sms-cli check [-h] [-n NUMBER]

optional arguments:
  -h, --help            show this help message and exit
  -n NUMBER, --number NUMBER
                        number of iterations to check connection

Send

usage: sms-cli send [-h] -d DESTINATION -m MESSAGE

optional arguments:
  -h, --help            show this help message and exit
  -d DESTINATION, --destination DESTINATION
                        destination MSISDN in full format (e.g. +38591234567)
  -m MESSAGE, --message MESSAGE
                        SMS message text with maximum of 160 characters (e.g.
                        "Some message text.")

Read

usage: sms-cli read [-h] [-i INDEX] [-s STORAGE] [-u] [-d] [-f]

optional arguments:
  -h, --help            show this help message and exit
  -i INDEX, --index INDEX
                        read only message at this index from the top of inbox
  -s STORAGE, --storage STORAGE
                        specify the storage from which to read messages,
                        options: [SM | ME | MT | BM | SR]
  -u, --unread          read only currently unread messages (when not using
                        index)
  -d, --dry             dry read, not changing status of unread messages while
                        reading
  -f, --full            show full header information of red SMS messages

Delete

usage: sms-cli delete [-h] -i INDEX [-s STORAGE]

optional arguments:
  -h, --help            show this help message and exit
  -i INDEX, --index INDEX
                        index of SMS message to delete
  -s STORAGE, --storage STORAGE
                        specify the storage from which to delete message,
                        options: [SM | ME | MT | BM | SR]

LICENSE

GNU General Public License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sms-cli-1.0.4.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

sms_cli-1.0.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file sms-cli-1.0.4.tar.gz.

File metadata

  • Download URL: sms-cli-1.0.4.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.2

File hashes

Hashes for sms-cli-1.0.4.tar.gz
Algorithm Hash digest
SHA256 59396b525f568035d3096c211ee8d565e77d08af932821a2098ec22ac12f8c55
MD5 865d88f92e0fe7a772d174ffba76d881
BLAKE2b-256 ce2a1011e2735b07b5a2a33e5133971e1a970e47bf0411671a7c7555398b912b

See more details on using hashes here.

File details

Details for the file sms_cli-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: sms_cli-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.2

File hashes

Hashes for sms_cli-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e4c3b91120bcd96869559116b656249f4e39aeaaca476e21cce26d65f2f2f815
MD5 03181a29ee757a45ab7ae954e07e0e1e
BLAKE2b-256 98d0c849a82040636a67ca73c8531513bcfaa79ddb7b5130d629a0e033688a74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page