ExposedObjects — expose() API#

-- Najprostsze użycie — eksponuj obiekt z rejestru
local lamp = _:get("CLU.DOUT1")
expose(lamp, "switch", {name = "Lampa Salon", area = "Salon"})

-- Fluent API
expose(lamp, "switch"):name("Lampa"):readonly()

-- Eksponuj dimmer z zakresem
expose(dimmer, "dimmer", {name = "LED Kuchnia", min = 0, max = 100})

-- Eksponuj scenę
expose(myScene, "scene", {name = "Wieczór"})

-- Eksponuj wszystko z rejestru automatycznie
exposeRegistry()

local handle = expose(obj, objType, options)

switch    = { read=true, write=true, binary=true }
light     = { read=true, write=true, brightness=true }
dimmer    = { read=true, write=true, brightness=true, range={0,100} }
sensor    = { read=true, write=false, binary=true }
motion    = { read=true, write=false, binary=true, event=true }
temperature = { read=true, write=false, unit="°C", range={-40,80} }
humidity  = { read=true, write=false, unit="%", range={0,100} }
cover     = { read=true, write=true, position=true, range={0,100} }
scene     = { read=false, write=false, execute=true, stateless=true }
number    = { read=true, write=true, range={0,100} }
button    = { read=false, write=false, execute=true, event=true }
lock      = { read=true, write=true, binary=true }
fan       = { read=true, write=true, speed=true, range={0,100} }
climate   = { read=true, write=true, temperature=true, range={5,35} }
garage_door = { read=true, write=true, binary=true }

handle:name("Lampa Salon")      -- ustaw nazwę
handle:readonly()                -- oznacz read-only
handle:mqttOnly()                -- wyłącz HomeKit
handle:homekitOnly()             -- wyłącz MQTT
handle:group("salon")            -- ustaw grupę

expose(obj, "switch")
    :name("Lampa")
    :readonly()
    :mqttOnly()

handle:getValue()               -- wywołuje obj:get(0), zwraca wartość lub nil
handle:setValue(value)           -- wywołuje obj:set(0, value), emituje state_changed
handle:getPath()                -- zwraca unikalną ścieżkę
handle:isExposed()              -- sprawdza czy wciąż wyeksponowany (boolean)

handle:update({readonly = true})   -- merge opcji, emituje object_updated
handle:rename("Nowa Nazwa")        -- zmiana nazwy, emituje object_updated
handle:unexpose()                   -- usuwa z eksponowanych (idempotent)

handle:executeScene()

-- Wewnętrznie (w expose):
local unsubscribe = obj:onChange(function(value)
    StateBus:getShared():emit("state_changed", {
        path = handle.path,
        value = value,
        type = handle.type,
    })
end)
handle._unsubscribe = unsubscribe

function MyObject:onChange(callback)
    table.insert(self._callbacks, callback)
    -- MUSI zwrócić funkcję unsubscribe
    return function()
        for i, cb in ipairs(self._callbacks) do
            if cb == callback then table.remove(self._callbacks, i); break end
        end
    end
end

StateBus:getShared():on("object_exposed", function(data)
    -- data: {path, type, name, options}
end)

StateBus:getShared():on("state_changed", function(data)
    -- data: {path, value, type}
end)

StateBus:getShared():on("object_updated", function(data)
    -- data: {path}
end)

StateBus:getShared():on("object_unexposed", function(data)
    -- data: {path}
end)

{
  "name": "Lampa Salon",
  "unique_id": "vclu_lamp_salon",
  "object_id": "vclu_lamp_salon",
  "state_topic": "vclu/exposed/vclu/switch/lamp_salon/state",
  "command_topic": "vclu/exposed/vclu/switch/lamp_salon/state/set",
  "availability_topic": "vclu/status",
  "payload_available": "online",
  "payload_not_available": "offline",
  "device": {
    "identifiers": ["vclu"],
    "name": "Virtual CLU",
    "model": "Virtual CLU",
    "manufacturer": "Grenton"
  }
}

TypeMap.getExposeType(grentonType, default)        -- Grenton → expose
TypeMap.getHAComponent(exposeType, default)        -- expose → HA
TypeMap.getHAComponentFromGreton(grentonType)      -- Grenton → HA (legacy)
TypeMap.isValidExposeType(exposeType)              -- walidacja
TypeMap.getExposeTypes()                           -- lista typów expose
TypeMap.getHAComponents()                          -- lista komponentów HA

local count = exposeRegistry()
local count = exposeRegistry({area = "Dom"})

-- Wewnętrznie przy ładowaniu pluginu:
ExposedObjects:setPluginContext("@vclu/weather")

-- expose() w kontekście pluginu:
expose(tempObj, "temperature", {id = "temperature"})
-- → ścieżka: "@vclu/weather:temperature"

-- Czyszczenie przy wyładowaniu:
ExposedObjects:unexposeByPlugin("@vclu/weather")
-- Usuwa wszystkie obiekty z prefiksem "@vclu/weather:"

ExposedObjects:list()                -- {path → handle} — wszystkie wyeksponowane
ExposedObjects:get(path)             -- handle lub nil
ExposedObjects:count()               -- liczba wyeksponowanych
ExposedObjects:getCapabilities(type) -- capabilities danego typu
ExposedObjects:toJSON(filter)        -- JSON (dla HomeKit: {homekit=true})

-- Bezpieczne expose z pcall
local ok, handle = pcall(expose, obj, "switch", {name = "Test"})
if ok then
    print("Exposed: " .. handle:getPath())
else
    print("Error: " .. tostring(handle))
end

local lamp = _:get("CLU.DOUT1")
local dimmer = _:get("CLU.DIMM1")
local roller = _:get("CLU.ROLLER1")

expose(lamp, "switch", {name = "Lampa Salon", area = "Salon"})
expose(dimmer, "dimmer", {name = "LED Kuchnia", area = "Kuchnia"})
expose(roller, "cover", {name = "Roleta Sypialnia", area = "Sypialnia"})

-- Taguj obiekty
_:get("CLU.DOUT1"):addTag("salon", "lights")
_:get("CLU.DOUT2"):addTag("salon", "lights")
_:get("CLU.DIMM1"):addTag("kuchnia", "lights")

-- Expose po tagu
_:byTag("lights"):expose("switch", {area = "Dom"})

-- Tylko MQTT (bez HomeKit)
expose(sensor, "temperature", {name = "Temp zewn."}):mqttOnly()

-- Tylko HomeKit (bez MQTT)
expose(lamp, "switch", {name = "Lampa"}):homekitOnly()

-- Read-only sensor
expose(motion, "motion", {name = "Ruch korytarz"}):readonly()

local myObj = {
    _value = 0,
    _callbacks = {},
}

function myObj:get(idx) return self._value end

function myObj:set(idx, val)
    local old = self._value
    self._value = val
    for _, cb in ipairs(self._callbacks) do cb(val) end
end

function myObj:onChange(cb)
    table.insert(self._callbacks, cb)
    return function()
        for i, c in ipairs(self._callbacks) do
            if c == cb then table.remove(self._callbacks, i); break end
        end
    end
end

expose(myObj, "number", {name = "Mój czujnik", min = 0, max = 100, unit = "%"})

local scenes = {
    evening = function()
        _:byTag("salon"):setValue(30)
        _:get("CLU.ROLLER1"):execute(0)  -- zamknij rolety
    end
}

for name, fn in pairs(scenes) do
    local sceneObj = {execute = function(self, idx) fn() end}
    expose(sceneObj, "scene", {name = name, id = name})
end