Základní pojmy

Klíčové pojmy ekosystému Spectoda. Tento přehled vám usnadní orientaci v dokumentaci.

Obecné

Spectoda Connect

Spectoda Connect je uživatelské rozhraní pro ovládání světelných instalací Spectoda. Je k dispozici jako progresivní webová aplikace (PWA) v prohlížeči a také jako mobilní aplikace pro telefony a tablety.

Umožňuje ovládat jas, barvu nebo jiné parametry podle definice Zařízení (Device) nastavení Sítě (Network). Spectoda Connect je kompatibilní s operačními systémy iOS i Android.

V mobilních obchodech je Spectoda Connect dostupná pod názvem Spectoda Connect.

Spectoda Connect

Spectoda Connect je komunikační vrstva mezi uživatelským rozhraním a sítí zařízení Spectoda. Na telefonu nebo tabletu zajišťuje propojení aplikace s instalací, typicky přes Bluetooth Low Energy, a zprostředkovává přenos příkazů do sítě Spectoda.

V praxi se název Spectoda Connect používá hlavně pro mobilní aplikaci dostupnou na Google Play a Apple App Store. Pokud tedy v telefonu používáte aplikaci Spectoda Connect, používáte mobilní podobu Spectoda Connect.

Spectoda Studio

Softwarové rozhraní pro komplexní správu a nastavení zařízení Spectoda. Spectoda Studio používají především tvůrci, kteří určují chování světel a zprostředkovávají jejich nastavení koncovým uživatelům (např. majitelům produktů třetích stran). Spectoda Studio umožňuje kompletní správu od připojení jednotlivých světel až po vzdálenou síťovou službu.

Další informace naleznete zde.

Ekosystém (Spectoda Ecosystem)

Síť vzájemně propojených produktů a technologií, které spolu vzájemně komunikují a podporují se, aby uživatelům poskytly kompletní a integrované řešení pro různé potřeby řízení osvětlení.

Spectoda Komunita (Spectoda Community)

Komunita Spectoda, která běží na platformě Discord, slouží jako platforma pro komunikaci a sdílení informací mezi uživateli (především tvůrci), kde mohou diskutovat o produktu, získávat podporu a vzájemně se inspirovat.

Ke komunitě se můžete připojit zde.

Kontroler (Spectoda Controller, SC)

Řídicí jednotka s mikrokontrolerem ESP32 s Spectoda firmwarem. Jedná se o elektronickou destičku připojenou mezi napájecí zdroj a zdroj světla. Skupina bezdrátově propojených řídicích jednotek tvoří inteligentní „mesh“ sÍt, která nahrazuje standardní centrální jednotku používanou konkurenčními systémy.

V ekosystému Spectoda najdete různé varianty kontrolérů Spectoda podle účelu použití. Více informací.

Produkt (Spectoda Product)

Prodejná nebo nasaditelná jednotka v ekosystému Spectoda. Nejčastěji jde o kontroler, integrované svítidlo, eventovou rekvizitu, gateway nebo produkt třetí strany rozšířený o Spectoda vrstvu.

Produkt sám o sobě neřeší prodejní cenu ani fyzický sklad. Tyto vrstvy řeší samostatné pojmy jako Pricebook, Warehouse a Recept.

Produktová rodina

Obecný umbrella název pro skupinu příbuzných produktů, například SC Industry, SC Linear, SC Pixel Mini nebo SC Dongle.

Produktová rodina se hodí hlavně pro orientaci v portfoliu, marketingové srovnání a obecné popisy. Není to ještě nejpřesnější název konkrétní prodejní varianty.

Varianta produktu

Konkrétní prodejná větev produktu, kterou používáme v hlavní dokumentaci a návazných systémech. Typicky jde o názvy jako SC Industry A, SC Linear B, SC Button A nebo SC Dongle A.

Varianta produktu má vlastní technické parametry, dokumentaci a návazné vazby do ceníku, skladu a dalších interních vrstev.

IO

