# idpmodem
Python library and samples for integrating with satellite Internet-of-Things
modems using the [Inmarsat](https://www.inmarsat.com) IsatData Pro ("IDP")
network.
[Documentation](https://inmarsat-enterprise.github.io/idpmodem/)
## Overview
IDP is a store-and-forward satellite messaging technology with
messages up to 6400 bytes mobile-originated or 10000 bytes mobile-terminated.
*Messages* are sent from or to a *Mobile* using its globally unique ID,
transacted through a *Mailbox* that provides authentication, encryption and
data segregation for cloud-based or enterprise client applications via a
network **Messaging API**.
The first byte of the message is referred to as the
*Service Identification Number* (**SIN**) where values below 16 are reserved
for system use. SIN is intended to capture the concept of embedded
microservices used by an application.
The second byte of the message can optionally be defined as the
*Message Identifier Number* (**MIN**) intended to support remote operations
within each embedded microservice with defined binary formatting.
The MIN concept also supports the optional *Message Definition File* feature
allowing an XML file to be applied which presents a JSON-tagged message
structure on the network API.
### Terminology
* MO = **Mobile Originated** aka *Return* aka *From-Mobile*
message sent from modem to cloud/enterprise application
* MT = **Mobile Terminated** aka *Forward message* aka *To-Mobile*
message sent from cloud/enterprise application to modem
## Modem operation
Upon power-up or reset, the modem first acquires its location using
Global Navigation Satellite Systems (GNSS).
After getting its location, the modem tunes to the correct frequency, then
registers on the Inmarsat network. Once registered it can communicate on the
network.
Prolonged obstruction of satellite signal will put the modem into a "blockage"
state from which it will automatically try to recover based on an algorithm
influenced by its *power mode* setting.
Raw data
{
"_id": null,
"home_page": "https://github.com/inmarsat-enterprise.com/idpmodem",
"name": "idpmodem",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "satellite,iot",
"author": "geoffbrucepayne",
"author_email": "geoff.bruce-payne@inmarsat.com",
"download_url": "https://files.pythonhosted.org/packages/e1/ce/4134ed857192361c4e5cab080052860ad60fc22ef9b74e22335f1814e9fc/idpmodem-2.3.9.tar.gz",
"platform": null,
"description": "# idpmodem\n\nPython library and samples for integrating with satellite Internet-of-Things \nmodems using the [Inmarsat](https://www.inmarsat.com) IsatData Pro (\"IDP\")\nnetwork.\n\n[Documentation](https://inmarsat-enterprise.github.io/idpmodem/)\n\n## Overview\n\nIDP is a store-and-forward satellite messaging technology with\nmessages up to 6400 bytes mobile-originated or 10000 bytes mobile-terminated.\n*Messages* are sent from or to a *Mobile* using its globally unique ID,\ntransacted through a *Mailbox* that provides authentication, encryption and\ndata segregation for cloud-based or enterprise client applications via a\nnetwork **Messaging API**.\n\nThe first byte of the message is referred to as the\n*Service Identification Number* (**SIN**) where values below 16 are reserved\nfor system use. SIN is intended to capture the concept of embedded\nmicroservices used by an application.\n\nThe second byte of the message can optionally be defined as the\n*Message Identifier Number* (**MIN**) intended to support remote operations \nwithin each embedded microservice with defined binary formatting.\nThe MIN concept also supports the optional *Message Definition File* feature\nallowing an XML file to be applied which presents a JSON-tagged message\nstructure on the network API.\n\n### Terminology\n\n* MO = **Mobile Originated** aka *Return* aka *From-Mobile*\n message sent from modem to cloud/enterprise application\n* MT = **Mobile Terminated** aka *Forward message* aka *To-Mobile*\n message sent from cloud/enterprise application to modem\n\n## Modem operation\n\nUpon power-up or reset, the modem first acquires its location using \nGlobal Navigation Satellite Systems (GNSS).\nAfter getting its location, the modem tunes to the correct frequency, then\nregisters on the Inmarsat network. Once registered it can communicate on the\nnetwork.\nProlonged obstruction of satellite signal will put the modem into a \"blockage\"\nstate from which it will automatically try to recover based on an algorithm\ninfluenced by its *power mode* setting.",
"bugtrack_url": null,
"license": "Apache2.0",
"summary": "A library for interfacing with an Inmarsat IsatData Pro satellite IoT modem using serial AT commands.",
"version": "2.3.9",
"project_urls": {
"Homepage": "https://github.com/inmarsat-enterprise.com/idpmodem",
"Repository": "https://github.com/inmarsat-enterprise.com/idpmodem"
},
"split_keywords": [
"satellite",
"iot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07235a28041b2cdc52d736abfc7539234dd6b7e0806b4e839118b7ee0e955820",
"md5": "4e91e10a013a13102553c638e2d92c6a",
"sha256": "bf96ac993ec8fd260217e5597e380ba4ae7f0e91243ea0eee9c7b3c8b7196b2c"
},
"downloads": -1,
"filename": "idpmodem-2.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e91e10a013a13102553c638e2d92c6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 84020,
"upload_time": "2023-05-30T11:38:47",
"upload_time_iso_8601": "2023-05-30T11:38:47.494677Z",
"url": "https://files.pythonhosted.org/packages/07/23/5a28041b2cdc52d736abfc7539234dd6b7e0806b4e839118b7ee0e955820/idpmodem-2.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1ce4134ed857192361c4e5cab080052860ad60fc22ef9b74e22335f1814e9fc",
"md5": "53cd6d479537f11806a83e93410166cd",
"sha256": "50526959cbcfc72cb8273b3a7ed092c0f601fd582b8eeca9fdae8f282abbeb33"
},
"downloads": -1,
"filename": "idpmodem-2.3.9.tar.gz",
"has_sig": false,
"md5_digest": "53cd6d479537f11806a83e93410166cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 70294,
"upload_time": "2023-05-30T11:38:49",
"upload_time_iso_8601": "2023-05-30T11:38:49.330770Z",
"url": "https://files.pythonhosted.org/packages/e1/ce/4134ed857192361c4e5cab080052860ad60fc22ef9b74e22335f1814e9fc/idpmodem-2.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 11:38:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inmarsat-enterprise.com",
"github_project": "idpmodem",
"github_not_found": true,
"lcname": "idpmodem"
}
JSON
