Θες το Arvio στον χώρο σου; Πες μας τι έχεις και τι θέλεις. Μίλα μαζί μας ›

Γλώσσα: Ελ
Σύνδεση partner
Arvio
Επικοινωνία

Για ποιον

Για developers

Η μορφή και το πρωτόκολλο των drivers του Arvio, όπως τρέχουν στο hub. Για να γράψεις driver, μίλα με την SFK.

Μίλα μαζί μας

Σε αυτή τη σελίδα
  1. Πώς είναι ένας driver
  2. Το arvio-driver.json
  3. Το πρωτόκολλο
  4. Οι κανόνες ενός driver
  5. Συχνές ερωτήσεις

Ένας driver είναι ένα μικρό πρόγραμμα που συνδέει μια μάρκα ή ένα πρωτόκολλο με το Arvio. Η μορφή και το πρωτόκολλο που βλέπεις εδώ είναι αυτά που τρέχουν στα hubs.

Πώς είναι ένας driver

Ένας φάκελος με ένα αρχείο arvio-driver.json και ένα αρχείο εκκίνησης. Το Arvio Core τον ξεκινά ως process, σε Node ή Python, και μιλούν με γραμμές JSON από το stdin και το stdout.

Το Arvio Core κρατά τις συσκευές, τα δωμάτια, τις εντολές και τους αυτοματισμούς. Ο driver ξέρει μόνο πώς μιλά με τη συσκευή: δηλώνει τι υπάρχει, στέλνει καταστάσεις και εκτελεί εντολές.

Το arvio-driver.json

ΠεδίοΠαράδειγμαΤι σημαίνει
idsystems.arvio.hueΜοναδικό όνομα με τελείες. Δεν ξεκινά από core.
version0.1.0Έκδοση της μορφής x.y.z.
runtimenodenode ή python.
entrydriver.tsΤο αρχείο εκκίνησης, μέσα στον φάκελο του driver.
namePhilips HueΤο όνομα για ανθρώπους.
permissionsnet:lanΛίστα από radio:zigbee, radio:zwave, radio:ble, net:lan, net:cloud, danger:lock, danger:alarm, danger:gate.
licenseUNLICENSEDMIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, ISC ή UNLICENSED για κώδικα της SFK.
memory_mb48Όριο μνήμης για drivers σε Node, από 16 έως 1024. Προεπιλογή 96.
isolationsharedprocess, η προεπιλογή, ή shared, κοινό process μόνο για ελεγμένους drivers της SFK σε Node.

Το πρωτόκολλο

Μία γραμμή JSON ανά μήνυμα.

ΚατεύθυνσηΜήνυμαΤι λέει
driver → core{"type":"ready"}Ο driver ξεκίνησε.
driver → core{"type":"entity", native_id, domain, name, object_id?}Δηλώνει μια συσκευή.
driver → core{"type":"state", native_id, state, attributes?}Νέα κατάσταση.
driver → core{"type":"ack", id, ok, error?}Το αποτέλεσμα μιας εντολής.
driver → core{"type":"event", native_id?, event, data?}Ένα γεγονός, όπως πάτημα κουμπιού.
driver → core{"type":"log", level, msg}Μια γραμμή καταγραφής.
core → driver{"type":"command", id, native_id, domain, service, data}Μια εντολή προς συσκευή.
core → driver{"type":"setup", id, action, data}Μια ενέργεια ρύθμισης, όπως προσθήκη συσκευής με τα κλειδιά της. Ο driver απαντά με setup_reply.

Οι κανόνες ενός driver

  • Ο driver τερματίζει όταν κλείσει το stdin του, για να μην κρατά θύρες αν σταματήσει το Arvio Core.
  • Αν καταρρεύσει, ξαναξεκινά με καθυστέρηση από 1 έως 60 δευτερόλεπτα. Πάνω από 5 καταρρεύσεις σε 10 λεπτά τον απενεργοποιούν. Το Arvio Core δεν πέφτει.
  • Ένας driver με άκυρο manifest δεν ξεκινά, και το Arvio Core το καταγράφει.
  • Ο driver δεν παίρνει το περιβάλλον ή τα μυστικά του Arvio Core, μόνο τα ελάχιστα και τον δικό του φάκελο δεδομένων.
  • Γραμμές πάνω από 64 KB αγνοούνται.
  • Κλειδαριές, συναγερμός και πύλες δεν ενεργοποιούνται ποτέ στην εκκίνηση. Οι επικίνδυνες εντολές θέλουν επιβεβαίωση, αλλιώς το Arvio Core τις απορρίπτει.

Συχνές ερωτήσεις

Σε ποια γλώσσα γράφεται ένας driver;

Σε Node ή Python. Οι drivers της SFK είναι σε TypeScript. Το πρωτόκολλο είναι γραμμές JSON, οπότε δεν εξαρτάται από κάποια βιβλιοθήκη μας.

Μπορώ να κατεβάσω έναν driver ως παράδειγμα;

Όχι. Το marketplace δεν δίνει κώδικα. Η μορφή και το πρωτόκολλο είναι σε αυτή τη σελίδα.

Θες να γράψεις driver;

Πες μας για ποια μάρκα ή ποιο πρωτόκολλο.

Πες μας για τον χώρο σου

Πες μας τι έχεις και τι θέλεις, και βλέπουμε μαζί τι χρειάζεται ο χώρος σου.