DIVUS VISION API Manual User Software

API ɗin DIVUS VISION kayan aikin software ne da aka ƙera don mu'amala da tsarin DIVUS VISION. Yana ba masu amfani damar samun dama da sarrafa abubuwa daban-daban a cikin tsarin ta amfani da ka'idojin MQTT.

FAQ

Tambaya: Zan iya amfani da DIVUS VISION API ba tare da sanin PC ko fasaha ta atomatik ba?

A: An keɓance littafin don masu amfani da ilimin baya a waɗannan wuraren don tabbatar da ingantaccen amfani da API.

JANAR BAYANI

DIVUS GmbH Pillhof 51 I-39057 Eppan (BZ) - Italiya

Umarnin aiki, litattafai da software ana kiyaye su ta haƙƙin mallaka. An kiyaye duk haƙƙoƙi. Kwafi, kwafi, fassara, fassara gabaɗaya ko wani ɓangare ba a yarda ba. Togiya ya shafi ƙirƙirar kwafin madadin software don amfanin kai.
Littafin yana iya canzawa ba tare da sanarwa ba. Ba za mu iya ba da garantin cewa bayanan da ke ƙunshe a cikin wannan daftarin aiki da kan kafofin watsa labaru da aka kawo ba su da kurakurai kuma daidai. Shawarwari don ingantawa da kuma alamu kan kurakurai ana maraba koyaushe. Yarjejeniyoyi kuma sun shafi takamaiman abubuwan da ke cikin wannan littafin. Alamomin da ke cikin wannan takarda na iya zama alamun kasuwanci waɗanda wasu ɓangarorin uku ke amfani da su don dalilai nasu na iya keta haƙƙin masu su. Umarnin mai amfani: Da fatan za a karanta wannan jagorar kafin amfani da shi a karon farko kuma ajiye shi a wuri mai aminci don tunani na gaba. Ƙungiya mai niyya: An rubuta littafin don masu amfani waɗanda ke da ilimin PC da fasahar sarrafa kansa a baya.

TARON GABATARWA

Gabatarwa

GABATARWA JAMA'A

Wannan jagorar tana bayyana VISION API (Aikace-aikacen Shirye-shiryen Interface) - hanyar sadarwa wacce za a iya magance VISION da sarrafawa daga tsarin waje.
A aikace, wannan yana nufin cewa zaku iya amfani da tsarin kamar

MQTT Explorerhttps://www.microsoft.com/store/… - don gwaji),

