Propojení se senzory

Co lze připojit?

K Vitipadu lze připojit libovolné zařízení, které disponuje možností exportu dat do systémů třetích stran. Typicky se jedná o meteostanice, systémy řízeného kvašení, monitory energií či GPS souřadnice vašeho traktoru.

Jak zařízení propojit?

Celou integraci si můžete zařídit ve vlastní režii. V nabídce nastavení se nachází položka “Senzory” ve které si nový senzor vytvoříte a samotnou integraci provedete za pomoci jednoduchého sensorAPI. Dokumentaci naleznete zde.

Před začátkem implementace doporučujeme nás kontaktovat. Podporu pro nejčastější zařízení v podobě různých meteostanic máme hotovou a bude stačit ji zapnout pro váš účet. Rádi se pobavíme o složitejších implementacích a navrhneme optimální řešení.

Dokumentace pro vývojáře

Co je sensorAPI a k čemu se používá?

SensorAPI je jednoduché API určené k importu dat zařízení třetích stran do systému Vitipad. Typickým příkladem takových zařízení jsou senzory ve formě meteostanic, měřičů energie, systémy řízeného kvašení apod.

API lze používat k importu i exportu dat.

Technické řešení

Celé API je záměrně navrženo jako minimalistické tak aby umožnilo jednoduchou integraci různých IOT zařízení. Jedná se o klasické REST API, všechny data jsou přenášena ve formátu JSON. Přenos dat je možný pouze za pomocí protokolu https.

Pokud máte zájem používat MQTT verzi tohoto API, tak nás kontaktujte na emailu: dfilip@vialtek.com

Testovací účet a vývojářská podpora

Veškerou podporu poskytujeme po emailu. Pokud máte zájem o testovací účet tak nás kontaktujte, rádi vám ho vytvoříme.

Autentizace senzoru

Každý dotaz musí obsahovat parameter api_key=[API_KEY]. Tento kód je unikátní pro každý senzor a naleznete ho v detailu senzoru v Nastavení aplikace.

Detail sensoru

GET https://app.vitipad.cz/sensorapi/v1/sensor?api_key=[API_KEY]

Tato URL zobrazí základní informace o senzoru.

Z atributů je nejzajímavější pole “feeds”, které dává informaci o kanálech dostupných tomuto senzoru. Každý kanál představuje jednu měřenou veličinu. Atribut “key” každého kanálu slouží jako identifikátor.

Zobrazení dat

GET https://app.vitipad.cz/sensorapi/v1/sensor/[KEY]?api_key=[API_KEY]

Zobrazí naměřená data kanálu určeného identifikátorem [KEY]. Data jsou vrácena ve formě pole JSON objektů ve formátu [Unix timestamp]: [naměřená hodnota].

Defaultně jsou zobrazena všechna data za posledních 7 dnů. Rozsah lze měnit parametry time_from a time_till. Pokud time_till není použit budou zobrazeny všechny data do dnešního dne.

Odeslání dat

POST https://app.vitipad.cz/sensorapi/v1/sensor/[KEY]?api_key=[API_KEY]

Data jsou kódována dvojicí parametrů timestamp a value. Timestamp musí být ve formátu Unix time a value je libovolná naměřená hodnota.