Class PlaceModule

Hierarchy (View Summary)

PlaceResource
- PlaceModule

Index

Constructors

constructor

new PlaceModule(raw_data?: PlaceModuleComplete): PlaceModule
Parameters
- raw_data: PlaceModuleComplete = {}
Returns PlaceModule
Overrides PlaceResource.constructor
- Defined in modules/module.ts:74

Properties

`Readonly`connected

connected: undefined | boolean

Whether the associated hardware is connected

`Readonly`control_system_id

control_system_id: string

ID of the system associated with the module

`Readonly`created_at

created_at: number

Unix epoch in seconds of the creation time of the object

`Readonly`custom_name

custom_name: string

Custom name of the module

`Optional` `Readonly`driver

driver?: PlaceDriver

Driver/dependancy associated with the module

`Readonly`driver_id

driver_id: string

ID of the driver associated with the module

`Readonly`edge_id

edge_id: string

ID of the edge associated with the module

`Readonly`error_timestamp

error_timestamp: number

Timestamp of the last runtime error in ms since UTC epoch

`Readonly`has_runtime_error

has_runtime_error: boolean

Whether the module has a runtime error

`Readonly`id

id: string

Unique Identifier of the object

`Readonly`ignore_connected

ignore_connected: boolean

Ignore connection issues

`Readonly`ip

ip: string

IP address of the hardware associated with the module

`Readonly`makebreak

makebreak: boolean

`Readonly`name

name: string

Human readable name of the object

`Readonly`notes

notes: string

Notes associated with the module

`Readonly`port

port: number

Port number connections to the hardware are made on

`Readonly`role

role: PlaceDriverRole

Type of module

`Readonly`running

running: boolean

Whether the module driver is running

`Readonly`settings

settings: [
    null
    | PlaceSettings,
    null | PlaceSettings,
    null | PlaceSettings,
    null | PlaceSettings,
] = ...

Tuple of user settings of differring encryption levels for the module

`Optional` `Readonly`system

system?: PlaceSystem

System associated with the module

`Readonly`tls

tls: boolean

Whether the hardware connection requires TLS

`Readonly`udp

udp: boolean

Whether the hardware connection is over UDP

`Readonly`updated_at

updated_at: number

Timestamp of last update in ms since UTC epoch

`Readonly`uri

uri: string

URI associated with the module

`Readonly`version

version: number

Version of the data

Accessors

system_id

get system_id(): string
ID of the system associated with the module

Returns string
- Defined in modules/module.ts:70

Methods

toJSON

toJSON(keep_system?: boolean): HashMap
Convert object into plain object
Parameters
- keep_system: boolean = false
Returns HashMap
Overrides PlaceResource.toJSON
- Defined in modules/module.ts:115

Class PlaceModule

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PlaceModule

Properties

Readonlyconnected

Readonlycontrol_system_id

Readonlycreated_at

Readonlycustom_name

Optional Readonlydriver

Readonlydriver_id

Readonlyedge_id

Readonlyerror_timestamp

Readonlyhas_runtime_error

Readonlyid

Readonlyignore_connected

Readonlyip

Readonlymakebreak

Readonlyname

Readonlynotes

Readonlyport

Readonlyrole

Readonlyrunning

Readonlysettings

Optional Readonlysystem

Readonlytls

Readonlyudp

Readonlyupdated_at

Readonlyuri

Readonlyversion

Accessors

system_id

Returns string

Methods

toJSON

Parameters

Returns HashMap

Settings

On This Page

`Readonly`connected

`Readonly`control_system_id

`Readonly`created_at

`Readonly`custom_name

`Optional` `Readonly`driver

`Readonly`driver_id

`Readonly`edge_id

`Readonly`error_timestamp

`Readonly`has_runtime_error

`Readonly`id

`Readonly`ignore_connected

`Readonly`ip

`Readonly`makebreak

`Readonly`name

`Readonly`notes

`Readonly`port

`Readonly`role

`Readonly`running

`Readonly`settings

`Optional` `Readonly`system

`Readonly`tls

`Readonly`udp

`Readonly`updated_at

`Readonly`uri

`Readonly`version