Difference between revisions of "Help & Instructions"

Latest revision as of 16:39, 18 February 2018

Introduktion

SI-Droid ROC är en Android app för orientering som gör det väldigt enkelt att rapportera in online-stämplingar från skogen till ROC's webservice. Allt som behövs förutom själva SportIdent-kontrollen är en Android telefon och en USB OTG-kabel. En sån kabel kan köpas för under en hundring hos t.ex. Kjell & Co eller Clas Ohlsson. Vill man ansluta mer än en kontroll så behövs även en mini-USB-hub.

Template:Note

Första användning

Detta måste göras första gången appen används på en ny telefon för att registrera ROC-enheten på dig:

• Gå in under Inställningar i appen och konfigurera ROC namn till ett vettigt namn för ROC-enheten.
• Gå tillbaka till huvudsidan och starta sändning/mottagning av stämplingar genom att trycka på Start-knappen. Tryck även Starta i dialogen som kommer upp. Det behöver i detta läge inte finnas någon kontrollenhet ansluten. Det som händer då är att appen skickar sin unika MAC-adress till ROC's webtjänst för första gången. Detta gör också att det skapas en helt ny ROC-enhet hos webtjänsten som behöver konfigureras.
• Stoppa sändning/mottagning igen efter ca 30 sekunder genom att trycka på Stopp-knappen.
• Surfa in på web-adressen http://roc.olresultat.se och se att du hittar din nyregistrerade ROC längst upp i listan.
• Klicka på Configure långt ut till höger i webgränssnittett och skriv sedan in ett lösenord, kontaktnamn o email för ROC-enheten och spara konfigurationen.

Efter denna första uppstart och inställning kommer telefonen alltid att vara knuten till just den ROC-enheten via den telefonunika MAC-adressen som kan ses under Inställningar. Enda gången du behöver konfigurera något mer i webgränssnittet är när du sedan vill ansluta ROC-enheten till en viss tävling och få ett tävlingsnummer. Tävlingsnumret behövs för att kunna hämta hem stämplingar till OLA, OE2010/OS2010 eller MeOS.

Anslut kontroller

Appen kan hantera alla typer av mastrar med sladd, både USB och serie-varianten (via USB-till-serie-konverter). Det är även möjligt att ansluta flera mastrar samtidigt genom att använda en USB-hubb. Normalt så behöver USB-hubben inte ha extern strömförsörjning utan allt strömförsörjs via telefonen.

När en master ansluts till telefonen och du har godkänt att appen får lov att använda enheten så försöker appen att autodetektera baudrate och typ av master. Resulatet från autodetekteringen presenteras alltid genom att dialogrutan "Anslutna SI-Mastrar" visas. Samma dialog går även att öppna närsomhelst genom att trycka på SI-master-ikonen i appen. I dialogen listas alla anslutna mastrar och konvertrar och du kan kontrollera att appen hittat alla dina mastrar och att de är rätt konfigurerade.

Enheterna i listan kan ha tre olika typer av status:

• Grön = Användbar
  Detta visar att en master har hittas och att den är korrekt konfigurerad. Kravet på mastern är att läget är antingen Kontroll, Clear, Check, Start eller Mål och att Autosend är påslaget.
• Röd = Inte användbar
  Detta visar att en master har hittats men att den är konfigurerad så att den inte kan användas av appen. Troligtvis så är läget Readout eller Autosend avslaget. Konfigurera om mastern och anslut den igen.
• Gul = Okänd
  Detta visar att ingen master svarade vid autodetekteringen. Detta kan ändå vara OK om t.ex bara en konverter eller en samlingsbox är ansluten. Appen kommer ändå att lyssna efter stämplingar från denna enhet.

Genom att trycka längst till höger på en rad i master-dialogen så kan följande funktioner nås:

Ominitiering

Gör om autodetekteringen av enheten. Kan t.ex. vara användbart på en gulmarkerad enhet om man i efterhand kopplat till en seriell master till en konverter.

