DIVUS VISION API Software

Zvinotsanangurwa

• Chigadzirwa: DIVUS VISION API
• Mugadziri: DIVUS GmbH
• Shanduro: 1.00 REV0 1 – 20240528
• Nzvimbo: Pillhof 51 Eppan (BZ), Italy

Product Information

Iyo DIVUS VISION API chishandiso chesoftware chakagadzirirwa kupindirana neDIVUS VISION masisitimu. Inobvumira vashandisi kuwana uye kutonga zvinhu zvakasiyana mukati mehurongwa vachishandisa MQTT protocol.

FAQ

Mubvunzo: Ndingashandisa DIVUS VISION API ndisina ruzivo rwekutanga kwePC kana otomatiki tekinoroji?

A: Bhuku racho rakagadzirirwa vashandisi vane ruzivo rwekare munzvimbo idzi kuti vave nechokwadi chekushandiswa kwakanaka kweAPI.

GENERAL FORMATION

• DIVUS GmbH Pillhof 51 I-39057 Eppan (BZ) – Italy

Mirayiridzo yekushandisa, zvinyorwa uye software zvinodzivirirwa nekodzero. Kodzero dzese dzakachengetwa. Kukopa, kudzokorora, kushandura, kushandura zvizere kana muchidimbu hazvibvumidzwe. Kunze kunoshanda pakugadzira kopi yekuchengetedza yesoftware yekushandisa wega.
Bhuku racho rinogona kuchinja pasina chiziviso. Hatigone kuvimbisa kuti iyo data iri mugwaro iri uye pane yekuchengetedza midhiya inopihwa haina zvikanganiso uye ndeyechokwadi. Mazano ekuvandudza pamwe neanonongedza kukanganisa anogamuchirwa nguva dzose. Zvibvumirano zvinoshandawo kune zvakanangidzirwa pabhuku rino. Mazita ari mugwaro iri anogona kunge ari matrademarks ayo kushandiswa nevechitatu mapato nekuda kwavo kunogona kukanganisa kodzero dzevaridzi vawo. Mirayiridzo yemushandisi: Ndokumbira uverenge bhuku rino usati warishandisa kekutanga uye richengete munzvimbo yakachengetedzeka kuitira ramangwana. Boka rakanangwa: Bhuku iri rakanyorerwa vashandisi vane ruzivo rwekare rwePC uye otomatiki tekinoroji.

MASHOKO OKUTI MUKURU

Nhanganyaya

ZVAKAWANDA SUMO

Iri bhuku rinotsanangura VISION API (Application Programming Interface) - chiratidziro kuburikidza iyo VISION inogona kutariswa uye kudzorwa kubva kune ekunze masisitimu.
Mukutaura kwekuita, izvi zvinoreva kuti iwe unogona kushandisa masisitimu akadai