Koncept vstupů a výstupů kontroleru (input & output). Nahrazuje starší koncept portů a senzorů.
Např. NEOPIXEL, GPO, GPIO, GPI, PWM, DALI, SACN…

Role

Uživatel

Koncový zákazník. Zpravidla nevytváří nová síťová nastavení a ovládá světelné zařízení prostřednictvím předdefinovaných nastavení (bloků). Nepřichází do styku se Spectoda Studio. Používá aplikaci Spectoda nebo jiné rozhraní dostupné v aplikaci Spectoda Connect.

Tvůrce

Uživatel, který používá aplikaci Spectoda Studio k nastavení sítě Spectoda. Definuje chování, animace, zapojení senzorů atd. Vytváří rozhraní pro koncové zákazníky (uživatele). Nemění software jako takový, ale mění chování zařízení. Pomocí výukového programu může používat vývojářské nástroje, které obvykle používají Vývojáři.

Vývojář

Tvůrce aplikace Spectoda Studio nebo jiné části ekosystému Spectoda. Vytváří nové bloky, mění a vylepšuje systém. Je k dispozici tvůrcům v rámci komunity Spectoda jako podpora. Obvykle je členem týmu Spectoda.

Spectoda Studio

Blockly

Grafický programovací jazyk od společnosti Google, který umožňuje lidem vytvářet programy pomocí barevných bloků, které představují koncepty kódu, takže i úplní nováčci mohou snadno programovat bez předchozích znalostí. Jedná se o základní technologii, na které je postavena logika skládání bloků ve Spectoda Studiu.

Elementy

Abstraktní pojem, který zahrnuje skupiny a podskupiny produktů v instalaci.

Také se jedná o předdefinované bloky v uživatelském rozhraní, které definují, jaký typ produktů a jak je možné je ovládat.

Instalace / Network

V běžné řeči se tyto pojmy často používají skoro jako synonyma, ale interně je rozlišujeme:

Network je jedna konkrétní síť zařízení Spectoda, která se chová jako jeden řízený celek.
Installation je širší fyzické nasazení u zákazníka. Může zahrnovat jednu nebo více sítí, servisní historii, přílohy a další projektový kontext.

Ve Spectoda Studiu se nejčastěji pracuje s konfigurací konkrétního networku, ale v terénu se celému nasazení často říká instalace.

Síť nebo instalace typicky nese informace o:

verzi FW
uživatelská práva
URL na uživatelské rozhraní
nastavení elementů

Network Snapshot

Zápis konfigurace a logiky jedné konkrétní sítě Spectoda. Obsahuje například informace o elementech v uživatelském rozhraní, párování produktů, rozložení kontrolerů a dalších datech potřebných pro zálohu, servis nebo znovunasazení sítě.

Nejde o totéž co fyzická instalace. Network Snapshot je snapshot nebo recept jednoho networku.

Projekt

Projekt v aplikaci Spectoda Studio, který obsahuje všechna nastavení související s instalací. Tj. přístupová práva, nastavení chování světel, záložní informace pro servis, aktualizaci nebo výměnu ovladačů a připojení k uživatelské aplikaci. Projekty jsou uloženy v cloudu a v současné době nejsou dostupné offline.

Playground

Projekt bez názvu pro experimentování s aplikací Spectoda Studio. Playground je k dispozici offline a lokálně si pamatuje poslední provedené změny. Playground lze také přeměnit na projekt.

TGBL

Jedná se o projekt Spectoda (včetně souborů mp3 a zápisu bloků) zapsaný v jednom souboru, který lze exportovat a sdílet.

Toolbox

Nabídka nástrojů (bloků) v aplikaci Spectoda Studio.

