Metadata-Version: 2.1
Name: idpmodem
Version: 2.3.6
Summary: A library for interfacing with an Inmarsat IsatData Pro satellite IoT modem using serial AT commands.
Home-page: https://github.com/inmarsat-enterprise.com/idpmodem
License: Apache2.0
Keywords: satellite,iot
Author: geoffbrucepayne
Author-email: geoff.bruce-payne@inmarsat.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aioserial (==1.3.0)
Requires-Dist: pyserial (>=3.5,<4.0)
Requires-Dist: pyserial-asyncio (>=0.6,<0.7)
Project-URL: Repository, https://github.com/inmarsat-enterprise.com/idpmodem
Description-Content-Type: text/markdown

# 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.
