Omlet Hühnerstall webhook API

Homoran

@OliverIO ich muss ehrlich sagen, ich wüsste jetzt nicht ob der zwischen die Anführungszeichen kommen müsste, oder ohne, und wenn ja, ob er die richtigen genommen hat. also keine Backticks o.ä.

jwerlsdf

@homoran
natürlich habe ich den token dort zwischen die Anführungszeichen eingetragen. Alternativ würde ich auch den token per pn schicken um definitiv das Problem von meiner Seite auszuschließen. Der Token ist von der Seite 1zu1 kopiert, kann also am "abschreiben" nicht liegen ;)

OliverIO

@jwerlsdf

ja dann sende ihn bitte per pn.
dann probiere ich das script mal unter vscode aus. da hat man mehr debug möglichkeiten

OliverIO

@jwerlsdf

ok mit vscode kommt bei getdevices der selbe fehler.
ich versuche mal noch etwas anderes.

ok, keine ahnung ob es nun an der bibliothek liegt oder an etwas anderem.

per direkter axios kommunikation konnte ich nun die informationen abrufen
in den statusinformationen gab es diese information

lastConnected: "2026-03-07T14:06:16+00:00",
nextConnection: "2026-03-07T14:06:16+00:00",
overdueConnection: 1,

keine Ahnung, ob das jetzt daran liegt, das das gerät irgendwie seit gestern kein kontakt mehr hatte.

es gibt genau ein device id
dieses hat die folgenden aktionen die ausgeführt werden könnten

[
  "calibrate => Calibrate Door",
  "close => Close Door",
  "detect => Detect Coop Light",
  "factory_reset => Factory Reset",
  "firmware_update => Check for Firmware Update",
  "off => Light Off",
  "on => Light On",
  "open => Open Door",
  "restart => Restart",
  "setup_wifi => Reset Wifi Credentials",
  "stop => Stop Door",
]

welche davon sinnvoll sind weiß ich nicht. such dir mal welche aus, die wir hier umsetzen wollen (erst mal mit den wichtigsten anfangen)

darüber hinaus sehe ich den status

    state: {
      light: {
        state: "onpending",
      },
      general: {
        firmwareVersionCurrent: "1.0.54-f3d53670",
        firmwareLastCheck: "2026-03-07T13:16:27+01:00",
        batteryLevel: 100,
        powerSource: "external",
        displayLine1: "                ",
        displayLine2: "                ",
        firmwareVersionPrevious: "1.0.47-6870ee4d",
        uptime: 6596,
      },
      connectivity: {
        wifiStrength: -70,
        ssid: "MTL",
        connected: false,
      },
      door: {
        state: "open",
        lastOpenTime: "2026-03-07T06:00:12+01:00",
        lastCloseTime: "2026-03-06T23:16:01+01:00",
        fault: "none",
        lightLevel: 100,
      },
    },

und die configuration

    configuration: {
      door: {
        openMode: "time",
        openDelay: 0,
        openTime: "06:00",
        closeMode: "light",
        closeDelay: 0,
        closeLightLevel: 6,
        closeTime: "20:00",
        openLightLevel: 27,
        doorType: "sliding",
        colour: "green",
        lightOffset: 3,
        temperatureUnit: "C",
      },
      light: {
        mode: "auto",
        minutesBeforeClose: 5,
        maxOnTime: 3,
        equipped: 2,
      },
      connectivity: {
        wifiState: "on",
      },
      general: {
        datetime: "2026-03-07T14:56:35+01:00",
        timezone: "Europe/Berlin",
        updateFrequency: 86400,
        language: "de",
        stayAliveTime: 0,
        statusUpdatePeriod: 21600,
        pollFreq: 600,
        overnightSleepEnable: true,
        overnightSleepStart: "21:00",
        overnightSleepEnd: "05:00",
      },
    },

jwerlsdf

Hi, das sieht sehr gut aus. Ja tatsächlich habe ich seit gestern den Stecker von der Tür gezogen. Dadurch habe ich auch keine Infos mehr in der app. Ich werde nachher gerne die Tür an die Steckdose wieder stecken, sobald ich von der Arbeit zurück bin. Da sollten hoffentlich bei dir aktuelle Infos reinkommen.

jwerlsdf

Die wichtigsten FUnktionen wären für mich das Licht an/ausschalten und die Tür auf/zu machen zu können. SO wie ich das dann verstanden habe, kann ich die Konfiguration ebenfalls ändern? Dann wäre die dritte funktion die Uhrzeiten zu ändern (open and close Time).

