Profiel Editor
Met de Profiel Editor maakt u eigen apparaatprofielen voor add-ons of past u bestaande profielen aan. Een profiel legt vast hoe de nomos system Controller met een apparaat communiceert en wat daarvan in de app, in automatiseringen en in Quick Config verschijnt. Hoe een profiel is opgebouwd, staat onder Profielformaat. De verbinding via TCP, UDP en HTTP staat onder CommandServer, kant-en-klare voorbeelden onder Voorbeeldprofielen.
INFO
De Profiel Editor is beschikbaar als uw licentie hem vrijgeeft. Zonder vrijgave ontbreken in de profiellijst het potlood en de knop Nieuw profiel. Op een smartphone is de editor verborgen.
Een profiel openen of aanmaken
Alle wegen beginnen onder Skills → Add-ons op het tabblad Profielen:
- Nieuw profiel (plusteken, sneltoets N): u vult een Naam in en kiest Protocol, Categorie en Type. Het protocol (CommandServer, KNX, Modbus, MQTT, Z-Wave, ZigBee) bepaalt de basisopbouw. Het type kiest een startpunt met passende acties, terugmeldingen en sjablonen, bijvoorbeeld voor een lamp, een dimmer of een omvormer. Met Creëren opent de editor.
- Online bibliotheek: laadt een kant-en-klaar profiel in de lijst. Om het te bewerken, opent u het daarna met het potlood.
- Handmatig uploaden: laadt een profielbestand (
.json, maximaal 1 MB) in de lijst. Oudere definitiebestanden in het formaat.csvworden daarbij omgezet in een JSON-profiel. - Potlood in een rij van de profiellijst: opent het profiel in de editor.
Bestaat er al een profiel met dezelfde naam, dan vervangt de import het, en de apparaten die het gebruiken, nemen de nieuwe versie over (zie Updates uit de online bibliotheek). Een punt in de bestandsnaam wordt daarbij _.
Het snelst komt u vooruit als u begint met een profiel dat op uw apparaat lijkt, bijvoorbeeld van dezelfde fabrikant of met hetzelfde protocol. Sla het met Opslaan als op als nieuw profiel.
Opbouw van de editor
Bovenaan staat de balk met de knoppen Opslaan als, Annuleren en Opslaan. Links in die balk kiest u welk deel van het profiel u bewerkt: het hoofdprofiel of een van de Subprofielen (zie hieronder). Daaronder toont de editor de resultaten van de controle, dan de gebieden Info en Instellingen en daaronder de tabbladen.
Controle
De editor controleert het profiel bij elke wijziging. De kopregel telt fouten (rood), waarschuwingen (geel) en hints (blauw). Zonder bevindingen staat daar Geen problemen. Elke rij noemt de controleregel, de plek in het profiel en een melding (in het Engels), bijvoorbeeld consistency.polling bij polling.Status.
De controle houdt het opslaan niet tegen. Los fouten toch op voordat u het profiel gebruikt. Ze wijzen bijna altijd op een plek waar het apparaat later niet reageert of waar waarden ontbreken.
Info
| Veld | Betekenis |
|---|---|
| Beschrijving | Naam van het profiel in de profiellijst en voorstel voor de apparaatnaam |
| Fabrikant, Model | Gegevens over het apparaat |
| Platform | Herkomst van het apparaat, bijv. de naam van de fabrikant. Bij KNX en Z-Wave verborgen en vast ingesteld |
| Versie | Wordt bij elke keer opslaan automatisch verhoogd (1.0 → 1.1), zolang u hem niet zelf wijzigt. De versie bepaalt of bestaande apparaten een wijziging overnemen (zie Profiel wijzigen) |
| Auteur | Wie het profiel heeft gemaakt |
| Support URL | Adres van een hulppagina over het apparaat. Het verschijnt als infoknop in de profiellijst en op de apparaatpagina |
Instellingen
| Veld | Betekenis |
|---|---|
| Categorie, Type | Bepalen pictogram en weergave in de app, en of het apparaat via de Matter-bridge verschijnt. Kies het type dat bij de belangrijkste waarde past: een apparaat dat vooral beweging meldt, is een bewegingsmelder, ook als het daarnaast de temperatuur levert |
| Motortype | Hoe de controller het apparaat aanspreekt: CommandServer (eigen verbinding via TCP, UDP, HTTP of serieel), MQTT, KNX, ZWAVE of BUS. Het motortype bepaalt welke tabbladen er zijn |
| Klassennaam | Alleen bij CommandServer: interne naam van de verbinding, alleen hoofdletters, cijfers, _ en -. Blijft het veld leeg, dan vormt de editor de naam uit fabrikant en model |
| Compatibiliteit | Hoe volledig het profiel het apparaat dekt, in procenten |
| Gecertificeerd door nomos system | Vergrendeld; alleen profielen die nomos system heeft gecontroleerd, hebben hier Ja |
| Tags | Extra kenmerken, gescheiden door komma of puntkomma |
| Apparaat weergeven in apps | Zonder vinkje verschijnt het apparaat niet in de app |
| Apparaat gebruiken met spraakassistenten | Zonder vinkje wordt het apparaat niet doorgegeven aan spraakassistenten en de Matter-bridge |
De tabbladen
| Tabblad | Inhoud | Motortype |
|---|---|---|
| Communicatie | Verbindingsinstellingen: adres, poort, protocol, tijdslimieten, bereikbaarheid | alleen CommandServer |
| Acties | Wat naar het apparaat kan worden verzonden | alle |
| Feedback | Welke waarden het apparaat meldt | alle |
| Pollings | Opdrachten die regelmatig worden verzonden om waarden op te halen | alleen CommandServer |
| Camera's | Camerabeelden die het apparaat levert | alle |
| Webhooks | Waarden die het apparaat zelf via HTTP naar de controller mag sturen | alle |
In elke tabel voegt u met Toevoegen een rij toe. Met het rode ✕ verwijdert u een rij, door te slepen wijzigt u de volgorde. Dubbele namen worden rood gemarkeerd.
Communicatie
De tabel heeft de kolommen Naam, Waarde, Bewerkbaar en Opmerking. De naam kiest u uit de bekende instellingen, of u vult onder Door gebruiker gedefinieerd... een eigen naam in. Wat de instellingen doen, staat onder CommandServer: Verbinding.
- Bewerkbaar: de waarde wordt bij Apparaat aanmaken gevraagd en is vooraf ingevuld met de ingevoerde waarde. Typisch voor het IP-adres van het apparaat, een poort of toegangsgegevens.
- Opmerking: de instelling blijft in het profiel, maar heeft geen effect. Dat is handig om waarden te bewaren die u alleen als plaatsaanduiding in opdrachten gebruikt (zie Plaatsaanduidingen).
Acties en Feedback
Beide tabbladen zijn gelijk opgebouwd. Via de balk met de sprongmarkeringen Communicatie, Definition en Templates wisselt u tussen de onderdelen.
Communicatie (alleen CommandServer)
- Bij Acties staan hier de opdrachten met Naam, Volgorde, Parameter, Timeout, Afstand en Tag. Bij HTTP komen daar Methode bij en voor POST, PUT, PATCH en DELETE ook Contenttype en Body.
\#in de Volgorde is de plek voor de waarde die de actie meestuurt. - Bij Feedback staan hier de patronen voor antwoorden van het apparaat met Naam, Match, Action, Conditie, op verandering en Tag.
De betekenis van elke kolom staat onder CommandServer.
Definition
Hier legt u vast wat de app en automatiseringen zien. Elke rij heeft Naam, Commando (bij acties) of Feedback, Datatype en Unit.
- Naam: kies bij voorkeur een van de voorgestelde standaardnamen, zoals
state,level,position,setpointoftemperature. Alleen deze namen kent de app voor haar bedieningselementen; zie Standaardnamen. - Commando of Feedback: bij CommandServer kiest u een opdracht of een patroon uit het onderdeel Communicatie. Een commando dat met
SETofGETbegint, wordt als eigenschap gelezen:SETCURRschrijft de eigenschapCURR. Bij KNX is het veld vast ingesteld. De groepsadressen wijst u pas toe bij het aanmaken van het apparaat. - Datatype:
null(knop zonder waarde),string,bool,trigger,intoffloat. - Unit: voor getallen. Onder Categorieën staan eenheden die de app voor de gebruiker omrekent (bijv.
temperature), onder Eenheden vaste eenheden zoalsWofkWh.
Het potlood aan het einde van de rij opent het dialoogvenster Details:
| Veld | Betekenis |
|---|---|
| Beschrijving | Label in de app en in automatiseringen |
| Groep | Gedeelte waaronder de app de waarde toont, bijvoorbeeld "Laden" bij een wallbox. Alleen zinvol voor apparaten met veel waarden |
| Verborgen | De waarde verschijnt niet als eigen rij in de app, maar blijft beschikbaar voor automatiseringen |
| Feedback simuleren | Alleen acties: de controller meldt de verzonden waarde direct als terugmelding. Voor apparaten zonder eigen terugmelding |
| Max. Lengte | Alleen tekst |
| Apparaat min/max, Gemapt min/max | Schaling tussen het waardebereik van het apparaat en dat in nomos, zie Schaling |
| Apparaateenheid, Kelvin warm/koud | Alleen voor color-temperature: of het apparaat mired, kelvin of procenten gebruikt |
| Stap Waarde | Stapgrootte van schuifregelaars |
| MQTT, MQTT-waarde, MQTT-eenheid, MQTT Payload | Alleen MQTT, zie MQTT |
| Grootte in Bit | Bij KNX de grootte van het datapunt (1, 8, 16, 32 bit) |
| KNX DPT Filter | Bij KNX: welke datapunttypen worden aangeboden bij het toewijzen van het groepsadres |
| Waardenlijst | Keuzewaarden met tekst, bijv. 0 = Uit, 1 = Stand 1 |
| Standaardwaarde | Bij acties de vast verzonden waarde (bijvoorbeeld 1 voor switchon), bij terugmeldingen de beginwaarde |
| Prefix, Suffix, Klasse-override | Alleen acties: tekst voor of na de waarde, opdracht naar een andere verbinding sturen |
| Verwerkingsfunctie | Alleen terugmeldingen: nabewerking van de waarde, bijvoorbeeld de omrekening naar een prijs, zie Verwerking |
| Matching Opties, Vluchtige, mRemote Join | Voor speciale gevallen; laat ze in eigen profielen leeg |
Templates
Sjablonen zijn de items die automatiseringen en de Quick Config aanbieden, bijvoorbeeld "Inschakelen" of "Helderheid". Kolommen: ID, Naam (de actie of terugmelding waarop het sjabloon betrekking heeft), Icoon, Beschrijving, Waarde en bij acties Plaatsaanduiding, daarnaast Snelle configuratie.
- Waarde: een vaste waarde. De automatisering toont dan geen invoerveld, bijv. "Is ingeschakeld" met de waarde
1. - Plaatsaanduiding: bij acties met een tekstwaarde een voorbeeld, bijvoorbeeld
Welkomofhttp://…. Het verschijnt grijs in het nog lege invoerveld van de actie in automatiseringen. Heeft het sjabloon een vaste Waarde, dan is de kolom vergrendeld. - Snelle configuratie: een vinkje verbergt het sjabloon in de Quick Config van het apparaat. In automatiseringen blijft het beschikbaar.
WARNING
Zodra er één sjabloon is, bieden automatiseringen alleen nog de sjablonen aan, niet meer alle acties of terugmeldingen. Maak daarom voor elke waarde die in automatiseringen nodig is een sjabloon aan, of helemaal geen sjablonen.
Pollings
Per rij een Naam, een Commando en het Polling-interval (in seconden). Met Bewerkbaar wordt het interval bij het aanmaken van het apparaat gevraagd. Een HTTP-profiel zonder eigen polling krijgt bij het opslaan de polling "Reachable Check". Die vraagt elke 30 seconden / op, zodat de bereikbaarheid klopt.
Camera's
Per rij een URL en een URL Type: RTSP, Snapshot, MJPEG of Andere HTTP. In de URL mogen plaatsaanduidingen uit de communicatie staan, bijv. http://%SERVERIP%/snapshot.jpg. Bij het aanmaken van het apparaat ontstaat per rij een camera.
Webhooks
Hier kiest u terugmeldingen waarvan het apparaat de waarden zelf naar de controller mag sturen, in plaats van dat de controller ze opvraagt. Het adres en hoe het apparaat het aanroept, staat onder Webhooks.
Subprofielen
Een apparaat met meerdere onafhankelijke delen, bijvoorbeeld een actor met vier kanalen, krijgt per deel een subprofiel. Bij het aanmaken van het apparaat ontstaat dan per subprofiel een eigen apparaat met de naam "Apparaatnaam Subprofielnaam". Ze gebruiken allemaal dezelfde verbinding.
- Aanmaken: kies in de keuzelijst links in de balk Toevoegen... en vul een ID (kleine letters, zonder punt en spaties) en optioneel een Naam in.
- Verwijderen: Subprofielen verwijderen in de info van het subprofiel. Het wordt pas bij het opslaan verwijderd.
- Een subprofiel heeft alleen de tabbladen Acties en Feedback. Verbinding, pollings en camera's horen bij het hoofdprofiel.
Opslaan
- Opslaan schrijft het profiel terug onder dezelfde naam. Dat kan ook als apparaten het profiel gebruiken; zij nemen de wijziging direct over (zie Profiel wijzigen). Het profiel geldt daarna als gewijzigd in de Profiel Editor.
- Opslaan als maakt een nieuw profiel aan; het bestaande profiel blijft ongewijzigd. Is de naam al in gebruik, dan wordt
_2,_3enz. toegevoegd. - Annuleren verwerpt alle wijzigingen zonder te vragen. De Esc-toets vraagt eerst om bevestiging. Ctrl+S of ⌘S slaat op.
Bij het opslaan vult de editor zelf een paar dingen aan:
- De Versie stijgt met één als u hem niet zelf hebt gewijzigd.
- Een lege Klassennaam wordt gevormd uit fabrikant en model.
- Een patroon in de terugmelding dat geen waarde vangt, krijgt
=1achter de naam (zie Naam en waarde). - Bij KNX en Z-Wave worden platform en klassennaam vast ingesteld en wordt de terugmelding
reachableverwijderd. - Een HTTP-profiel zonder polling krijgt de polling "Reachable Check".
- Wijzigt u het motortype van CommandServer naar een ander type, dan vervallen bij het opslaan alle instellingen, opdrachten en patronen van de communicatie.
Profiel wijzigen
Een gewijzigd profiel geldt direct voor nieuwe apparaten. Voor apparaten die het profiel al gebruiken, geldt:
- Labels, groepen, sjablonen en de opmaak van de waarden tonen de app en de configuratie direct opnieuw.
- Opdrachten, patronen, schaling, pollings en webhooks nemen bestaande apparaten direct na het opslaan over, als de versie van het profiel hoger is dan die waarmee het apparaat is aangemaakt. De editor verhoogt de versie bij het opslaan zelf. Wie de versie met de hand heeft ingesteld, moet hem zelf verhogen. De controller bouwt de apparaten daarvoor opnieuw op: ruimtes, opgeslagen waarden, gegevensregistratie en automatiseringen blijven behouden, de apparaten zijn daarbij kort niet bedienbaar.
- Camera's en nieuw toegevoegde of verwijderde subprofielen nemen bestaande apparaten niet over. Maak het apparaat daarvoor opnieuw aan.
WARNING
Hernoem nooit de ID van een subprofiel en verwijder geen subprofiel dat apparaten gebruiken: die apparaten tonen daarna de waarden van het hoofdprofiel.
Updates uit de online bibliotheek
Verschijnt een profiel dat u uit de online bibliotheek hebt geladen daar in een nieuwere versie, dan toont de profiellijst onder de versie Update naar … en in de rij een knop Bijwerken naar versie …. Een klik vervangt het profiel door de nieuwe versie; de apparaten die het gebruiken, worden direct daarna bijgewerkt. In de Online bibliotheek zelf zijn geïnstalleerde profielen gemarkeerd met Geïnstalleerd of Update naar …; een nieuwe import daar vervangt het profiel eveneens.
Hebt u het profiel in de Profiel Editor gewijzigd, dan vraagt de controller eerst om bevestiging, want de nieuwe versie bevat uw wijzigingen niet:
- Vervangen past de nieuwe versie toe, ook op de apparaten. Uw wijzigingen gaan verloren.
- Als kopie laat uw profiel en de apparaten ervan ongewijzigd en slaat de nieuwe versie daarnaast op als apart profiel.
- Annuleren wijzigt niets.
Dezelfde vraag stelt Handmatig uploaden als het een in de Profiel Editor gewijzigd profiel zou vervangen.
Laat de nieuwe versie acties, terugmeldingen of sjablonen weg die het profiel tot nu toe had, dan noemt de controller ze eerst. Automatiseringen, scènes en tegels die ze gebruiken, werken na de update niet meer. Toch bijwerken vervangt het profiel, Annuleren laat alles zoals het is. Pas daarna de betrokken automatiseringen aan.
Met vragen over profielen kunt u terecht bij support@nomos-system.com.