struct PlaceOS::API::Models::Module

• PlaceOS::API::Models::Module
• Struct
• Value
• Object

Included Modules

• JSON::Serializable

Defined in:

placeos/api/models/module.cr

Constructors

• .new(pull : JSON::PullParser)

Instance Method Summary

• #connected : Bool

  Flag for connectivity state.

• #control_sytem_id : String | Nil

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

• #created_at : Time
• #custom_name : String | Nil

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

• #dependency_id : String

  The driver that defines this module.

• #edge_id : String

  The engine node that this module runs on.

• #id : String

  A universally unique identifier for the module.

• #ignore_connected : Bool

  If enabled, system metrics ignore connectivity state.

• #ignore_startstop : Bool

  If enabled, system level start and stop actions are ignored.

• #ip : String | Nil

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

• #makebreak : Bool

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

• #notes : String | Nil

  Markdown formatted text that describes this module.

• #port : Int32 | Nil

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

• #role : Role

  The associated driver type.

• #running : Bool

  Module start/stop state.

• #settings : Hash(String, JSON::Any)

  JSON object representing the system's configuration.

• #tls : Bool | Nil

  True if the device communicates securely.

• #udp : Bool | Nil

  Protocol uses UDP rather that TCP.

• #updated_at : Time
• #uri : URI | Nil

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

Constructor Detail

Instance Method Detail