Zařízení - bloky, které představují zařízení Spectoda (nejen Spectoda kontrolér). V nástroji Tvůrce lze nastavit odkaz na zařízení Spectoda pro další použití v projektu, jas, počet pixelů pro každý port a pojmenování segmentu, který je s portem spojen.
Animace - bloky, které určují vizuální chování (barevné přechody, stmívání atd.) jednotlivých Zařízení nebo konkrétních segmentů.
Vykreslování - bloky, které určují a definují vrstvy bloků Animace a jejich pořadí a prioritu na časové ose. Kromě definice vrstev slouží bloky Vykreslování také k úpravě vrstvy (zpomalení času, vytvoření vizuálních přechodů atd.).
Událost - nositel informace o změně stavu (jas, rychlost, barva, chování atd.). Spouští se vyhrazeným tlačítkem (virtuálním uvnitř aplikace Spectoda nebo klientské aplikace, případně fyzickým senzorem, např. šavlí u konzole DMX).
Proměnné - bloky, které se používají ke zpracování událostí. Ukládá hodnotu poslední odeslané události, která se použije v rámci dalších instrukcí (animací atd.) na časové ose. Zjednodušuje práci s parametry.
Segment - bloky, které definují samostatně ovladatelné segmenty v rámci zařízení Spectoda (nebo v rámci instalace) nezávisle na fyzickém zapojení. Další bloky v nabídce Segment pomáhají s vykreslováním animací a dalších chování v rámci již definovaných segmentů.
Canvas - Abstrakce, která definuje seskupení více segmentů, které jsou fyzicky umístěny vedle sebe. Používá se například k vytváření animací, které se na segmentech zobrazují s určitým zpožděním. Nástavba nad segmenty.
Nástroje - bloky obsahující komentáře a blok pro definování vlastního kódu TNGL nad rámec bloků ve Spectoda Studiu.

TNGL

Animační jazyk, který je generován aplikací Spectoda Studio a slouží jako instrukce pro kontrolery Spectoda. Ve Spectoda Studiu je přístupný pod tlačítkem “Debug”.

Live controls

Sada nástrojů, které lze použít k úpravě chování sítě v reálném čase. Rozhraní, ve kterém lze definovat prvky pro odesílání událostí.

Komunikace

Síť (Network)

Síť kontrolérů Spectoda propojených (kabelově nebo bezdrátově) v topologii mesh. Práva k ovládání nebo konfiguraci sítě Spectoda má Vlastník.

Aktualizace OTA

= over-the-air, tedy bezdrátová aktualizace firmwaru z řídicí aplikace (Spectoda Studio, Spectoda Connect) do Spectoda kontroléru.

V některých případech není OTA jen výměna samotného firmwaru, ale i přechod mezi různými systémovými revizemi kontroléru. To je důležité hlavně tehdy, když se mění nízkoúrovňové vlastnosti zařízení, například velikost OTA slotu nebo rozložení paměti.

Systémová revize (System Revision)

Systémová revize označuje nízkoúrovňový profil kontroléru, na kterém firmware běží. Typicky se zapisuje jako rev0, rev1, případně další budoucí revize.

Na rozdíl od verze firmwaru neříká, jakou aplikační logiku kontrolér používá, ale na jakém systémovém základu běží. Může tedy určovat například:

rozložení partition table
velikost OTA slotů
bootloader nebo způsob bootování
velikost flash paměti
přítomnost externí RAM

Praktický důsledek je, že dva kontroléry mohou mít stejnou verzi firmwaru, ale odlišnou systémovou revizi. To je důležité pro servis, diagnostiku a plánování OTA aktualizací.

BLE

(Bluetooth Low Energy) je bezdrátová komunikační technologie, která umožňuje zařízením komunikovat s jinými zařízeními pomocí připojení Bluetooth a je navržena tak, aby spotřebovávala co nejméně energie, takže je vhodná pro použití v zařízeních s nízkou spotřebou energie nebo pro dlouhodobá připojení. V ekosystému Spectoda používáme tuto technologii k propojení aplikace Spectoda Connect s kontrolery Spectoda.

ESP-NOW

Technologie bezdrátové komunikace, která umožňuje zařízením s čipy ESP komunikovat mezi sebou přímo bez nutnosti připojení k Wi-Fi nebo jiným bezdrátovým sítím pomocí krátkých datových paketů. V ekosystému Spectoda používáme tento protokol k bezdrátovému propojení kontrolerů Spectoda (společně tvoří síť Spectoda).