Mataimakin Gida (https://www.home-assistant.io/) ko
Node-RED (https://nodered.org/)

don sarrafa abubuwan da VISION ke sarrafawa ko karanta matsayin su. Samun dama da sadarwa suna faruwa ta hanyar ka'idar MQTT, wanda ke amfani da abin da ake kira batutuwa don magance ayyuka na mutum ɗaya ko saitin ayyuka ko don sanar da su game da canje-canje a gare su. Ana amfani da uwar garken MQTT (dillali) don wannan dalili, wanda ke kula da tsaro da gudanarwa / rarraba saƙonni ga mahalarta. A wannan yanayin, uwar garken MQTT yana tsaye a kan DIVUS KNX IQ kuma an tsara shi musamman don wannan dalili. Kodayake ana iya amfani da VISION API ba tare da ilimin shirye-shirye ba, wannan aikin ya dace da masu amfani da ci gaba.

SHARI'A

Kamar yadda aka bayyana a cikin littafin VISION, mai amfani da API dole ne a fara kunna shi ta tsohuwa domin samun damar yin amfani da shi damar API kawai yana aiki ta amfani da bayanan tantance masu amfani da Api. Dangane da haƙƙin mai amfani, kunna wannan aikin za'a iya saita shi ko dai akan duk ko akan abubuwa ɗaya. Duba Babi na 0. Tabbas, kuna buƙatar aikin VISION wanda abubuwan da kuke son sarrafawa daga waje sun daidaita sosai kuma an gwada haɗin su cikin nasara. Don samun damar magance abubuwa guda ɗaya ta hanyar API, dole ne a san ID ɗin su: ana nuna wannan a ƙasan sigar saitunan abubuwan.

TSARO

Don dalilai na tsaro, samun damar API yana yiwuwa ne kawai a cikin gida (watau ba ta gajimare ba). Hadarin tsaro lokacin kunna damar API yayi ƙasa da ƙasa. Duk da haka, abubuwan da suka dace da tsaro bai kamata a kunna ko a musunta su ba don samun damar API.

MQTT DA SHARUDUNSA - TAKAITACCEN BAYANI

A cikin MQTT, aikin gudanarwa na tsakiya da rarraba duk saƙonni shine na dillali. Duk da cewa uwar garken MQTT da dillali na MQTT ba ma’ana ba ne (uwar garken babban lokaci ne don rawar da abokan cinikin MQTT suma za su iya takawa), ana nufin dillali a cikin wannan jagorar lokacin da aka ambaci uwar garken MQTT. DIVUS KNX IQ kanta tana taka rawar uwar garken MQTT / MQTT a cikin mahallin wannan jagorar.
Sabar MQTT tana amfani da abin da ake kira batutuwa: tsarin tsarin da aka rarraba bayanai, sarrafawa da buga su.

Buga yana da babban burin samar da bayanai ga sauran mahalarta ta hanyar batutuwa. Idan kuna son canza ƙima, kuna rubuta zuwa taken da ake so tare da canjin ƙimar da ake so, kuma ta amfani da aikin bugawa. Na'urar da aka yi niyya ko uwar garken MQTT suna karanta canjin da ake so wanda ya shafe shi kuma ya karbe shi daidai. Don duba cewa an yi amfani da canjin, zaku iya duba cikin ainihin lokacin da aka yi rajista don ganin ko canjin ya bayyana a can - idan komai ya yi kyau.
Abokan ciniki suna zaɓar batutuwan da suke sha'awar su: ana kiran wannan biyan kuɗi. Duk lokacin da ƙima ta canza a/ƙasa da batu, ana sanar da duk abokan cinikin da aka yi rajista - watau ba tare da yin tambaya a sarari ko wani abu ya canza ko menene ƙimar yanzu ba.

Kuna iya buɗe (ko adireshi) wata tashar sadarwa ta daban tare da uwar garken MQTT ta shigar da kowane irin kirtani na musamman da ake kira client_id a cikin wani batu. Dole ne a yi amfani da client_id a cikin batun don aiwatar da ƙima. Wannan yana aiki don gano asalin kowane canji, yana taimakawa tare da kowane kurakurai kuma baya shafar sauran abokan ciniki, kamar yadda martanin da suka dace daga uwar garken, gami da kowane lambobin kuskure da saƙonnin, shima kawai ya isa batun tare da abokin ciniki_id ɗaya kawai (kuma don haka kawai. abokin ciniki). Client_id shine keɓaɓɓen kirtani na ɗabi'a wanda ya ƙunshi kowane haɗin haruffa 0-9, az, AZ, "-", "_".
Gabaɗaya, batutuwan biyan kuɗi na uwar garken MQTT na DIVUS KNX IQ sun ƙunshi matsayi na maɓalli, yayin da batutuwan da aka buga sun ƙunshi buƙatun kalmar. Wadanda ke da matsayi ana sabunta su ta atomatik da zarar an sami canjin ƙimar waje ko da zarar abokin ciniki ya nemi canjin ƙima ta hanyar bugawa kuma an yi nasarar amfani da shi. Ana ƙara rarraba waɗanda za a buga zuwa nau'in (request/) samu da na nau'in (request/)saitin.

Ana ƙara canje-canjen ƙima da sauran sigogin zaɓi a cikin batun tare da abin da ake kira ɗaukar nauyi. Ma'auni na abubuwan guda ɗaya (bangare-id, suna, nau'in, ayyuka)

Babban bambanci tsakanin MQTT da samfurin abokin ciniki-server na gargajiya, inda abokin ciniki ya buƙace sannan kuma ya canza bayanai, ya ta'allaka ne akan ra'ayoyin biyan kuɗi da bugawa. Mahalarta suna iya buga bayanai, suna ba da shi ga wasu, waɗanda idan masu sha'awar za su iya biyan kuɗi zuwa gare ta. Wannan gine-gine yana ba da damar rage yawan musayar bayanai kuma har yanzu kiyaye duk masu sha'awar zamani. Ƙarin bayani game da cikakkun bayanai anan: kuma za a yi amfani da sigogi na musamman (uuid, filters) anan. Kodayake akwai zaɓuɓɓuka da yawa, ana nuna nauyin kuɗin da aka tsara azaman JSON a cikin wannan jagorar. JSON yana amfani da maɓalli da waƙafi don wakiltar bayanai na kowane tsari don haka yana rage girman fakitin bayanan da za a watsa. Ana iya samun ƙarin cikakkun bayanai game da lodin kuɗi daga baya a cikin jagorar.

Don dalilai na musamman, yana yiwuwa a tace gwargwadon nau'in aikin, misali don magance kawai kunnawa/kashewa watau 1-bit switches. Ana amfani da ma'aunin tacewa a cikin kayan aiki don wannan dalili. Tace a halin yanzu yana yiwuwa ta nau'in aiki kawai.
Don samun damar magance abubuwa guda ɗaya, ana buƙatar ID ɗin su. Ana iya samun wannan a cikin VISION a cikin menu na abubuwan kaddarorin ko kuma ana iya karantawa kai tsaye daga bayanan da aka nuna a gaban kowane nau'ikan da ke akwai a cikin gabaɗayan biyan kuɗi na MQTT Explorer (kayanan da aka jera su ta haruffa ta ID element).

Kanfigareshan don samun damar API

GASKIYA HANNU DOMIN SAMUN MAI AMFANI DA API

A cikin VISION a matsayin mai gudanarwa, je zuwa Kanfigareshan - Mai amfani / API Access Management, danna kan Masu amfani/API damar kuma danna dama akan Mai amfani API (ko danna ka riƙe) don buɗe taga gyarawa. A can za ku sami waɗannan sigogi da bayanai

Kunna (akwatin shaida)
- An fara kunna mai amfani anan. An kashe tsoho
Sunan mai amfani
- Ana buƙatar wannan kirtani don samun dama ta API - kwafa shi daga nan
Kalmar wucewa
- Ana buƙatar wannan kirtani don samun dama ta API - kwafa shi daga nan
Izini
- Ana iya bayyana haƙƙoƙin da aka saba don karantawa da rubuta ƙimar abubuwan VISION anan, watau abin da aka ayyana a nan ya shafi duk abubuwan da suke da su da na gaba. Idan kawai kuna son ba da damar samun dama ga abubuwa guda ɗaya, bai kamata ku canza waɗannan haƙƙoƙin da suka dace ba

izni AKAN ABUBUWA DAYAUKI

Ana ba da shawarar cewa kar ku ba da damar API ga dukkan aikin, amma ga abubuwan da ake so kawai. Ci gaba kamar haka

shiga VISION a matsayin mai gudanarwa
zaɓi abin da ake so kuma buɗe menu na saitunan sa (danna dama ko a ci gaba da dannawa, sannan saiti)

a ƙarƙashin shigarwar menu Gabaɗaya - Izini, kunna "Rufe tsoffin izini" sannan je zuwa Izinin ƙaramin abu, wanda ke nuna matrix izini.
kunna ikon sarrafawa a nan, wanda kuma yana ba da damar view izini kai tsaye. Idan kawai kuna son karanta bayanai ta hanyar samun damar API, ya isa don kunna bayanan view izini.
maimaita hanya iri ɗaya don duk abubuwan da kuke son samun dama ga

Haɗin kai ta hanyar MQTT

GABATARWA

A matsayin exampHar ila yau, za mu nuna damar shiga ta MQTT API na DIVUS KNX IQ tare da sauƙi mai sauƙi, software mai kyauta da ake kira MQTT Explorer (duba babi 1.1), wanda yake samuwa ga Windows, Mac da Linux. Ilimi na asali da gogewa tare da MQTT ana nunawa.

BAYANIN DA AKE BUKATA DOMIN HADA

Kamar yadda aka ambata a baya (duba sashe 2.1), ana buƙatar sunan mai amfani da kalmar sirri na mai amfani da API. Anan an gamaview na duk bayanan da dole ne a tattara kafin a kafa haɗi:

Karanta sunan mai amfani akan cikakken shafin mai amfani da API
Kalmar wucewa Karanta a kan cikakken shafi na mai amfani da API

Adireshin IP Karanta a cikin saitunan ƙaddamarwa a ƙarƙashin Janar - Cibiyar sadarwa - Ethernet (ko ta hanyar Synchronizer)
Port 8884 (an tanadi wannan tashar jiragen ruwa don wannan dalili)

HA'DA FARKO TARE DA MQTT EXPLORER DA GENERAL SUBSCRIBE

A al'ada, MQTT yana bambanta tsakanin ayyukan biyan kuɗi da bugawa. MQTT Explorer yana sauƙaƙa wannan ta hanyar yin rajista ta atomatik zuwa duk abubuwan da ake da su (maudu'in #) lokacin da aka haɗa haɗin farko. Sakamakon haka, ana iya ganin itacen da ke kaiwa ga duk abubuwan da ake da su (watau damar samun damar amfani da API) kai tsaye a yankin hagu na taga MQTT Explorer bayan haɗin gwiwa mai nasara. Don shigar da ƙarin batutuwan biyan kuɗi ko don maye gurbin # tare da ƙarin takamaiman batu, je zuwa Na ci gaba a cikin taga haɗin gwiwa. Taken da aka nuna a hannun dama na sama yayi kama da haka:

inda 7f4x0607849x444xxx256573x3x9x983 API shine sunan mai amfani kuma abubuwan_list ya ƙunshi duk abubuwan da ake da su. Wannan batu koyaushe ana kiyaye shi har zuwa yau wato duk wani canjin ƙima yana nunawa a wurin a ainihin-lokaci. Idan kawai kuna son biyan kuɗi zuwa abubuwan mutum ɗaya, shigar da ID na kashi na abubuwan da ake so bayan abubuwa_list/.

Lura: Wannan nau'in biyan kuɗi ya yi daidai da ma'anar da ke bayan adiresoshin ra'ayoyin KNX; yana nuna halin yanzu na abubuwan kuma ana iya amfani dashi don bincika ko an sami nasarar aiwatar da canje-canjen da ake so. Idan kuna son karanta bayanai kawai amma ba ku canza su ba, wannan nau'in biyan kuɗi ya isa .

Abu ɗaya mai sauƙi yana kama da wani abu kamar wannan a cikin bayanin JSON

Lura: Duk dabi'u suna da syntax da aka nuna a sama misali {"darajar": "1" } azaman fitar da jigogi na biyan kuɗi, yayin da aka rubuta ƙimar kai tsaye a cikin abin da aka biya don canza ƙima (watau don buga batutuwa) - maƙallan da "darajar" an cire shi misali "a kashe": "1".

Manyan umarni

GABATARWA

Akwai nau'ikan batutuwa guda uku gabaɗaya:

Yi rijistar jigo (s) don ganin abubuwan da ake da su kuma don samun canje-canjen ƙima na ainihin lokaci
Yi rajistar batutuwa(s) don samun amsoshinabokan ciniki ) buga buƙatun