OliverIO

@jwerlsdf

so hier zum probieren für die erste runde für licht und tor
token noch eintragen
den device id hab ich jetzt nicht versteckt, ohne den token kann da niemand was mit anfangen
vor dem start bitte noch die beiden datenpunkte vom typ boolean anlegen und die datenpunktnamen dann am anfang in der configuration area eintragen.
prüfe bitte mal ob du bei den zusätzlichen npm module auch axios eingetragen hast.
eigentlich ist das nicht notwendig, da der javascriptadapter selbst axios verwendet, aber um für die zukunft sauber zu sein ist das besser

meine aktuellen experimente für das licht hat den status 204 zurückgegeben.
der doku nach bedeutet das

Action has been queued to be sent to the device

Keine Ahnung ob jetzt alles abgespult wird wenn du es anschaltest.

// -- configuration area
const token = 'apitoken';
const outdoorDeviceId = 'laTnMsWSJxBMGgJD';
const dp_light = '0_userdata.0.omlet.light'; // datenpunkt mit typ bool anlegen und namen hier eintragen
const dp_door = '0_userdata.0.omlet.door'; // datenpunkt mit typ bool anlegen und namen hier eintragen
// --

const axios = require("axios/dist/browser/axios.cjs");
const BASE_URL = 'https://x107.omlet.co.uk/api/v1'; //kann hier geprüft werden https://smart.omlet.de/developers/api
let omlet = undefined;

async function connect() {
    console.log("start main2");
    omlet = await omletAPIClient(token);
    await getDevices(true);

    //console.log(JSON.stringify(await getDevices(), null, 2));
}
async function getDevices(info = false) {
    try {
        const devices = await getRequest('/device');
        if (devices && info) {
            devices.forEach(device => {
                console.log(`Device name: ${device.name}, deviceId: ${device.deviceId}`);
            });
        }
        return devices;
    } catch (error) {
        console.log(error);
        return [];
    }
}
async function doAction(deviceId, actionName) {
    const devices = await getDevices();
    const device = devices.find(device => device.deviceId === deviceId);
    if (device) {
        const action = device.actions.find(action => action.actionName === actionName);
        if (action) {
            await postRequest(action.url);
        }
    }
}
async function lightOn(deviceId) {
    await doAction(deviceId, 'on');
}
async function lightOff(deviceId) {
    await doAction(deviceId, 'off');
}
async function doorOpen(deviceId) {
    await doAction(deviceId, 'open');
}
async function doorClose(deviceId) {
    await doAction(deviceId, 'close');
}
function omletAPIClient(token) {
    return axios.create({
        baseURL: BASE_URL,
        headers: {
            'Authorization': `Bearer ${token}`,
            'Content-Type': 'application/json',
        },
    });
}
async function getRequest(url) {
    try {
        const data = await omlet.get(url);
        console.debug(`get request: ${url},status: ${data.status}`);
        return data.data;
    } catch (e) {
        console.log(e);
    }
}
async function postRequest(url) {
    try {
        const data = await omlet.post(url);
        console.debug(`post request: ${url},status: ${data.status}`);
        return data.data;
    } catch (e) {
        console.log(e);
    }
}
async function main() {
    await connect();
    on({ id: dp_door, change: 'ne' }, async (evt) => {
        //log(evt);
        if (evt.state.val) {
            await doorOpen(outdoorDeviceId);
        } else {
            await doorClose(outdoorDeviceId);
        }
    });
    on({ id: dp_light, change: 'ne' }, async (evt) => {
        //log(evt);
        if (evt.state.val) {
            await lightOn(outdoorDeviceId);
        } else {
            await lightOff(outdoorDeviceId);
        }
    });

    // await lightOn(outdoorDeviceId);
    // await lightOff(outdoorDeviceId);
}
main();

jwerlsdf

Vielen vielen lieben Dank. Es funktioniert hervorragend! :)
Die Umbenennung mache ich dann über die VIS da false für tür zu etwas verwirrend ist.