• MQTT Explorer (https://www.microsoft.com/store/… - yekuyedza),
• Mubatsiri Wepamba (https://www.home-assistant.io/) kana
• Node-RED (https://nodered.org/)

kudzora zvinhu zvinotungamirirwa neVISION kana kuverenga mamiriro azvo. Kuwana uye kutaurirana kunoitika kuburikidza neMQTT protocol, iyo inoshandisa iyo inonzi misoro kugadzirisa ega ega mabasa kana seti yemabasa kana kuziviswa nezve shanduko kwavari. An MQTT server (broker) inoshandiswa nokuda kwechinangwa ichi, iyo inobata kuchengeteka uye kutungamira / kuparadzirwa kwemashoko kune vatori vechikamu. Muchiitiko ichi, sevha yeMQTT inowanikwa zvakananga paDIVUS KNX IQ uye yakanyatsogadzirirwa chinangwa ichi. Kunyangwe iyo VISION API inogona zvakare kushandiswa pasina ruzivo rwekuronga, mashandiro aya akakodzera vashandisi vepamberi.

ZVINOKOSHA

Sezvakatsanangurwa mubhuku reVISION, mushandisi weAPI anofanira nekukasira kutanga aitwa kuti akwanise kuishandisa iyo API yekuwana inoshanda chete uchishandisa iyo Api vashandisi data rechokwadi. Nekuda kwekodzero dzemushandisi, iyo activation yeiyi mashandiro inogona kugadzirwa pane zvese kana pane zvega zvega zvinhu. Ona Chitsauko.0. Ehezve, iwe unoda zvakare VISION purojekiti umo zvinhu zvauri kuda kudzora kubva kunze zvakagadziridzwa zvizere uye kubatana kwazviri kwakaedzwa zvakabudirira. Kuti ukwanise kugadzirisa zvinhu zvega kuburikidza neAPI, yavo element ID inofanirwa kuzivikanwa: izvi zvinoratidzwa pazasi peiyo element's setting form.

KUCHENGETEKA

Nezvikonzero zvekuchengetedza, kuwana API kunogoneka chete munharaunda (kureva kwete kuburikidza negore). Iyo njodzi yekuchengetedza kana uchimisikidza API kuwana saka yakaderera. Zvakadaro, zvinhu zvine chekuita nekuchengetedza hazvifanirwe kugoneswa kana kurambwa zviri pachena kuti API iwane.

MQTT NEZVITEMO ZVAKAITWA – TSANANGURO IFUPI

• MuMQTT, basa rekutonga kwepakati uye kugovera mameseji ese nderemubhuroka. Kunyangwe MQTT sevha neMQTT bhuroka asiri mafana (sevha ishoko rakakura kune basa iro MQTT vatengi vanogona kuitawo), bhuroka rinogara richirehwa mubhuku rino kana MQTT server yataurwa. Iyo DIVUS KNX IQ pachayo inotamba iyo MQTT bhuroka / MQTT server basa mumamiriro ezvinhu ebhuku rino.
• Iyo MQTT sevha inoshandisa inonzi misoro: chimiro chehierarchical icho data yakakamurwa, inotungamirwa uye yakaburitswa.
• Kutsikisa kune chinangwa chikuru chekuita kuti data iwanikwe kune vamwe vatori vechikamu kuburikidza nemisoro. Kana iwe uchida kushandura kukosha, iwe unonyorera kune yaunoda musoro pamwe chete neinodiwa kukosha shanduko, zvakare uchishandisa yekutsikisa chiitiko. Chishandiso chinonangwa kana sevha yeMQTT inoverenga shanduko inodiwa inoibata uye inoitora zvinoenderana. Kuti uone kuti shanduko yashandiswa, unogona kutarisa mune yakanyoreswa-chaiyo-nguva musoro kuti uone kana shanduko inoratidzwa ipapo - kana zvese zvafamba zvakanaka.
• Vatengi vanosarudza misoro inovafadza: uku kunonzi kunyoresa. Pese apo kukosha kunochinja mu/pazasi pechinyorwa, vatengi vese vakanyoresa vanoziviswa - kureva pasina kubvunza zvakajeka kana chimwe chinhu chachinja kana kuti kukosha kwazvino chii.
• Unogona kuvhura (kana kero) imwe nzira yekutaurirana neMQTT server nekuisa chero yakasarudzika tambo inonzi client_id mumusoro. Iyo client_id inofanirwa kushandiswa mumusoro kugadzirisa kukosha. Izvi zvinoshanda kuona kwakabva shanduko yega yega, zvinobatsira nekukanganisa kupi uye hazvikanganise vamwe vatengi, semhinduro dzinoenderana kubva pasevha, kusanganisira chero kukanganisa kodhi uye meseji, zvakare inongosvika iyo musoro neiyo imwechete client_id (uye nekudaro chete. mutengi uyo). Mutengi_id itambo yakasarudzika ine chero musanganiswa wemavara 0-9, az, AZ, "-", "_".
• Kazhinji, zvinyorwa zvekunyorera zveMQTT sevha yeDIVUS KNX IQ ine keyword mamiriro, ukuwo misoro yekushambadzira ine keyword chikumbiro. Avo vane chimiro vanogadziridzwa otomatiki kana paine shanduko yekukosha kwekunze kana nekukurumidza shanduko yekukosha yakumbirwa nemutengi pachayo kuburikidza nekushambadza uye yakashandiswa zvinobudirira. Aya ekutsikisa anozopatsanurwazve kune ayo emhando (chikumbiro/)wana uye ayo emhando (chikumbiro/)seti.
• Kuchinja kwekukosha uye mamwe maitiro ekusarudza anowedzerwa kune iyo inonzi iyo payload. Iwo maparamita ezvimwe zvinhu (element-id, zita, mhando, mabasa)

Musiyano mukuru pakati peMQTT uye yekare mutengi-server modhi, uko mutengi anokumbira obva achinja data, inonangana nemafungiro ekunyorera uye kushambadza. Vatori vechikamu vanogona kuburitsa data, vachiita kuti iwanikwe kune vamwe, avo kana vachifarira vanogona kunyorera kwairi. Ichi chivakwa chinoita kuti zvikwanise kudzikisira kuchinjanisa data uye kuramba uchichengeta mapato ese anofarira kusvika parizvino. Zvakawanda nezve izvo zviri pano: uye akakosha paramita (uuid, mafirita) anofanira kushandiswa pano. Kunyangwe paine akati wandei sarudzo, iyo payload inoratidzwa yakarongwa seJSON mubhuku rino. JSON inoshandisa mabhureki nemakoma kumiririra data yechero chimiro uye nekudaro inoderedza saizi yemapaketi edata kuti afambiswe. Mamwe mashoko pamusoro pemihoro anogona kuwanikwa gare gare mubhuku rekushandisa.

• Nezvinangwa zvakakosha, zvinokwanisika kusefa zvinoenderana nerudzi rwebasa, eg kugadzirisa chete pa/kudzima kureva 1-bit switch. Iyo mafirita parameter mubhadharo inoshandiswa kune ichi chinangwa. Kusefa parizvino kunogoneka chete nerudzi rwebasa.
• Kuti ukwanise kugadzirisa zvinhu zvega, yavo element ID inodiwa. Izvi zvinogona kuwanikwa muVISION mune iyo element yezvinhu menyu kana zvakare inogona kuverengerwa zvakananga kubva kune iyo data inoratidzwa pamberi pechimwe nechimwe chinhu chiripo mune yakajairika kunyoresa yeMQTT Explorer (zvinhu zviripo zvakanyorwa alfabheti nechinhu ID).

Configuration yekuwana API

KUGADZIRA CHIONO CHE API USER ACCESS

MuVISION semaneja, enda kuKugadzirisa - Mushandisi / API Access Management, tinya paVashandisi / API kuwana uye tinya-kurudyi paAPI Mushandisi (kana dzvanya uye ubate) kuvhura hwindo rekugadzirisa. Ikoko iwe unowana aya ma parameter uye data

• Gonesa (checkbox)
  • Mushandisi anotanga agoneswa pano. Default yakadzimwa
• Username
  • Tambo iyi inodiwa kuti uwane kuburikidza neAPI - ikopa kubva pano
• Pasiwedhi
  • Tambo iyi inodiwa kuti uwane kuburikidza neAPI - ikopa kubva pano
• Mvumo
  • Kodzero dzekutadza kuverenga nekunyora hunhu hwezvinhu zveVISION zvinogona kutsanangurwa pano, kureva kuti zvinotsanangurwa pano zvinoshanda kune zvese zviripo uye zveramangwana. Kana iwe uchingoda chete kubvumidza kupinda kune ega zvinhu, haufanirwe kushandura aya maruramiro ekutanga

MVUMI PAMUSORO PAMUSORO PAMUMWE

Zvinokurudzirwa kuti usape API mukana kune iyo yese purojekiti, asi kune izvo zvinodiwa chete. Enderera sezvinotevera

1. pinda muVISION semaneja
2. sarudza chinhu chaunoda uye vhura marongero ayo (tinya-kurudyi kana ramba wakadzvanya, wozoti Settings)
3. pasi pemenu yekupinda General - Mvumo, shandisa "Override default default permits" uye wobva waenda kune sub-chinhu Mvumo, iyo inoratidza mvumo matrix.
4. shandisa mvumo yekutonga pano, iyo inogonesawo iyo view mvumo zvakananga. Kana iwe uchingoda kuverenga data kuburikidza neiyo API yekuwana, zvakakwana kugonesa iyo view mvumo.
5. dzokorora maitiro akafanana kune ese maelementi aunoda kuwana

Kubatanidza kuburikidza neMQTT

NHUNGAMIDZO

Sezvo example, ticharatidza kupinda kuburikidza neMQTT API yeDIVUS KNX IQ ine zviri nyore, software yemahara inonzi MQTT Explorer (ona chap. 1.1), inowanikwa Windows, Mac neLinux. Ruzivo rwekutanga uye ruzivo neMQTT zvinorehwa.

DATA INODIWA KUTI CONNECTION

Sezvambotaurwa (ona chikamu 2.1), zita rekushandisa uye password yemushandisi weAPI inodiwa. Heino mhedzisoview yedata rese rinofanirwa kuunganidzwa kusati kwaitwa kubatana:

• Username Verenga pane peji reruzivo rwemushandisi weAPI
• Password Verenga pane peji reruzivo rwemushandisi weAPI
• IP kero Verenga mune yekuvhura marongero pasi peGeneral - Network - Ethernet (kana kuburikidza ne Synchronizer)
• Port 8884 (chiteshi ichi chakachengeterwa chinangwa ichi)

KUTANGA KUSANGANA NEMQTT EXPLORER UYE GENERAL SUBSCRIBE

Kazhinji, MQTT inosiyanisa pakati pezviitwa kunyoresa uye kushambadza. MQTT Explorer inorerutsa izvi nekunyoresa otomatiki kune ese aripo misoro (musoro #) kana yekutanga kubatana yaitwa. Nekuda kweizvozvo, muti unotungamira kune ese anowanikwa zvinhu (kureva API mushandisi mukana wakapihwa) unogona kuoneka zvakananga munzvimbo yekuruboshwe yeMQTT Explorer hwindo mushure mekubatana kwakabudirira. Kuti uise imwezve kunyoresa misoro kana kutsiva iyo # ine imwe yakasarudzika musoro, enda kune Yepamberi muhwindo rekubatanidza. Musoro unoratidzwa kumusoro kurudyi unotaridzika seizvi:

apo 7f4x0607849x444xxx256573x3x9x983 ndiro zita rekushandisa reAPI uye objects_list ine zvese zviripo.Musoro uyu unogara uchienderana nezvino kureva chero shanduko yeukoshi inotaridzwa ipapo munguva chaiyo. Kana iwe uchingoda kunyoresa kune ega ega zvinhu, isa iyo ID yechinhu chaunoda mushure mezvinhu_list/.

Ongorora: Iyi mhando yekunyoreswa inoenderana nepfungwa kuseri kweKNX mhinduro kero; inoratidza mamiriro ezvinhu aripo iye zvino uye inogona kushandiswa kutarisa kana shanduko dzinodiwa dzakashandiswa zvinobudirira. Kana iwe uchingoda kuverenga data chete asi usingaishandure, rudzi urwu rwekunyorera rwakakwana.

Chinhu chimwe chakareruka chinotaridzika seizvi muJSON notation

Cherechedzo: Hwaro hwese hune syntax yaratidzwa pamusoro eg {"value": "1"} sekubuda kwezvinyorwa zvekunyorera, nepo kukosha kwacho kuchinyorwa zvakananga mumubhadharo kuti uchinje kukosha (kureva kushambadza misoro) - mabhuraketi uye “value” inosiiwa eg “off”: “1”.

Mirairo yepamusoro

NHUNGAMIDZO

Kune mhando nhatu dzemisoro yakajairika:

1. Nyorera misoro (s) kuti uone zvinhu zviripo uye kuti uwane shanduko chaiyo yenguva
2. Nyorera misoro (s) kuti uwane mhinduro ku (vatengi ) buritsa zvikumbiro
3. Shambadzira musoro (s) kuti uwane kana kuseta zvinhu zvine kukosha kwazvo

Tichazotaura nezvemhando idzi tichishandisa manhamba anoratidzwa pano (semuenzaniso misoro yemhando 1, 2, 3). Mamwe mashoko muzvikamu zvinotevera uye muchitsauko. 4.2.

SUBSCRIBE TOPIS KUTI UONE ZVINHU ZVIRIPO UYE KUTI Uwane KUSHANJWA KWEKUKOSHA KWECHAIKO.

Izvi zvakatotsanangurwa

SUBSCRITER TOPIS KUTI UPIRE MHINDURO KUZVIKUMBIRWA ZVEMUTENGO ZVINOBUDISA

Misoro yemhando iyi ndeyekusarudza. Inobvumira kuti

• vhura yakasarudzika nzira yekutaurirana neMQTT server nekushandisa inopokana client_id. Zvakawanda nezvazvo muchitsauko. 4.2.2
• tora mhedzisiro yekushambadza zvikumbiro pane inoenderana kunyoresa musoro: kubudirira kana kutadza nekodhi yekukanganisa uye meseji.

Pane misoro yakasiyana yekuwana mhinduro kuwana kana kuseta mirairo yekushambadza. Kusiyana kwakasiyana mu Kana uchinge wawana misoro inodiwa yesystem yako zvakananga, unogona kusarudza kubvisa nhanho iyi uye kushandisa zvakananga kuburitsa misoro.

 SHANDISA NYAYA KUTI Uwane KANA KUGADZIRA ZVINHU NEZVINOKOSHA ZVO

Iyi misoro inoshandisa nzira yakafanana neiyo yekunyoresa - shanduko chete ishoko rekuti "chikumbiro" pachinzvimbo che "status" inoshandiswa kunyoresa. Nzira dzehurukuro dzakakwana dzinoratidzwa gare gare muchitsauko. 4.2.2\ Musoro wekuwana uchakumbira kuverenga zvimiro nehunhu zveMQTT server. Iyo payload inogona kushandiswa kusefa zvichienderana nerudzi rwebasa rezvinhu. Chinyorwa chakagadzwa chinokumbira kushandura zvimwe zvikamu zvechinhu, sekutsanangurwa kwacho mubhadharo.

PREFIX YEMIRAIRO NEMHINDURO DZINOENDERANA

 TSANANGURO PUPHINDU

Yese mirairo inotumirwa kuMQTT server ine yakajairika chikamu chekutanga, chinoti:

Tsanangudzo Yakadzama

Misoro yenguva-chaiyo (rudzi rwekutanga) ichange iine chivakashure (ona pamusoro) yozoteverwa ne

or

Pamaseti mirairo, mubhadharo zviri pachena unotamba iro basa guru sezvo rinenge riine shanduko dzinodiwa (kureva dzakachinja hunhu hwemabasa echinhu). Yambiro: Usambofa washandisa iyo yekuchengeta sarudzo mune yako mhando 3 mirairo nekuti inogona kukonzera nyaya kudivi reKNX.

EXAMPLE: SHANDISA CHEKUCHINJWA CHINHU CHIMWE CHINHU CHINOKOSHA(ZVI)

Nyaya iri nyore ndeyekuda kushandura kukosha kwechimwe chezvinhu zvinoratidzwa ne general subscribe .
Kazhinji, kushandura/kushandura basa reVISION kuburikidza neMQTT rine nhanho nhatu, kwete dzose dziri nzvimbo dzinodiwa, asi zvakadaro tinokurudzira kuzviita sezvakatsanangurwa.

1. Musoro une basa ratinoda kugadzirisa unonyoreswa uchishandisa tsika client_id
2. Musoro wekugadzirisa unoburitswa pamwe chete nemubhadharo neshanduko dzinodiwa uchishandisa client_id yakasarudzwa mu1.
3. Kuti utarise, unogona kuona mhinduro mumusoro wenyaya (1.) - kureva kuti (2.) yakashanda here kana kwete
4. Muzhinji kunyoresa, uko hunhu hwese hunogadziridzwa kana shanduko dzaitwa, unogona kuona kukosha kwaunoda kuchinja (s) kana zvese zvafamba zvakanaka.

Matanho ekuita izvi ndeaya:

1. sarudza mutengi_id eg "Divus" woiisa munzira mushure meiyo API username
   Iyi ndiyo musoro wakazara wekunyorera kune yako wega nzira yekutaurirana neMQTT server. Izvi zvinoudza sevha kwaunotarisira mhinduro kune shanduko dzauri kuda kutumira. Cherechedza chimiro/seti chikamu chinotsanangura a. kuti inyaya yekunyorera uye b. kuti ichawana mhinduro yekuseta mirairo yemhando.
2. Musoro wekushambadzira uchave wakafanana kunze kwekuchinja mamiriro-kukumbira mazwi makuru
3. iyo shanduko inofanira kuve yakanyorwa mubhadharo. Heano mamwe maexamples.
   • Kudzima chinhu chine on/off function (1 bit):
   • Kuchinja pane chinhu chine on/off function (1 bit). Pamusoro pezvo, kana mirairo yakati wandei yatangwa kubva kumutengi mumwe chete, iyo uuid parameter ("yakasarudzika ID", inowanzoita 128-bit tambo yakaumbwa se8-4-4-4-12 manhamba hex) inogona kushandiswa kugovera iyo. mhinduro kumubvunzo unoenderana, sezvo iyi parameter - kana iripo mumubvunzo - inogona kuwanikwawo mumhinduro.
   • Kubatidza uye kuseta kupenya kwe dimmer kusvika ku50%
   • Mhinduro kumusoro wakaratidzwa uye kunyoreswa kune pamusoro (mubhadharo wayo, kuve chaiwo) ipapo, kune ex.ample.
     Mhinduro iri pamusoro ndeye example kana iri iyo chaiyo payload, kunyangwe iyo element isina dimming basa. Kana paine mamwe matambudziko akakomba anoita kuti mubhadharo urege kududzirwa nenzira kwayo, mhinduro inotaridzika seizvi (semuenzaniso):
     kune tsananguro yezvikanganiso nemameseji asi kazhinji, senge http, 200 macode imhinduro dzakanaka nepo 400 ari negative.

EXAMPLE: SHANDISA KUCHINJWA ZVINHU ZVINHU ZVINHU ZVAKAWANDA

Maitiro akafanana neakaratidzwa kare kushandura chinhu chimwe chete. Musiyano ndewekuti unosiya element_id kubva kumisoro wobva waratidza seti ye element_ids pamberi pe data mukati memubhadharo. Ona syntax uye chimiro pazasi.

SEFA NEBASA TYPE MUMIBVUNZO

Iyo mafirita parameter mune yekubhadhara inobvumira chete basa raunoda (s) rechinhu kuti chigadziriswe. Iyo on/off function ye switch kana dimmer inodaidzwa kuti "off", semuenzanisoample, uye sefa inoenderana inotsanangurwa nenzira iyi:

Mhinduro inobva yaita seizvi, semuenzanisoample

Iyo square bracket inoratidza kuti iwe unogona zvakare kusefa nemaitiro akati wandei, semuenzaniso

zvinopa mhinduro seizvi:

Appendikisi

Kanganiso Makodhi

Zvikanganiso mukutaurirana kweMQTT zvinoguma nekodhi yenhamba. Tafura inotevera inobatsira kuiputsa.

ZVIMWE ZVIMWE ZVIMWE PAYLOAD

Iyo payload inotsigira akasiyana ma parameter zvichienderana nemamiriro ezvinhu. Tafura inotevera inoratidza kuti ndeapi maparameter anogona kuitika mumisoro ipi

VERSION MASHOKO

• VESITSI 1.00

Nhau:

• Kudhindwa kwekutanga

Zvinyorwa / Zvishandiso

	DIVUS VISION API Software [pdf] User Manual VISION API Software, API Software, Software
	DIVUS Vision API Software [pdf] Bhuku reMushandisi Vision API Software, Vision, API Software, Software

References

• User Manual