PlaceOS::Model::Module

macro level key => type

Deserializes the given JSON in string_or_io into an instance of self, assuming the JSON consists of an JSON object with key root, and whose value is the value to deserialize. Will not deserialise from fields with mass_assign: false

class User < ActiveModel::Model
  attribute name : String
  attribute google_id : UUID, mass_assign: false
end

User.from_json(%({"main": {"name": "Jason", "google_id": "f6f70bfb-c882-446d-8758-7ce47db39620"}}), root: "main") # => #<User:0x103131b20 @name="Jason">

Serialize from a trusted JSON source

Serialize from a trusted YAML source

Initialize PlaceOS::Model::Module from HTTP::Params.

Returns all attribute keys.

Look up instances of this model dependent on the foreign key

Look up instances of this model dependent on the foreign key

Look up instances of this model dependent on the foreign key

Changefeed at row (if id passed) or whole table level. Returns a ChangeFeed instance which can be used to invoke async callbacks via on or use blocking Iterator via each method.

Hint in the model id whether the module is an edge module

Fetch Modules who have a direct parent ControlSystem

Find Modules allocated to an Edge

Base class for all Engine models

Control System the logic module may be assigned to

Control System the logic module may be assigned to

The binary the module is to run on

The binary the module is to run on

The edge node the module may be assigned to

The edge node the module may be assigned to

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

alert_level getter

alert_level setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

alert_level's default value

Include alert_level in the set of changed attributes, whether it has changed or not.

Generate code to apply default values

Assign to multiple attributes.

Assign to multiple attributes via HTTP::Params.

Assign to multiple attributes from a model object

Assign each field from JSON if field exists in JSON and has changed in model

Uses the YAML parser as JSON is valid YAML

Returns a Hash of all attribute values

Returns a NamedTuple of all attribute values.

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

Check if any attributes have changed.

Returns a Hash with all changed attributes.

Serialize the set of changed attributes to JSON.

Serialize the set of changed attributes to JSON.

Serialize the set of changed attributes to YAML.

Serialize the set of changed attributes to YAML.

Reset changes for all attributes.

connected getter

connected setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

connected's default value

Connected state in model so we can filter and search on it

Include connected in the set of changed attributes, whether it has changed or not.

Retrieves the parent relationship

Control System the logic module may be assigned to

Sets the parent relationship

control_system_id getter

control_system_id setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

control_system_id's default value

Control System the logic module may be assigned to

Include control_system_id in the set of changed attributes, whether it has changed or not.

created_at getter

Setters created_at setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

created_at's default value

Include created_at in the set of changed attributes, whether it has changed or not.

custom_name getter

custom_name setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

custom_name's default value

Custom module names (in addition to what is defined in the driver)

Include custom_name in the set of changed attributes, whether it has changed or not.

Encrypted yaml settings, with metadata

Retrieves the parent relationship

The binary the module is to run on

Set driver and role

driver_id getter

driver_id setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

driver_id's default value

The binary the module is to run on

Include driver_id in the set of changed attributes, whether it has changed or not.

Retrieves the parent relationship

The edge node the module may be assigned to

Sets the parent relationship

edge_id getter

edge_id setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

edge_id's default value

The edge node the module may be assigned to

Include edge_id in the set of changed attributes, whether it has changed or not.

error_timestamp getter

error_timestamp setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

error_timestamp's default value

Include error_timestamp in the set of changed attributes, whether it has changed or not.

has_runtime_error getter

has_runtime_error setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

has_runtime_error's default value

Runtime Error Indicators

Include has_runtime_error in the set of changed attributes, whether it has changed or not.

Getter for the module's host

Setter for Device module ip

id getter

id setter

Returns a Tuple of the previous and the current value of an instance variable if it has changed

id's default value

Include id in the set of changed attributes, whether it has changed or not.

ignore_connected getter

ignore_connected setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

ignore_connected's default value

Don't include this module in statistics or disconnected searches Might be a device that commonly goes offline (like a PC or Display that only supports Wake on Lan)

Include ignore_connected in the set of changed attributes, whether it has changed or not.

ignore_startstop getter

ignore_startstop setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

ignore_startstop's default value

Include ignore_startstop in the set of changed attributes, whether it has changed or not.

Base class for all Engine models

ip getter

ip setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

ip's default value

Include ip in the set of changed attributes, whether it has changed or not.

launch_on_execute getter

launch_on_execute setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

launch_on_execute's default value

Include launch_on_execute in the set of changed attributes, whether it has changed or not.

makebreak getter

makebreak setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

makebreak's default value

Include makebreak in the set of changed attributes, whether it has changed or not.

Merge settings hierarchy to JSON

Read more

name getter

name setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

name's default value

Module name

Include name in the set of changed attributes, whether it has changed or not.

notes getter

notes setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

notes's default value

Include notes in the set of changed attributes, whether it has changed or not.

Whether or not module is an edge module

Returns a Hash of all attributes that can be persisted.

port getter

port setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

port's default value

Include port in the set of changed attributes, whether it has changed or not.

Base class for all Engine models

The edge node the module may be assigned to

Use custom name if it is defined and non-empty, otherwise use module name

Reset each attribute to their previous values and clears all changes.

role getter

role setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

role's default value

Cache the module's driver role locally for load order

Include role in the set of changed attributes, whether it has changed or not.

running getter

running setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

running's default value

Include running in the set of changed attributes, whether it has changed or not.

Encrypted yaml settings, with metadata

Collect Settings ordered by hierarchy

Module > (Control System > Zones) > Driver

Finds the systems for which this module is in use

tls getter

tls setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

tls's default value

Include tls in the set of changed attributes, whether it has changed or not.

udp getter

udp setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

udp's default value

Include udp in the set of changed attributes, whether it has changed or not.

updated_at getter

updated_at setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

updated_at's default value

Include updated_at in the set of changed attributes, whether it has changed or not.

uri getter

uri setter

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

Returns a Tuple of the previous and the current value of an instance variable if it has changed

uri's default value

HTTP Service module

Include uri in the set of changed attributes, whether it has changed or not.

Validate that all non-nillable fields have values.