Würdest du mir noch bitte folgende Funktionen einbauen?
-Tür stop
-Uhrzeiten einstellbar Manuel oder Zeiteingabe für Tür auf/zu ggf zusätzlich Astrofunktion (wobei ich letzteres auch selbst mit einem zweiten Script lösen könnte.... dann soll einfach alles auf manual laufen.

OliverIO

@jwerlsdf

weiter gehts mit der nächsten version.
vorgehensweise wie oben.
es sind ein paar mehr datenpunkte dazugekommen
bitte vorher die datenpunkte anlegen. typ und detailanweisung im zeilenkommentar beachten

const dp_doorstop = '0_userdata.0.omlet.doorstop'; // datenpunkt mit typ bool und rolle button anlegen und namen hier eintragen
const dp_doortimeopen = '0_userdata.0.omlet.doortimeopen'; // datenpunkt mit typ string, zeit im 24h format im format 06:00 oder 20:30
const dp_doortimeclose = '0_userdata.0.omlet.doortimeclose'; // datenpunkt mit typ string, zeit im 24h format im format 06:00 oder 20:30
const dp_devicedata = '0_userdata.0.omlet.devicedata'; //// datenpunkt mit typ string, hier wird nach jeder aktualisierung der aktuelle device status abgerufen und eingetragen

wenn im datenpunkt dp_doortimeopen und dp_doortimeclose etwas eingetragen wird, dann sollte die jeweilige zeit gesetzt werden.
im Anschluss wird die Konfiguration gleich abgerufen und im Datenpunkt dp_devicedata abgespeichert, sowie auch dp_doortimeopen und dp_doortimeclose wieder aktualisiert
der button doorstop führt die entsprechende aktion aus.

um mit dem angeschlossenen gerät nicht zu viel unruhe zu erzeugen, habe ich (hoffentlich) nur die lesenden aktionen ausgeführt. die schreibenden aktionen habe ich mal ausgelassen, was aber auch mangels test zu höheren fehlerrisiko neigt. aber mal schauen.
bitte möglichst genau darüber berichten

// -- configuration area
const token = 'apitoken';
const outdoorDeviceId = 'laTnMsWSJxBMGgJD';
const dp_light = '0_userdata.0.omlet.light'; // datenpunkt mit typ bool anlegen und namen hier eintragen
const dp_door = '0_userdata.0.omlet.door'; // datenpunkt mit typ bool anlegen und namen hier eintragen
const dp_doorstop = '0_userdata.0.omlet.doorstop'; // datenpunkt mit typ bool und rolle button anlegen und namen hier eintragen
const dp_doortimeopen = '0_userdata.0.omlet.doortimeopen'; // datenpunkt mit typ string, zeit im 24h format im format 06:00 oder 20:30
const dp_doortimeclose = '0_userdata.0.omlet.doortimeclose'; // datenpunkt mit typ string, zeit im 24h format im format 06:00 oder 20:30
const dp_devicedata = '0_userdata.0.omlet.devicedata'; //// datenpunkt mit typ string, hier wird nach jeder aktualisierung der aktuelle device status abgerufen und eingetragen


// --

const axios = require("axios/dist/browser/axios.cjs");
const BASE_URL = 'https://x107.omlet.co.uk/api/v1'; //kann hier geprüft werden https://smart.omlet.de/developers/api
let omlet = undefined;

async function connect() {
    console.log("start main2");
    omlet = await omletAPIClient(token);
    await getDevices(true);

    //console.log(JSON.stringify(await getDevices(), null, 2));
}
async function getDevices(info = false) {
    try {
        const devices = await getRequest('/device');
        if (devices && info) {
            devices.forEach(device => {
                console.log(`Device name: ${device.name}, deviceId: ${device.deviceId}`);
            });
        }
        return devices;
    } catch (error) {
        console.log(error);
        return [];
    }
}
async function getDevice(deviceId) {
    try {
        const device = await getRequest(`/device/${deviceId}`);
        return device;
    } catch (error) {
        console.log(error);
        return {};
    }
}
async function getConfiguration(deviceId) {
    try {
        const configuration = await getRequest(`/device/${deviceId}/configuration`);
        return configuration;
    } catch (error) {
        console.log(error);
        return {};
    }
}
async function setConfiguration(deviceId, configuration) {
    try {
        const result = await patchRequest(`/device/${deviceId}/configuration`, configuration);

        return result;
    } catch (error) {
        console.log(error);
        return {};
    }
}
async function getDeviceInfo(deviceId) {
    const device = await getDevice(deviceId);

    setState(dp_devicedata, JSON.stringify(device, null, 2), true);
    setState(dp_doortimeopen, device.configuration.door.openTime, true);
    setState(dp_doortimeclose, device.configuration.door.closeTime, true);
}
async function doAction(deviceId, actionName) {
    const devices = await getDevices();
    const device = devices.find(device => device.deviceId === deviceId);
    if (device) {
        const action = device.actions.find(action => action.actionName === actionName);
        if (action) {
            await postRequest(action.url);
            await getDeviceInfo(outdoorDeviceId);
        }
    }
}
async function lightOn(deviceId) {
    await doAction(deviceId, 'on');
}
async function lightOff(deviceId) {
    await doAction(deviceId, 'off');
}
async function doorOpen(deviceId) {
    await doAction(deviceId, 'open');
}
async function doorClose(deviceId) {
    await doAction(deviceId, 'close');
}
async function doorStop(deviceId) {
    await doAction(deviceId, 'stop');
}
async function setDoorTimeClose(deviceId, time) {
    const configuration = getConfiguration(deviceId);
    const newConfiguration = {
        ...configuration,
        door: {
            ...configuration.door,
            closeTime: time
        }
    };
    await setConfiguration(deviceId, newConfiguration);
    await getDeviceInfo(outdoorDeviceId);
}
async function setDoorTimeOpen(deviceId, time) {
    const configuration = getConfiguration(deviceId);
    const newConfiguration = {
        ...configuration,
        door: {
            ...configuration.door,
            openTime: time
        }
    };
    await setConfiguration(deviceId, newConfiguration);
    await getDeviceInfo(outdoorDeviceId);
}
function omletAPIClient(token) {
    return axios.create({
        baseURL: BASE_URL,
        headers: {
            'Authorization': `Bearer ${token}`,
            'Content-Type': 'application/json',
        },
    });
}
function isValidTime24h(value) {
    return /^(?:[01]\d|2[0-3]):[0-5]\d$/.test(value);
}
async function getRequest(url) {
    try {
        const data = await omlet.get(url);
        console.debug(`get request: ${url},status: ${data.status}`);
        return data.data;
    } catch (e) {
        console.log(e);
    }
}
async function postRequest(url) {
    try {
        const data = await omlet.post(url);
        console.debug(`post request: ${url},status: ${data.status}`);
        return data.data;
    } catch (e) {
        console.log(e);
    }
}
async function patchRequest(url, data) {
    try {
        const result = await omlet.patch(url, data);
        console.debug(`patch request: ${url},status: ${result.status}`);
        return result.data;
    } catch (e) {
        console.log(e);
    }
}
function watchTimeState(id, label) {
    on({ id: id, change: 'ne', ack: false }, async (obj) => {
        const newVal = String(obj.state.val || '').trim();
        const oldVal = obj.oldState && obj.oldState.val != null
            ? String(obj.oldState.val)
            : '';
        if (isValidTime24h(newVal)) {
            log(`${label}: gültige Zeit gesetzt -> ${newVal}`, 'debug');
            if (id === dp_doortimeopen) {
                await setDoorTimeOpen(outdoorDeviceId, newVal);
            }
            if (id === dp_doortimeclose) {
                await setDoorTimeClose(outdoorDeviceId, newVal);
            }
            return;
        }
        log(`${label}: ungültige Zeit "${newVal}" - setze auf "${oldVal}" zurück`, 'warn');

        // ungültige Eingabe zurücksetzen
        setState(id, oldVal, true);
    });
}
async function main() {
    await connect();
    await getDeviceInfo(outdoorDeviceId);
    on({ id: dp_door, change: 'ne', ack: false }, async (evt) => {
        //log(evt);
        if (evt.state.val) {
            await doorOpen(outdoorDeviceId);
        } else {
            await doorClose(outdoorDeviceId);
        }
    });
    on({ id: dp_light, change: 'ne', ack: false }, async (evt) => {
        //log(evt);
        if (evt.state.val) {
            await lightOn(outdoorDeviceId);
        } else {
            await lightOff(outdoorDeviceId);
        }
    });
    on({ id: dp_doorstop, change: 'any', ack: false }, async (/* evt */) => {
        //log(evt);
        doorStop(outdoorDeviceId);
        setState(dp_doorstop, false, true);
    });
    watchTimeState(dp_doortimeopen, 'Öffnungszeit');
    watchTimeState(dp_doortimeclose, 'Schließzeit');
    // await lightOn(outdoorDeviceId);
    // await lightOff(outdoorDeviceId);

}
main();

für astro hat der iobroker ja bereits ereignisse eingebaut,
wenn die dann aufgerufen werden musst du dann einfach nur die Funktionen doorOpen und doorClose mit der deviceId (die in der Variable outdoorDeviceId steht) aufrufen

Sind die Funktionen soweit verständlich? Brauchst du mehr Detaildokumentation für spätere Anpassungen?

Community Forum

NEWS

Omlet Hühnerstall webhook API

Support us

442

32.7k

82.5k

1.3m