meta.lua

--[[-----------------------------------------------------------------------------
/*!
\file
\copyright 2025 Pharos Architectural Controls LTD. as an unpublished work.  All Rights Reserved.
*/
--]]-----------------------------------------------------------------------------

---------------------------------------------------------------------------------
--[[ Pharos Types ]]--
---------------------------------------------------------------------------------

---@alias UniverseKey string
---@alias SpaceId number

---------------------------------------------------------------------------------
--[[ Handlers ]]--
---------------------------------------------------------------------------------

-- ExecuteCommand
-- Function called by Director when a command is received for this DriverWorks driver
---@type table<string, fun(PARAM: table)>
EC = {}

---------------------------------------------------------------------------------

-- ReceivedFromProxy
-- Function called by Director when a proxy bound to the specified binding sends a BindMessage to the DriverWorks driver
---@type table<BINDING_ID, fun(PARAM: BINDING_ID, PARAM: string, PARAM: table)>
RFP = {}

---------------------------------------------------------------------------------

-- OnPropertyChanged
-- Function called by Director when a property changes value.
---@type table<string, fun(PARAM: any)>
OPC = {}

---------------------------------------------------------------------------------
--[[ Control messages ]]--
---------------------------------------------------------------------------------

---@class CONTROL_MSG_SEND_TO_CONTROLLER_WS
---@field payload string Payload to send

---@class CONTROL_MSG_SEND_TO_CONTROLLER_HTTP
---@field method HTTP_REQUEST_METHOD HTTP request method
---@field path string Request path
---@field payload string Payload to send
---@field requestId integer? Request identifier returned with the HTTP result
---@field responseCommand string? Command used to return the HTTP result
---@field responseDeviceId integer? Device that receives the HTTP result

---@class CONTROL_MSG_HTTP_RESULT
---@field requestId integer
---@field responseCode integer
---@field errorCode integer
---@field errorMessage string
---@field responseBody string HTTP response body returned with the result

---@class CONTROL_MSG_CHANNEL_LEVEL
---@field level integer

---@class CONTROL_MSG_SPACE_ACTIVE
---@field intensityMaster integer
---@field sceneNum integer Active scene number

---@class CONTROL_MSG_SPACE_SCENES
---@field scenes string JSON Encoded table<integer, string>

---@class CONTROL_MSG_TAGSET_TAGS
---@field tags string JSON Encoded table<integer, string>

---@class CONTROL_MSG_TAGSET_ACTIVE
---@field tagNum integer

---@class CONTROL_MSG_TRIGGER_NAMES
---@field triggers string JSON Encoded table<integer, string>

---------------------------------------------------------------------------------
--[[ light_v2 ]]--
---------------------------------------------------------------------------------

---@class PROXY_MSG_LIGHT_V2_SET_BRIGHTNESS_TARGET
---@field LIGHT_BRIGHTNESS_TARGET number Value as defined from drivers Min and Max brightness capabilities as set by the driver
---@field RATE integer Milliseconds for the ramp duration

---@class PROXY_MSG_LIGHT_V2_LIGHT_BRIGHTNESS_CHANGED
---@field LIGHT_BRIGHTNESS_CURRENT number Raw value of where the light brightness stopped.
---@field LIGHT_BRIGHTNESS_CURRENT_PRESET_ID integer? This should only be included if presets levels are defined and the level is equal to the preset

---------------------------------------------------------------------------------
--[[ keypad ]]--
---------------------------------------------------------------------------------

---@class PROXY_MSG_KEYPAD_NEW_KEYPAD_BUTTON
---@field BUTTON_ID integer The ID of the button being changed
---@field NAME string? The name of the button
---@field ON_COLOR string?	The on/press color for the button
---@field OFF_COLOR string?The off/release color for the button
---@field BUTTON_BEHAVIOR integer? The behavior for the button
---@field LED_BEHAVIOR integer? The LED behavior for the button
---@field SLOTS integer The number of slots the button takes up on the keypad.

---@class PROXY_MSG_KEYPAD_DELETE_KEYPAD_BUTTON
---@field BUTTON_ID integer The ID of the button to be deleted

---@class PROXY_MSG_KEYPAD_KEYPAD_BUTTON_ACTION
---@field ACTION KEYPAD_BUTTON_ACTION The action performed on the keypad
---@field BUTTON_ID integer The ID of the button where the action is performed