pynbntnmodem


Namepynbntnmodem JSON
Version 0.3.4 PyPI version JSON
download
home_pageNone
SummaryLibrary for interfacing to Narrowband Non-Terrestrial Network modems using AT commands.
upload_time2025-01-10 17:14:44
maintainerNone
docs_urlNone
authorgeoffbrucepayne
requires_python<4.0,>=3.10
licenseApache2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NB-NTN Modem Interface

A generic model for interfacing to a NB-IoT modem compatible with 3GPP R17
Non-Terrestrial Network.

Provides a generic class **`NbntnModem`** that abstracts specific AT commands to
common functional operations used for communicating using NB-IoT over satellite.
The class is intended to be subclassed and extended for specific modem variants
from various manufacturers.

## Modem Subclassing

Since modem implementations differ across make/model, this library is intended
to be used to create `NbntnModem` subclasses with specific AT commands and
responses.

### Initialization Sequence

The `ntninit` submodule describes the format and an example template for the
AT command sequence required by a particular modem variant.

The `ntn_init` list of dictionaries may be customized and included at the top of 
a specific modem subclass.

### MODEM_SUBCLASS

To allow for automatic selection between different subclassed modems, use the
`MODEM_SUBCLASS` declaration at the bottom of your subclass template.

## Common Workflow

* **`connect()`** using either `.env` variables, default or programmatic values
for `SERIAL_PORT`/`port` and `SERIAL_BAUDRATE`/`baudrate`.
* **`initialize_ntn()`** to run the modem-specific configuration sequence
* Run a loop that continually runs `check_urc()`, queues and then processes
each `get_urc_type()`
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pynbntnmodem",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "geoffbrucepayne",
    "author_email": "geoff.bruce-payne@inmarsat.com",
    "download_url": "https://files.pythonhosted.org/packages/52/c4/0bfbed87e7c9f1f0c978829dac0e46c4e946abeae8cbd207a2044cdfc70e/pynbntnmodem-0.3.4.tar.gz",
    "platform": null,
    "description": "# NB-NTN Modem Interface\n\nA generic model for interfacing to a NB-IoT modem compatible with 3GPP R17\nNon-Terrestrial Network.\n\nProvides a generic class **`NbntnModem`** that abstracts specific AT commands to\ncommon functional operations used for communicating using NB-IoT over satellite.\nThe class is intended to be subclassed and extended for specific modem variants\nfrom various manufacturers.\n\n## Modem Subclassing\n\nSince modem implementations differ across make/model, this library is intended\nto be used to create `NbntnModem` subclasses with specific AT commands and\nresponses.\n\n### Initialization Sequence\n\nThe `ntninit` submodule describes the format and an example template for the\nAT command sequence required by a particular modem variant.\n\nThe `ntn_init` list of dictionaries may be customized and included at the top of \na specific modem subclass.\n\n### MODEM_SUBCLASS\n\nTo allow for automatic selection between different subclassed modems, use the\n`MODEM_SUBCLASS` declaration at the bottom of your subclass template.\n\n## Common Workflow\n\n* **`connect()`** using either `.env` variables, default or programmatic values\nfor `SERIAL_PORT`/`port` and `SERIAL_BAUDRATE`/`baudrate`.\n* **`initialize_ntn()`** to run the modem-specific configuration sequence\n* Run a loop that continually runs `check_urc()`, queues and then processes\neach `get_urc_type()`",
    "bugtrack_url": null,
    "license": "Apache2.0",
    "summary": "Library for interfacing to Narrowband Non-Terrestrial Network modems using AT commands.",
    "version": "0.3.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2bbc6656b3e986f1f3df591f7398efe3166eb2ceee9a7b7ad50249498daf064b",
                "md5": "1753d58ca7f3a39175dfe44f8a2ade09",
                "sha256": "0d2bd698c2faeb22d3888fb25382246245b0e7844cf30cd0d41eb1b5580cae4c"
            },
            "downloads": -1,
            "filename": "pynbntnmodem-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1753d58ca7f3a39175dfe44f8a2ade09",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 29274,
            "upload_time": "2025-01-10T17:14:42",
            "upload_time_iso_8601": "2025-01-10T17:14:42.150970Z",
            "url": "https://files.pythonhosted.org/packages/2b/bc/6656b3e986f1f3df591f7398efe3166eb2ceee9a7b7ad50249498daf064b/pynbntnmodem-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52c40bfbed87e7c9f1f0c978829dac0e46c4e946abeae8cbd207a2044cdfc70e",
                "md5": "7659dc6fecfe84952b916c28ed703d88",
                "sha256": "f48d334ceab1888dd15cea55486a91af4b55ca3a00c5c44c8e87ca13a6f96cd2"
            },
            "downloads": -1,
            "filename": "pynbntnmodem-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "7659dc6fecfe84952b916c28ed703d88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 24883,
            "upload_time": "2025-01-10T17:14:44",
            "upload_time_iso_8601": "2025-01-10T17:14:44.306709Z",
            "url": "https://files.pythonhosted.org/packages/52/c4/0bfbed87e7c9f1f0c978829dac0e46c4e946abeae8cbd207a2044cdfc70e/pynbntnmodem-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-10 17:14:44",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pynbntnmodem"
}
        
Elapsed time: 0.37950s