Skip to content

Latest commit

 

History

History
146 lines (112 loc) · 4.76 KB

README.md

File metadata and controls

146 lines (112 loc) · 4.76 KB
Raw
languages products
nodejs
javascript
azure
azure-functions
azure-logic-apps
azure-event-grid
azure-cosmos-db
azure-storage
azure-app-service

Satellite IoT Messaging Microservice

IsatData Pro System Architecture

IsatData Pro System Architecture

  • A Mailbox provides authentication credentials for API calls to the Inmarsat service, and provides access to an interest group of devices associated with a satellite modem (aka Mobile).

  • A Mobile is the satellite modem associated with a remote Device or Edge Gateway, identified by a globally unique Mobile ID. The Mobile could also be considered a leaf device in that it includes location services and various configuration and property metadata.

  • A Message contains the data payload sent over the satellite link in a given direction:

    • Return messages (aka Mobile-Originated) are sent from the modem such as telemetry, properties, metadata
    • Forward messages (aka Mobile-Terminated) are sent to the modem such as commands or configuration and have corresponding Status to indicate state and reason for the state

  • A Satellite Gateway is effectively an API server URL associated with a network operator, and is modeled to include the API/server state

MessageReturnGet

Timer Trigger

Periodically polls all Mailboxes stored in the database, with a default interval of 30 seconds. The invoked library function puts the message content and metadata in the database after checking/discarding duplicates.

Publishes the following EventGrid Events:

  • NewReturnMessage
  • NewMobile
  • ApiOutage
  • ApiRecovery

MessageForwardSubmit

EventGrid Trigger

When a NewForwardSubmission is published to the EventGrid, the invoked library submits the message to transmit over the satellite network, and if successful stores its content and initial status in the database.

Publishes the following EventGrid Events:

  • NewForwardMessage
  • ApiOutage
  • ApiRecovery
  • TODO: FailedMessageSubmission

TODO: IoT Hub and/or front-end web GUI to create/send a Forward Message into this service, and handle failed message submissions

MessageForwardStatusGet

Timer Trigger

Periodically polls all Mailboxes stored in the database, with a default interval of 30 seconds. The invoked library function checks against known messages/statuses in the database and updates the status in the database accordingly. If a status is retrieved that does not correspond to a known message in the database, it publishes OtherClientForwardSubmission.

Publishes the following EventGrid Events:

  • ForwardMessageStateChange
  • OtherClientForwardSubmission
  • ApiOutage
  • ApiRecovery

MessageForwardGet

EventGrid Trigger

When an OtherClientForwardSubmission is published to the EventGrid, the invoked library retrieves the message via the Inmarsat API and puts the content and status in the database.

Publishes the following EventGrid Events:

  • NewMobile
  • ApiOutage
  • ApiRecovery

MobileGet

EventGrid Trigger

When a NewMobile is published to the EventGrid, the invoked library retrieves the Mobile metadata from the Inmarsat API and updates the database.

Publishes the following EventGrid Events:

  • NewMobile
  • ApiOutage
  • ApiRecovery

MailboxUpdate

EventGrid Trigger

When a MailboxUpdate is published to the EventGrid, the invoked library stores the Mailbox metadata in the database (encrypting the password at rest).

TODO: Front-end GUI to administer Mailboxes

SatelliteGatewayUpdate

EventGrid Trigger

When a SatelliteGatewayUpdate is published to the EventGrid, the invoked library stores the Satellite Gateway metadata in the database.

TODO: Front-end GUI to administer Satellite Gateways which publishes TBD

SharedCode

eventGrid (deprecated)

The invoked API library provides an eventHandler emitter that has the following events which this module publishes to EventGrid:

  • NewMobile: mobileId, mailboxId, source
  • NewReturnMessage: messageId, mobileId, mailboxId, source
  • NewForwardMessage: messageId, mobileId, mailboxId, source
  • ForwardMessageStateChange: messageId, mobileId, newState
  • OtherClientForwardSubmission: messageId, mailboxId
  • ApiOutage: satelliteGateway, timestamp
  • ApiRecovery: satelliteGateway, timestamp

logger

The invoked API library provides a Winston-based logger with helpful JSON-format logs and provides a wrapper to include the calling function name for debug purposes. These can be viewed using Streaming Logs.

appInsights (Not Implemented)

Is intended to allow for logs from the invoked library to be pushed into Application Insights.

TODO: convert relevant logs into Insights