Show / Hide Table of Contents

Passthrough Handler

Introduction

IoDataReportPassThrough is a special type of message that is only recognized by Nimbus-adapter module. Nimbus-adapter module treats these type of messages separately & passes it to Nimbus.

For any Edge App to send passthrough messages to Nimbus, Passthrough-Handler Edge App makes it easy by extracting out all the logic to make any message an IoDataReportPassThroughMsg and send it to NImbus.

How it Works

IoDataReportPassThroughMsg:- It is a special type that Passthrough-Handler Edge App use to construct a passthrough message.

Currenly, Passthrough-Handler Edge App supports the below schema types to be converted to IoDatReportPassThroughMsg.

  • Event
  • Request
  • IODataReport
  • FileUpload

Passthrough-Handler Edge App expects the message sent to it as serialized version (equivalent Json String) of the above message type on a custom topic (topic name should have one of the above type names at the end).

Supported End points/Topics

Any message should be sent to the Passthrough-Handler Edge App over these topics depending on the above type of message.

  • PassThrough/Event,
  • PassThrough/Request,
  • PassThrough/IODataReport,
  • PassThrough/FileUpload.

FIle-Upload:- The Sender Edge App is expected to send the content of the file to be wrapped in json. For example:

{
  "File": "File Content"
}

Message Format

After receiving messages over these topics, Passthrough-Handler Edge App converts it to an IoDataReportPassThroughMsg payload.

Message --> This is test passthrough event.

IODataPassThroughTelemetry

Passthrough-Handler{ .img-thumbnail }

IODataReportPassThroughMsg

Passthrough-Handler{ .img-thumbnail }

Such payload is sent to ION as IODataReportPassthrough message type which indicates Nimbus to forward message to Onesite, Onesite can decode the protobuf message and show data.

Data Flow

Passthrough-Handler{ .img-thumbnail }

  • Improve this Doc
In This Article
Back to top Copyright © 2023 SLB, Published Work. All rights reserved.