Buga jigo (s) don samun ko saita abubuwa tare da ƙimar su

Daga baya za mu koma ga waɗannan nau'ikan ta amfani da lambar da aka nuna a nan (misali batutuwa na nau'in 1, 2, 3). Karin bayani a cikin sassan da ke gaba kuma a cikin babi. 4.2.

Kuyi SUBSCRIBE DOMIN GANIN ABUBUWA DA AKE SAMU KUMA DOMIN SAMU CANJIN KYAU NA GASKIYA.

An riga an kwatanta waɗannan

KUYI SUBSCRIBE KAN BATUN DOMIN SAMU AMSOSHIN BUKATUN BUGA ABOKI

Irin wannan batu na zaɓi ne. Yana ba da damar

bude tashar sadarwa ta musamman tare da uwar garken MQTT ta amfani da abokin ciniki_id na sabani. Ƙarin bayani game da hakan a cikin babi. 4.2.2
sami sakamakon buƙatun buga akan batun biyan kuɗi mai dacewa: nasara ko gazawa tare da lambar kuskure da saƙo.

Akwai batutuwa daban-daban don samun amsoshi don samun ko saita umarnin bugawa. Bambancin madaidaicin a Da zarar kun sami batutuwan da ake buƙata don tsarin ku kai tsaye, zaku iya yanke shawarar cire wannan matakin kuma kuyi amfani da buga batutuwa kai tsaye.

