struct

PlaceOS::API::Models::Module

Inherits JSON::Serializable < Struct < Value < Object

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

connected

Flag for connectivity state.

Source
control_sytem_id

The system this module is bound to (logic modules only).

Source
created_at

System creation time.

Source
custom_name

The modules class name (Display, Lighting etc) if it should differ from the default defined in the dependency.

Source
dependency_id

The driver that defines this module.

Source
edge_id

The engine node that this module runs on.

Source
id

A universally unique identifier for the module.

Source
ignore_connected

If enabled, system metrics ignore connectivity state.

Source
ignore_startstop

If enabled, system level start and stop actions are ignored. This is recommended for modules shared by many systems (e.g. a lighting gateway).

Source
ip

IP address or resolvable hostname of the device this module connects to.

Source
makebreak

If enabled, provides an ephemeral connection that disconnects during idle periods.

Source
notes

Markdown formatted text that describes this module.

Source
port

The TCP or UDP port that the associated device communicates on.

Source
role

The associated driver type.

Source
running

Module start/stop state.

Source
settings

JSON object representing the system's configuration.

Source
tls

True if the device communicates securely.

Source
udp

Protocol uses UDP rather that TCP.

Source
updated_at

Last update time.

Source
uri

The based URI of the remote service (service modules only).

Source