CAN-BUS

(Controller Area Network) je sběrnice, která se používá k propojení různých elektronických komponent ve vozidlech a strojích a umožňuje jim vzájemně komunikovat a sdílet data, což je užitečné pro kontrolu a řízení různých systémů v zařízení. V ekosystému Spectoda používáme tento protokol k propojení řídicích jednotek Spectoda.

Vlastník (Owner)

Definuje komunikační práva k řídicím jednotkám Spectoda. Řídicí jednotky Spectoda se stejným vlastníkem (Vlastník) jsou automaticky připojeny ke stejné síti mesh. K síti se může připojit pouze aplikace, která má práva vlastníka s danými právy. Spectoda kontroler může mít přiřazeného pouze jednoho vlastníka. Není možné mít kontroler, ke kterému mají přístup dva vlastníci (ve verzi 0.8 je vlastník spojen s uživatelem, ve verzi 0.9 bude vlastník spojen s projektem a pravděpodobně bude tato definice předefinována).

Podpis vlastníka (Owner Signature)

Hashovaný kód identifikující vlastníka práv, který je veřejně zjistitelný. Lze jej použít k určení, zda ovladače Spectoda mají vlastníka, nebo ne. Používá se ke skrytí identity vlastníka.

Klíč vlastníka (Owner Key)

Soukromý klíč slouží k ověření přístupu. Klíč je na straně aplikace a FW utajen. Pokud aplikace klíč nezná, Spectoda kontroler se aktivně odpojí z důvodu nedostatku oprávnění.

Brána (Gateway)

Specializované hardware zařízení nebo role zařízení, která propojuje síť Spectoda s cloudem, vzdáleným servisem a externími integracemi.

Gateway není nutná pro základní lokální fungování instalace, ale rozšiřuje ji o vzdálený přístup, sběr dat a další síťové služby.

Bridge

Softwarová nebo runtime vrstva běžící uvnitř zařízení Gateway. Zajišťuje komunikaci směrem k serveru, cloudu nebo dalším integracím.

Praktické pravidlo: Gateway = hardware, Bridge = software uvnitř Gateway.

Mapování (Commissioning)

Proces přidání Spectoda kontroleru jako řídicí jednotky do určité sítě Spectoda (známý také jako proces uvedení do provozu).

Recept (Recipe)

Definice toho, z čeho se konkrétní produkt skládá. Propojuje variantu produktu s fyzickými díly ze skladu a s interní prací, která patří do výrobního nákladu produktu.

BOM (Bill of Materials) / Kusovník

Kusovník pro konkrétní projekt, dodávku nebo realizaci. Na rozdíl od receptu nejde o obecnou definici produktu, ale o seznam materiálu a fyzických položek potřebných pro konkrétní výrobu, montáž nebo servisní zásah.

Shipping BOM

Plánovaný kusovník odvozený z nabídky nebo připravované dodávky. Slouží k tomu, aby bylo jasné, co se má skutečně připravit, vyskladnit nebo expedovat.

Deal / Nabídka

Konkrétní obchodní případ pro zákazníka. Sdružuje vybrané produkty, služby, slevy a další obchodní podmínky a vede k finální cenové nabídce.

Realizace

Konkrétní dodávka nebo prováděcí etapa v rámci jedné instalace. Jedna instalace může obsahovat více realizací, například po etapách, rozšířeních nebo servisních zásazích.

Vývojářské nástroje

spectoda-js

JavaScriptová knihovna pro Spectoda SDK, které slouží k propojení Spectoda Connect a klientských aplikací s firmwarem uvnitř Spectoda kontrolerů prostřednictvím konektorů.

Konektor (Connector)

Fyzická vrstva spojující aplikaci s kontrolerem Spectoda a kontrolery mezi sebou (např. konektor BLE, konektor USB).

Spectoda SDK (software development kit)

Základní knihovna, která slouží jako jádro pro tvorbu Spectoda aplikací.