Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Protected _changes

_changes: HashMap

Map of unsaved property changes

Protected Optional _init_sub

_init_sub: Subscription

Subscription for initialisation events

Protected _server_names

_server_names: HashMap

Map of local property names to server ones

Protected _service

Protected _version

_version: number

Version of the data

changeEvents

changeEvents: Subject<EngineDataClassEvent> = new Subject<EngineDataClassEvent>()

Subject for change events to the class object

connected

connected: boolean

Whether the associated hardware is connected

control_system_id

control_system_id: string

ID of the system associated with the module

created_at

created_at: number

Unix epoch in seconds of the creation time of the object

custom_name

custom_name: string

Custom name of the module

dependency_id

dependency_id: string

ID of the driver associated with the module

Optional driver

driver: EngineDriver

Driver/dependancy associated with the module

id

id: string

Unique Identifier of the object

ignore_connected

ignore_connected: boolean

Ignore connection issues

ip

ip: string

IP address of the hardware associated with the module

makebreak

makebreak: boolean

name

name: string

Human readable name of the object

notes

notes: string

Notes associated with the module

port

port: number

Port number connections to the hardware are made on

role

Type of module

running

running: boolean

Whether the module driver is running

settings

settings: EngineSettings

Map of user settings for the system

Optional system

system: EngineSystem

System associated with the module

tls

tls: boolean

Whether the hardware connection requires TLS

udp

udp: boolean

Whether the hardware connection is over UDP

updated_at

updated_at: number

Timestamp of last update in ms since UTC epoch

uri

uri: string

URI associated with the module

Accessors

changes

system_id

  • get system_id(): string

Methods

Protected change

  • change<U>(prop_name: string, value: U): void

clearPendingChanges

  • clearPendingChanges(): void

debug

delete

  • delete(): Promise<void>

emit

internalState

  • internalState(): Promise<HashMap>

ping

save

start

  • start(): Promise<void>

state

  • state(lookup?: undefined | string): Promise<HashMap>

stop

  • stop(): Promise<void>

storePendingChange

toJSON

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc