pynbntnmodem


Namepynbntnmodem JSON
Version 0.6.5 PyPI version JSON
download
home_pageNone
SummaryLibrary for interfacing to Narrowband Non-Terrestrial Network modems using AT commands.
upload_time2025-08-21 12:53:30
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 an base class **`NbntnModem`** that abstracts specific AT commands
to common methods 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 init objects may be customized and included at the top of 
a specific modem subclass.

## 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()`

## URC injection

Some modems do not emit any URC on important events such as the completion of
a MO message sending. In such cases the `inject_urc()` method is provided to
simulate a modem-generated URC.
            

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/cf/e7/eecd743333051962587211f173b77083566597cca7d37ad80d8b22ad9d35/pynbntnmodem-0.6.5.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 an base class **`NbntnModem`** that abstracts specific AT commands\nto common methods 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 init objects may be customized and included at the top of \na specific modem subclass.\n\n## Common Workflow\n\n* **`connect()`** using either `.env` variables, default or programmatic values\nfor `SERIAL_PORT`/`port` and `SERIAL_BAUDRATE`/`baudrate`.\n\n* **`initialize_ntn()`** to run the modem-specific configuration sequence\n\n* Run a loop that continually runs `check_urc()`, queues and then processes\neach `get_urc_type()`\n\n## URC injection\n\nSome modems do not emit any URC on important events such as the completion of\na MO message sending. In such cases the `inject_urc()` method is provided to\nsimulate a modem-generated URC.",
    "bugtrack_url": null,
    "license": "Apache2.0",
    "summary": "Library for interfacing to Narrowband Non-Terrestrial Network modems using AT commands.",
    "version": "0.6.5",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "21ad008ba520550030de07c2ce9c91a0cd410400e22d1ade1f52e412d76935d7",
                "md5": "6e3ca974b6357bc17fcd725adecdbee4",
                "sha256": "a3a1d2380374bab9f989fe719cf2d9c0c8be58cb6155a8621d775e81a044f130"
            },
            "downloads": -1,
            "filename": "pynbntnmodem-0.6.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e3ca974b6357bc17fcd725adecdbee4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 34099,
            "upload_time": "2025-08-21T12:53:29",
            "upload_time_iso_8601": "2025-08-21T12:53:29.597277Z",
            "url": "https://files.pythonhosted.org/packages/21/ad/008ba520550030de07c2ce9c91a0cd410400e22d1ade1f52e412d76935d7/pynbntnmodem-0.6.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cfe7eecd743333051962587211f173b77083566597cca7d37ad80d8b22ad9d35",
                "md5": "a401a7035d063bda7799abeb3957212b",
                "sha256": "340956a30191567dd0c2897dbf3809a3adfceee2323727c21b3690cb2045222d"
            },
            "downloads": -1,
            "filename": "pynbntnmodem-0.6.5.tar.gz",
            "has_sig": false,
            "md5_digest": "a401a7035d063bda7799abeb3957212b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 28143,
            "upload_time": "2025-08-21T12:53:30",
            "upload_time_iso_8601": "2025-08-21T12:53:30.816466Z",
            "url": "https://files.pythonhosted.org/packages/cf/e7/eecd743333051962587211f173b77083566597cca7d37ad80d8b22ad9d35/pynbntnmodem-0.6.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-21 12:53:30",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pynbntnmodem"
}
        
Elapsed time: 1.80412s