Identifiera

Gör så att masterenheten piper och blinkar tre gånger.

Stäng av

Stänger av master-enheten.

Normal användning

På första (och enda) sidan i appen så listas alla stämplingar som tagits emot från kontrollen. På varje rad visas brickans nummer, kontrollens kodsiffra, tiden för stämplingen (enligt tiden i mastern) och sist en markering om stämplingen skickats iväg eller inte. Markeringen för en viss stämpling sätts inte förrän datat har skickats och även bekräftats att det finns lagrat hos ROC's webservice.

Precis ovanför listan med stämplingar syns det inställda namnet på ROC-enheten och efter det två siffror. Den första siffran (med röd bakgrund) visar hur många stämplingar som ligger i appen och väntar på att bli skickade. Den andra siffran (med grön bakgrund) visar hur många stämplingar som totalt har skickats iväg till ROC.

Överst i appen finns knapparna och menyn för att kontrollera ivägsändning av stämplingarna. Funktionerna som finns är, listat från vänster till höger och uppifrån o ner i menyn (vad som är knappar och vad som visas i menyn beror på hur stor skärm du har):

• Start/Stopp-knappen som startar och stoppar kommunikationen med ROC's webtjänst. När man tryckt på Start så visas en dialog där man väljer hur många timmar ROC-enheten ska vara aktiv. När tiden har passerat så stoppas kommunikationen automatiskt. Tiden som återstår går att se in notifieringen.
• Knapp/menyalt. SI-Mastrar för att öppna masterdialogen (samma som visas när en enhet anslutits).
• Knapp/menyalt. Hjälp för att visa denna hjälptext som du just läser.
• Knapp/menyalt. Inställningar för att öppna Inställningar.
• Menyalt. Stämplingar hos ROC öppnar en web browser med sidan för alla mottagna stämplingar för ROC-enheten.
• Menyalt. Rensa stämplingar tömmer alla stämplingar som finns i appen. Gör förslagsvis detta inför varje ny tävling.
• Menyalt. Avsluta som avslutar appen helt inklusive eventuellt pågående sänding/mottagning.

När en master är ansluten så visas en ikon längst upp i telefonens notifieringsfält. I notifieringen visas även hur många mastrar som är anslutna och hur länge till kommunikationen med ROC's webtjänst kommer vara aktiv. Genom att klicka på notifierigen så öppnas alltid appen igen.

Appens fönster behöver inte vara framme för att mottagning och sändning ska fungera. Så länge ikonen i notifieringsfältet syns så fungerar sändning och mottagning i bakgrunden. Telefonen kan då samtidigt användas till andra saker, t.ex. surfa på Internet eller ringa/ta emot ett samtal. Sändning och mottagning fungerar även när skärmen är släckt och låst.

Inställningar

• ROC namn
  Namnet på ROC-enheten som kommer att synas i listan i ROC's webtjänst.
• Intervall för att skicka stämplingar
  Ett tidsintervall mellan 10 sek till 5 min som avgör hur ofta appen ska skicka nya stämplingar till webtjänsten.
• MAC-adress
  En genererad MAC-adress som är unik för telefonen och identifierar ROC-enheten. Går inte att ändra och ska alltid bli samma på en viss telefon.
• Fallback baudrate
  Appen kommer alltid att först försöka auto-detektera korrekt baudrate för en enhet. Så länge en master är direkt ansluten till telefonen ska detta lyckas. Om t.ex. enbart en USB-till-serie-konverter ansluts eller en konverter + en samlingsbox så kommer auto-detekteringen att misslyckas (enheten blir gulmarkerad). I dessa fall så kommer baudraten att sättas till det konfigurerade värde som satts här.
• Feedback
  Kontaktuppgifter till mig och länkar för att hitta mer information kring användning av appen och ROC.
• Versionshistorik
  Beskrivning av vad som ändrats i olika versioner av appen.