Javascript

Latest Release

Version 1.1.0

Setup

Login npm private repository

npm login --scope=@teldio-operations --registry=https://npm.pkg.github.com
  • A personel access token is required with read:repository permission

Add Signal-Application-SDK as a dependency

npm install @teldio-operations/signal-application-sdk

Initialize SDK

init(applicationType: string, onConfigurationChangeRequestedCallback: OnConfigurationChangeRequested, onEventReceivedCallback: OnEventReceived)

Entry point for Signal Application SDK

  • Creates a bi-directional communication between device agent and application

Call next to forward the event to the next node

next(event: string)

Provide a callback method to get notified when a configuration change is requested

onConfigurationChangeRequested(newConfig: object)
  • Will be triggered when a new configuration change is received by device agent

Provide a callback method to get notified when an event is received from event bus

onEventReceived(event: object)
  • Will be triggered when a new event received from application's subscribed topic

Please refer to the Python SDK example

Last updated