Naar YuJa
  1. YuJa Helpcentrum
  2. Videoplatform Lumina
  3. Opnemen en livestreamen
  4. Hardware Hub
  5. Hubbeheer

Specificaties van het seriële RS-232-protocol van de YuJa Hardware Hub

Avatar
YuJa
  • Bijgewerkt

Dit document beschrijft het protocol dat wordt gebruikt om via de RS-232-interface serieel te communiceren met een YuJa
Hardware Hub. De verzonden commando's kunnen worden gebruikt om de opnamestatus te regelen of actuele statusinformatie
van de hub op te vragen. Commando's zijn strings die serieel worden verzonden en door de hub worden geïnterpreteerd om de
gewenste actie uit te voeren.

Specificaties

Er wordt een USB-naar-serieel-converter met een DB-9-connector (male) gebruikt. Bij de communicatie met de hub worden alleen de pinnen GND, TxD en RxD gebruikt.

  1. Baudrate = 38400
  2. Databits = 8
  3. Stopbits = 1
  4. Pariteit = NONE
  5. Flow control = NONE
  6. YuJa Hardware Hub-apparaat
      • Pin 2: RxD <------------------- TxD
      • Pin 3: TxD -------------------> RxD
      • Pin 5: GND ------------------- GND

Seriële stringcommando's en antwoorden

Omdat het protocol geen flow control kent, worden commando's één voor één verzonden in een verzoek/antwoord-structuur. Wanneer de hub een commando ontvangt, parseert deze de seriële string, voert het commando uit en antwoordt met een eigen seriële string. Er kan pas een tweede commando worden verzonden nadat het antwoord van de hub op het oorspronkelijke commando is ontvangen. Alle commando's en antwoorden hebben de volgende opmaak:

  • Begin: <!XX>
  • Einde: <!YY>
  • Algemene structuur: <!XX><COMMAND> <!YY>

waarbij <COMMAND> 

Opmerking: Het begin en het einde moeten exact zoals weergegeven zijn, maar de commando's zijn niet hoofdlettergevoelig. Bijvoorbeeld:

  • <!XX>CTRL=Start<!YY> wordt op dezelfde manier geïnterpreteerd als <!XX>ctrl=start<!YY>.
  • <!xx>CTRL=Start<!yy> is echter een onbekend commando.
  • Bovendien worden alle stringantwoorden van de hub standaard volledig in hoofdletters weergegeven.

Besturingscommando's

Besturingscommando's wijzigen de status van de YuJa-hub. Ze worden gebruikt om de collegeopname te starten of te stoppen.
De commandostrings waarmee <COMMAND> wordt vervangen, zijn als volgt:

Commando Beschrijving Parameters
CTRL=Start Start de collegeopname. Als de opname is gepauzeerd, wordt deze in plaats daarvan hervat. N.V.T
CTRL=Pause Pauzeer de collegeopname. N.V.T
CTRL=Stop Stop de collegeopname. N.V.T
CTRL=Extend

Voeg 30 minuten toe aan een reeds gestarte collegeopname.

Opmerking: Opnamen die binnen 5 minuten eindigen, kunnen niet worden verlengd.

N.V.T

Opmerking: Het doorgeven van een specifieke verlengingstijd als parameter kan in een toekomstige versie worden toegevoegd.

Na een besturingscommando antwoordt de hub met 1 van de 3 berichten:

  1. Commando geslaagd: nadat het besturingscommando met succes is geïnterpreteerd en uitgevoerd, antwoordt de hub met de oorspronkelijke commandostring waarin alle tekens in hoofdletters zijn.
  2. Commando onbekend: voor niet-herkende of ongeldige commando's antwoordt de hub met de string “UNKNOWN COMMAND”.
  3. Commando mislukt: voor geldige commando's die de hub niet met succes heeft uitgevoerd, wordt een antwoordstring verzonden die de fout aangeeft.
  4. Voorbeelden:
    • De hub starten:
      • Commando: <!XX>CTRL=Start<!YY>
      • Antwoord: <!XX>CTRL=START<!YY>
    • Ongeldig commando:
      • Commando: <!XX>CTRL=Capture<!YY>
      • Antwoord: <!XX>UNKNOWN COMMAND<!YY>
    • Mislukt startcommando:
      • Commando: <!XX>CTRL=Start<!YY>
      • Antwoord: <!XX>FAIL: SESSION OVERLAPS WITH ANOTHER SESSION.<!YY>

Statuscommando's

Statuscommando's worden gebruikt om de huidige status van de hub op te vragen. De commandostrings waarmee
<COMMAND> wordt vervangen, zijn als volgt:

Commando Beschrijving Retourwaarde
STAT=Recording Geeft de opnamestatus van de hub terug.

"RECORDING: ON"

"RECORDING: OFF"
STAT=Connection Geeft terug of de hub correct met de cloud is verbonden.

"CONNECTION: CONNECTED"

"CONNECTION: DISCONNECTED"
STAT=Capture-Duration Geeft de tijd terug die is verstreken sinds de opname is gestart.*

"CAPTURE-DURACTION: <duration of capture**>
STAT=Remaining Geeft de tijd terug die resteert tot het einde van een opname.*

“REMAINING: <remaining time**>”
STAT=Length Geeft de totale duur van de huidige opname terug.*

"LENGTH: <length of capture**>"

*: Er moet een opnamesessie zijn gestart (d.w.z. de opname moet actief zijn) om een tijd te kunnen retourneren.
**: Alle tijden hebben de notatie hh:mm:ss. Indien niet beschikbaar, wordt in plaats van een tijd N/A geretourneerd.

Na een statuscommando antwoordt de hub met 1 van de 2 berichten:

  1. Status: voor geldige statusverzoeken retourneert de hub de gewenste informatie in de vorm van een hash.
  2. Commando onbekend: voor niet-herkende of ongeldige commando's antwoordt de hub met een
    “UNKNOWN COMMAND”-string.
  3. Voorbeelden:
    • De opnamestatus opvragen:
      • Commando: <!XX>STAT=Recording<!YY>
      • Antwoord: <!XX>RECORDING: ON<!YY>
    • Ongeldig commando:
      • Commando: <!XX>STAT=Com<!YY>
      • Antwoord: <!XX>UNKNOWN COMMAND<!YY>
    • De duur van de opname opvragen:
      • Commando: <!XX>STAT=Capture-Duration<!YY>
      • Antwoord: <!XX>CAPTURE-DURATION: 00:12:34<!YY>
    • De duur van de opname van een niet-gestarte hub opvragen:
      • Commando: <!XX>STAT=Capture-Duration<!YY> 
      • Antwoord: <!XX>CAPTURE-DURATION: N/A<!YY>
    • De lengte van de opname opvragen:
      • Commando: <!XX>STAT=Length<!YY>
      • Antwoord: <!XX>LENGTH: 03:00:00<!YY>

Probleemoplossing 

Als u geen antwoord ontvangt van de Hardware Hub, kunt u een aantal dingen doen om het probleem op te lossen.

  1. Zorg ervoor dat u de juiste specificaties voor een baudrate van 38400 hebt ingesteld. Start daarna het hubapparaat opnieuw op om te controleren of het werkt.
  2. U kunt proberen uw TX- en RX-pinnen om te wisselen met een DB9-nulconnector of nulmodemadapter. Start het apparaat na het omwisselen van de connectoren opnieuw op om te controleren of het werkt.
  3. Als het probleem zich blijft voordoen, neemt u contact op met YuJa Support. 

Verwante artikelen

Neem contact op met support