Tässä asiakirjassa määritetään protokolla, jota käytetään sarjaviestintään RS-232-liitännän kautta YuJa
Hardware Hub -laitteen kanssa. Lähetettävillä komennoilla voidaan ohjata tallennustilaa tai hakea hub-laitteen nykyiset
tilatiedot. Komennot ovat sarjamuodossa lähetettäviä merkkijonoja, jotka hub-laite tulkitsee ja
suorittaa halutun toiminnon.
Määritykset
Käytössä on USB-sarjamuunnin, jossa on DB-9-urosliitin. Hub-laitteen kanssa kommunikoitaessa käytetään vain GND-, TxD- ja RxD-nastoja.
- Baudinopeus = 38400
- Databitit = 8
- Stop-bitit = 1
- Pariteetti = NONE
- Vuonohjaus = NONE
- YuJa Hardware Hub -laite
- Nasta 2: RxD <------------------- TxD
- Nasta 3: TxD -------------------> RxD
- Nasta 5: GND ------------------- GND
Sarjamuotoiset merkkijonokomennot ja vastaukset
Koska protokollassa ei ole vuonohjausta, komennot lähetetään yksi kerrallaan pyyntö-vastaus-rakenteella. Kun hub-laitteelle lähetetään komento, se jäsentää sarjamuotoisen merkkijonon, suorittaa komennon ja vastaa omalla sarjamuotoisella merkkijonollaan. Toista komentoa ei voi lähettää, ennen kuin hub-laitteen vastaus alkuperäiseen komentoon on vastaanotettu. Kaikki komennot ja vastaukset muotoillaan seuraavasti:
- Alkutunniste: <!XX>
- Lopputunniste: <!YY>
- Yleinen rakenne: <!XX><COMMAND> <!YY>
missä <COMMAND>
Huomautus: Alku- ja lopputunnisteen on oltava täsmälleen kuvatun mukaiset, mutta komennoissa kirjainkoolla ei ole merkitystä. Esimerkiksi:
- <!XX>CTRL=Start<!YY> tulkitaan samoin kuin <!XX>ctrl=start<!YY>.
- Sen sijaan <!xx>CTRL=Start<!yy> on tuntematon komento.
- Lisäksi kaikki hub-laitteen merkkijonovastaukset ovat oletusarvoisesti kokonaan isoilla kirjaimilla.
Ohjauskomennot
Ohjauskomennot muuttavat YuJa-hub-laitteen tilaa. Niillä aloitetaan ja lopetetaan luennon tallennus.
Merkkijonot, jotka korvaavat kohdan <COMMAND>, ovat seuraavat:
| Komento | Kuvaus | Parametrit |
| CTRL=Start | Aloita luennon tallennus. Jos tallennus on keskeytetty, se jatkuu. | Ei saatavilla |
| CTRL=Pause | Keskeytä luennon tallennus. | Ei saatavilla |
| CTRL=Stop | Lopeta luennon tallennus. | Ei saatavilla |
| CTRL=Extend |
Lisää 30 minuuttia jo käynnistettyyn luennon tallennukseen. Huomautus: Tallennuksia, joiden päättymiseen on alle 5 minuuttia, ei voi pidentää. |
Ei saatavilla Huomautus: Parametrina annettava tietty pidennysaika voidaan lisätä tulevaan versioon. |
Ohjauskomennon jälkeen hub-laite vastaa yhdellä (1) kolmesta (3) viestistä:
- Komento onnistui: kun hub-laite on tulkinnut ja suorittanut ohjauskomennon onnistuneesti, se vastaa alkuperäisellä ohjauskomentomerkkijonolla, jossa kaikki merkit on kirjoitettu isoilla kirjaimilla.
- Komento tuntematon: tunnistamattomiin tai virheellisiin komentoihin hub-laite vastaa merkkijonolla ”UNKNOWN COMMAND”.
- Komento epäonnistui: kelvollisiin komentoihin, joita hub-laite ei onnistunut suorittamaan, lähetetään virheen ilmoittava vastausmerkkijono.
-
Esimerkkejä:
-
Käynnistä hub-laite:
- Komento: <!XX>CTRL=Start<!YY>
- Vastaus: <!XX>CTRL=START<!YY>
-
Virheellinen komento:
- Komento: <!XX>CTRL=Capture<!YY>
- Vastaus: <!XX>UNKNOWN COMMAND<!YY>
-
Epäonnistunut aloituskomento:
- Komento: <!XX>CTRL=Start<!YY>
- Vastaus: <!XX>FAIL: SESSION OVERLAPS WITH ANOTHER SESSION.<!YY>
-
Käynnistä hub-laite:
Tilakomennot
Tilakomennoilla pyydetään hub-laitteen nykyinen tila. Merkkijonot, jotka korvaavat kohdan
<COMMAND>, ovat seuraavat:
| Komento | Kuvaus | Palauttaa |
| STAT=Recording | Palauttaa hub-laitteen tallennustilan. |
"RECORDING: ON" "RECORDING: OFF" |
| STAT=Connection | Palauttaa tiedon siitä, onko hub-laite yhdistetty oikein pilveen. |
"CONNECTION: CONNECTED" "CONNECTION: DISCONNECTED" |
| STAT=Capture-Duration | Palauttaa tallennuksen alusta kuluneen ajan.* |
"CAPTURE-DURACTION: <duration of capture**> |
| STAT=Remaining | Palauttaa tallennuksen päättymiseen jäljellä olevan ajan.* |
”REMAINING: <remaining time**>” |
| STAT=Length | Palauttaa nykyisen tallennuksen kokonaiskeston.* |
"LENGTH: <length of capture**>" |
*: Tallennusistunnon on oltava käynnissä (eli tallennuksen on oltava tilassa ON), jotta aika voidaan palauttaa.
**: Kaikki ajat esitetään muodossa hh:mm:ss. Jos aikaa ei ole saatavilla, ajan sijaan palautetaan N/A.
Tilakomennon jälkeen hub-laite vastaa yhdellä (1) kahdesta (2) viestistä:
- Tila: kelvollisiin tilapyyntöihin hub-laite palauttaa pyydetyn tiedon tiivisteen (hash) muodossa.
-
Komento tuntematon: tunnistamattomiin tai virheellisiin komentoihin hub-laite vastaa
merkkijonolla ”UNKNOWN COMMAND”. -
Esimerkkejä:
-
Pyydä tallennuksen tila:
- Komento: <!XX>STAT=Recording<!YY>
- Vastaus: <!XX>RECORDING: ON<!YY>
-
Virheellinen komento:
- Komento: <!XX>STAT=Com<!YY>
- Vastaus: <!XX>UNKNOWN COMMAND<!YY>
-
Pyydä tallennuksen kesto:
- Komento: <!XX>STAT=Capture-Duration<!YY>
- Vastaus: <!XX>CAPTURE-DURATION: 00:12:34<!YY>
-
Pyydä käynnistämättömän hub-laitteen tallennuksen kesto:
- Komento: <!XX>STAT=Capture-Duration<!YY>
- Vastaus: <!XX>CAPTURE-DURATION: N/A<!YY>
-
Pyydä tallennuksen pituus:
- Komento: <!XX>STAT=Length<!YY>
- Vastaus: <!XX>LENGTH: 03:00:00<!YY>
-
Pyydä tallennuksen tila:
Vianmääritys
Jos Hardware Hub -laite ei vastaa, ongelman ratkaisemiseksi voit kokeilla muutamaa asiaa.
- Varmista, että olet asettanut oikeat määritykset siten, että baudinopeus on 38400. Käynnistä sen jälkeen hub-laite uudelleen varmistaaksesi, että se toimii.
- Voit kokeilla vaihtaa TX- ja RX-nastat keskenään DB9-nollamodeemiliittimen tai -sovittimen avulla. Kun olet vaihtanut liittimet, käynnistä laite uudelleen varmistaaksesi, että se toimii.
- Jos ongelma ei poistu, ota yhteyttä YuJa-tukeen.