BUGA BATUN DON SAMU KO SATA ABUBUWA DA DARAJARSU.

Waɗannan batutuwa suna amfani da hanya mai kama da waɗanda suke yin rajista - kawai canjin shine kalmar "buƙata" a maimakon "halin" da aka yi amfani da shi don biyan kuɗi. Ana nuna cikakkun hanyoyin jigo daga baya a babi. 4.2.2 Taken samun zai buƙaci karanta abubuwa da ƙimar sabar MQTT. Ana iya amfani da abin da aka biya don tacewa bisa nau'in aikin abubuwan. Maudu'in da aka saita zai nemi a canza wasu sassa na wani abu, kamar yadda aka yi dalla-dalla a cikin kayan aikin sa.

MAGANAR DOMIN UMURNI DA MASU DAUKAR MASU DAUKI

GASKIYA BAYANI

Duk umarnin da aka aika zuwa uwar garken MQTT suna da sashin farko na gama gari, wato:

BAYANI BAYANI

Maudu'ai na ainihin-lokaci (nau'in 1) za su sami babban fa'ida (duba sama) sannan su biyo baya

Don saitin umarni, a bayyane yake abin da ake biya yana taka muhimmiyar rawa domin zai ƙunshi canje-canjen da ake so (watau canza dabi'u don ayyukan kashi). Gargaɗi: Kada ku taɓa amfani da zaɓin riƙewa a cikin nau'in umarnin ku na 3 saboda yana iya haifar da al'amura a ɓangaren KNX.

EXAMPLE: BUGA DOMIN CANJA DARAJAR GUDA GUDA GUDA (S)

Mafi sauƙaƙa yanayin shine son canza ƙimar ɗayan abubuwan da babban biyan kuɗi ya nuna.
Gabaɗaya magana, canzawa/canza aikin VISION ta hanyar MQTT ya ƙunshi matakai 3, ba duka waɗanda ke da mahimmanci ba, amma duk da haka muna ba da shawarar aiwatar da su kamar yadda aka bayyana.

Taken da ya ƙunshi aikin da muke son gyara ana yin rajista ta amfani da abokin ciniki_id na al'ada
An buga taken don gyarawa tare da nauyin kaya tare da canje-canjen da ake so ta amfani da abokin ciniki_id da aka zaɓa a cikin 1.

Don bincika, zaku iya ganin amsar a cikin jigon (1.) - watau ko (2.) yayi aiki ko a'a
A cikin babban kuɗin shiga, inda aka sabunta duk ƙimar lokacin da aka yi canje-canje, zaku iya ganin canjin (s) ƙimar da ake so idan komai ya yi kyau.

Matakan yin haka su ne:

zaɓi abokin ciniki_id misali "Divus" kuma saka shi a cikin hanyar bayan sunan mai amfani na API
Wannan shine cikakken maudu'i don biyan kuɗi zuwa tashar sadarwar ku tare da uwar garken MQTT. Wannan yana gaya wa uwar garken inda kuke tsammanin martani ga canje-canjen da kuke son aikawa. Lura da matsayi/sashe saiti wanda ke bayyana a. cewa batun biyan kuɗi ne kuma b. cewa zai sami amsoshi don saita umarnin nau'in.
Taken wallafe-wallafen zai kasance iri ɗaya sai dai don sauya kalmomin neman matsayi
abin da canjin ya kamata ya ƙunshi an rubuta shi a cikin kaya. Ga wasu examples.
- Kashe abin da ke da aikin kunnawa/kashe (1 bit):
- Kunna wani kashi wanda ke da aikin kunnawa/kashe (1 bit). Bugu da ƙari, idan an fara irin waɗannan umarni da yawa daga abokin ciniki ɗaya, ma'aunin uuid ("ID na musamman", yawanci kirtani 128-bit wanda aka tsara azaman 8-4-4-4-12 lambobi hex) ana iya amfani dashi don sanya wa amsa tambayar da ta dace, kamar yadda wannan ma'aunin - idan akwai a cikin tambayar - kuma ana iya samun shi a cikin martanin.
- Kunnawa da saita hasken dimmer zuwa 50%
- Amsar batun da aka nuna da kuma biyan kuɗi zuwa sama (nauyin sa, don zama daidai) shine, misaliample.
  Amsar da ke sama shine tsohonample a cikin yanayin nauyin kaya daidai, kodayake kashi ba shi da aikin dimming. Idan akwai ƙarin matsalolin da suka fi tsanani da ke haifar da abin da aka biya ba za a fassara shi daidai ba, amsa zai yi kama da haka (misali:
  don bayanin lambobin kuskure da saƙonnin amma gabaɗaya, kamar na http, lambobin 200 suna da amsoshi masu kyau yayin da 400 ba su da kyau.

EXAMPLE: BUGA DOMIN CANZA MANYAN ABUBUWA DABI'U

Hanyar tana kama da wanda aka nuna a baya don canza kashi ɗaya. Bambanci shine ka cire element_id daga batutuwa sannan ka nuna saitin element_ids a gaban bayanan da ke cikin abin da ake biya. Dubi syntax da tsarin da ke ƙasa.

TACE TA NAU'IN AIKI A CIKIN TAMBAYOYI

Ma'aunin tacewa a cikin nauyin biyan kuɗi yana ba da damar aiki(s) da ake so na wani abu kawai don a magance shi. Aikin kunnawa ko kashewa ana kiransa “a kashe”, misaliample, kuma an bayyana ma'anar tace ta wannan hanya:

Amsar sai tayi kama da haka, ga example

Bakin murabba'i yana nuna cewa zaku iya tace ta ayyuka da yawa, misali

ya kai ga amsa kamar haka:

Karin bayani

KUSKUREN KODA

Kurakurai a cikin sadarwar MQTT suna haifar da lambar lamba. Teburin da ke gaba yana taimakawa wajen rushe shi.

MASALLACIN DA AKE BIYA

Nauyin kuɗin yana goyan bayan sigogi daban-daban dangane da mahallin. Tebur mai zuwa yana nuna waɗanne sigogi zasu iya faruwa a cikin waɗanne batutuwa

BAYANIN BAYANIN

KYAUTA 1.00

Labarai:

• Buga na farko

Takardu / Albarkatu

	API ɗin Software na DIVUS VISION [pdf] Manual mai amfani VISION API Software, API Software, Software
	DIVUS Vision API Software [pdf] Jagorar mai amfani Vision API Software, Vision, API Software, Software

Magana

Manual mai amfani

API ɗin Software na DIVUS VISION

Bayanin samfur

FAQ