PlaceOS::Model::ControlSystem

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::ControlSystem from HTTP::Params.

Returns all attribute keys.

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.

DEPRECATED Use .by_zone_id

Base class for all Engine models

DEPRECATED Use .by_module_id

Removes the module from the system and deletes it if not used elsewhere

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

Base class for all Engine models

Generate code to apply default values

approval getter

approval 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

approval's default value

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

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

bookable getter

bookable 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

bookable's default value

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

camera_snapshot_urls getter

camera_snapshot_urls 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

camera_snapshot_urls's default value

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

camera_url getter

camera_url setter

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

camera_url's default value

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

capacity getter

capacity 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

capacity's default value

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

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.

ensure all the modules are valid and exist

Remove Modules not associated with any other systems NOTE: Includes compulsory associated Logic Modules

Reset changes for all attributes.

code getter

code setter

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

code's default value

Include code 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.

description getter

description 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

description's default value

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

Metadata belonging to this control_system

Encrypted yaml settings, with metadata

Single System triggers

display_name getter

display_name setter

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

display_name's default value

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

email getter

email setter

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

email's default value

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

features getter

features 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

features's default value

Room search meta-data Building + Level are both filtered using zones

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

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.

images getter

images 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

images's default value

Array of URLs to images for a system

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

installed_ui_devices getter

installed_ui_devices 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

installed_ui_devices's default value

The number of UI devices that are always available in the room i.e. the number of iPads mounted on the wall

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

Base class for all Engine models

map_id getter

map_id setter

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

map_id's default value

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

Metadata belonging to this control_system

Obtains the control system's modules as json FIXME: Dreadfully needs optimisation, i.e. subset serialisation

modules getter

modules 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

modules's default value

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

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

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

orientation getter

orientation 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

orientation's default value

Systems as digital signage displays playlists can be assigned directly to displays or to zones playlists in zones will only be loaded if they have matching orientations

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

Returns a Hash of all attributes that can be persisted.

Retrieves the parent relationship

Sets the parent relationship

playlist_item_id getter

playlist_item_id setter

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

playlist_item_id's default value

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

playlists getter

playlists 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

playlists's default value

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

Base class for all Engine models

public getter

public 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

public's default value

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

Removes the module from the system and deletes it if not used elsewhere

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

room_booking_url getter

room_booking_url setter

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

room_booking_url's default value

if not bookable via google / O365 calendaring systems

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

security_groups getter

security_groups 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

security_groups's default value

Array of security group ids for room access

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

Encrypted yaml settings, with metadata

Collect Settings ordered by hierarchy

Control System < Zone/n < Zone/(n-1) < ... < Zone/0

signage getter

signage 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

signage's default value

signage_last_seen getter

signage_last_seen 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

signage_last_seen's default value

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

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

space_config getter

space_config 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

space_config's default value

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

support_url getter

support_url 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

support_url's default value

Provide fields for simplifying support

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

Single System triggers

timetable_url getter

timetable_url setter

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

timetable_url's default value

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

timezone getter

timezone setter

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

timezone's default value

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

Triggers

type getter

type setter

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

type's default value

Include type 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.

Validate that all non-nillable fields have values.

version getter

version 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

version's default value

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

Obtains the control system's zones as json

zones getter

zones 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

zones's default value

IDs of associated models

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