Skillnad mellan versioner av "VoxAlarm"

Från DataPolarna
Hoppa till: navigering, sök
(→‎Redigera källa)
 
(17 mellanliggande versioner av samma användare visas inte)
Rad 6: Rad 6:
 
== Hem ==
 
== Hem ==
  
−
På startsidan visas källor och mål.
+
Startsidan visar källor och mål.<br>
−
En källa är en larmingång, det finns två typer av källor;
+
[[Fil:Voxalarm_hem.png|600px]]
 +
 
 +
'''Källa'''<br>
 +
En källa är en larmingång, det finns två typer av källor.
  
 
'''Serial''' är en seriell tcp/ip larmskrivare och konfigureras med källans namn, larmradernas uppbyggnad samt vilken tcp port som skrivaren lyssnar på.<br>
 
'''Serial''' är en seriell tcp/ip larmskrivare och konfigureras med källans namn, larmradernas uppbyggnad samt vilken tcp port som skrivaren lyssnar på.<br>
−
För att larmer ska skrivas, konfigureras en seriell larmskrivare i kontrollsystemet som ska övervakas. Skrivarens namn är VoxAlarm serverns namn och angiven port.
+
För att larmer ska skrivas, konfigureras en seriell larmskrivare i kontrollsystemet som ska övervakas. Skrivarens namn är VoxAlarmserverns namn och angiven port.
  
−
'''Rest''' är en rest api larmmottagare och konfigureras med källans namn.
+
'''Rest''' är en rest api larmmottagare och konfigureras med källans namn.<br>
 
https://<voxalarm server>/api/alarm/trigger
 
https://<voxalarm server>/api/alarm/trigger
 
<nowiki>{
 
<nowiki>{
Rad 26: Rad 29:
 
''Section'', larmets sektion.<br>
 
''Section'', larmets sektion.<br>
 
''Priority'', larmets prioritet, 1-10.
 
''Priority'', larmets prioritet, 1-10.
 +
 +
 +
'''Mål'''<br>
 +
Ett mål är en larmutgång, det finns en typ av mål.
 +
 +
'''Radio''' är en larmutgång till en kommunikationsradio och konfigureras med målets namn, minsta radiotystnad, eventuellt larm vid "för många larmer".<br>
 +
När en ny radiomodul ansluts dyker den upp som "Okänd enhet".<br>
 +
En enhet kopplar sig till servern genom att ansluta ett USB minne med filen voxalarm.config innehållande;<br>
 +
<nowiki>{
 +
  "serverAddress": "https://<voxalarm server>/"
 +
}</nowiki><br>
 +
 +
 +
== Redigera källa ==
 +
 +
[[Fil:Voxalarm_kalledit.png|600px]]
 +
 +
En källa har följande fält som är redigerbara:<br>
 +
'''Namn''' - Källans namn.<br>
 +
'''Typ''' - Typ av källa, Serial är en seriell tcp/ip larmskrivare, Rest är en rest api larmmottagare.<br>
 +
'''Beskrivning''' - Beskrivning av källan.<br>
 +
 +
Under "Konfiguration" konfigureras tolkningen av larmrader för källtypen Serial.<br>
 +
'''Larmkod''' - Larmets identifiering, anges genom att bygga ihop en sträng med positioner och text. 29-59, 72-87 innebär position 29-59, plus ett mellanslag, plus position 72-87.<br>
 +
'''Beskrivning''' - Beskrivning av larmet, anges på samma sätt som Larmkod.<br>
 +
'''Tidsstämpel''' - Position där tidsstämpel börjar.<br>
 +
'''Tidsstämpelformat''' - Format på tidsstämpel, tex yyyy-mm-dd hh:nn:ss.<br>
 +
'''Prio''' - Larmets prioritet, anges på samma sätt som Larmkod.<br>
 +
'''Sektion''' - Larmets sektion, anges på samma sätt som Larmkod.<br>
 +
'''Aktiv''' - Position där aktiv text börjar.<br>
 +
'''Aktivkod''' - Texten som identifierar aktivt larm.<br>
 +
'''Upphört''' - Position där upphört text börjar.<br>
 +
'''Upphörtkod''' - Texten som identifierar upphöts larm.<br>
 +
'''Bekräfta''' - Position där bekräfta text börjar.<br>
 +
'''Bekräftakod''' - Texten som identifierar bekräfta larm.<br>
 +
'''Starttecken''' - Hex kod för start av rad. Tex 0A.<br>
 +
'''Starttecken''' - Hex kod för slut av rad. Tex 0D.<br>
 +
'''Maxlängd''' - Maxlängd på rad, om raden är längre en angiven maxlängd klipps början av raden bort.<br>
 +
'''Ignorera''' - Position där inorera text börjar.<br>
 +
'''Ignorerakod''' - Texten som identifierar ignorering av larm.<br>
 +
'''Teckenkodning''' - Teckenkodning, enda implementerade värde är CP437, där översättning av åäöÅÄÖ sker för CP437.<br>
 +
'''Port''' - Port som larmskrivaren lyssnar på.<br>
 +
 +
Under "Köade larm" visas larm som ligger i kö att spelas från källan.<br>
 +
Under "Senast spelade larm" visas senaste larm som spelats från källan.<br>
 +
Under "Log" visas senaste mottagna larmrader.<br>
 +
 +
Knappen "Start" startar larmskrivaren.<br>
 +
Knappen "Stop" stoppar larmskrivaren.<br>
 +
Knappen "Ta bort" tar bort källan.<br>
 +
 +
== Redigera mål ==
 +
 +
[[Fil:Voxalarm_maledit.png|800px]]
 +
 +
Ett mål har följande fält som är redigerbara:<br>
 +
'''Namn''' - Målets namn.<br>
 +
'''Minsta radiotystnad innan larm spelas''' - Minsta tid som radion varit ledig innan larm spelas.<br>
 +
'''Fördröj "Push To Talk"''' - Fördröjning av nycklingen av radion, används för att minimera tyst tid innan ljud hörs i radion.<br>
 +
'''Fördröj uppspelning''' - Den tid som ett larm köas innan det får spelas upp.<br>
 +
'''Aktiv''' - Anger om målet är aktivt eller ej.<br>
 +
'''Uppmärksamhetsljud''' - Ljud som spelas innan larm för uppmärksamhet.<br>
 +
'''Uppehåll vid många larm''' - Antal larm anger hur många larm som ska vara köade för uppehåll ska aktiveras. Minuter anger hur många minuter uppehållet varar. Ett larm kopplat till händelsen kan skapas/redigeras.<br>
 +
'''Ljudvolym''' - Ljudvolym.<br>
 +
'''Ljudkälla''' - Val av ljudkälla, analog används för 3,5mm jacket.<br>
 +
 +
Under "Köade larm" visas larm som ligger i kö att spelas på målenheten.<br>
 +
Under "Senast spelade larm" visas senaste larm som spelats på målenheten.<br>
 +
 +
Knappen "Avsluta uppeåll", avslutar aktivt uppehåll med omedelbar verkan.<br>
 +
Knappen "Hitta", aktiverar hitta funktionen under 1 minut, den gröna dioden blinkar T_T___.<br>
 +
Knappen "Ta bort", raderar målet.<br>
 +
Knappen "Starta om", startar om målenheten.<br>
 +
 +
Övriga funktioner på den gröna dioden, T = tänd, _ = släckt<br>
 +
T_____ Radio ledig<br>
 +
T_T___ Hitta aktiverad<br>
 +
T_T_T_ Radion upptagen<br>
 +
TTTTTT PTT aktiv<br>
 +
 +
== Larm ==
 +
 +
Larmsidan visar konfigurerade larm.<br>
 +
Larm kan filtreras genom på status och genom att söka på larm koder.<br>
 +
 +
[[Fil:Voxalarm_larm.png|600px]]
 +
 +
Ett larm har en eller flera källor som matchas mot inkomna larms källor.<br>
 +
Saknas källa matchas larmet mot inkomna larm oavsett källa.<br>
 +
 +
Ett larm kan ha ett eller flera mål.<br>
 +
 +
 +
== Redigera larm ==
 +
 +
[[Fil:Voxalarm_larmedit.png|800px]]
 +
 +
Ett larm har följande fält som är redigerbara:<br>
 +
'''Namn''' - Larmets nyckel som identifierar larmet i kombination med eventuell källa som larmet aktiverats via.<br>
 +
'''Ljudfil''' - Ljud som kopplas till larmet, och är det ljud som tex spelas upp i radio när ett larm aktiverats.<br>
 +
'''Beskrivning''' - Beskrivning av larmet.<br>
 +
'''Prio''' - Standard prioritet av larmet, standard prio används om inte mottaget larm har prio angiven.<br>
 +
'''Tidsblockering''' - Hur länge larmet är tidblockerat, när ett larm är tidsblockerat ignoreras larmet om det inträffar igen.<br>
 +
'''Huvudlarm''' - Om ett huvud larm är vald så tidsblockerar huvudlarmet även detta larm.<br>
 +
'''Giltig i''' - Den längsta tid som larmet köas. Om larmet inte skickats ut inom giltighetstiden raderas larmet.<br>
 +
'''Repeteringar''' - Antal repeteringar av larmet.<br>
 +
'''Tid mellan repetering''' - Den tid som systemet väntar innan larmet repeteras.<br>
 +
'''Källor''' - De källor som larmet matchas i kombination med larmets namn. Om ingen källa angivets matchas larmet oavsett källa.<br>
 +
'''Mål''' - De mål som larmet ska skickas till.<br>
 +
'''Sektion''' - Standard sektion för larmet, standard sektion används om inte mottaget larm har sektion angiven.<br>
 +
'''Status''' -
 +
*''Ny'' larmet är nytt och användaren inte tagit ställning till om larmet ska vara aktivt eller inaktivt.<br>
 +
*''Aktiv'' larmet är aktivt och kommer matchas mot inkomna larm.<br>
 +
*''Mall'' larmet är en mall, ominkommet larm matchar mallen läggs ett nytt larm med status ny in i larmlistan.<br>
 +
*''Inaktiv'' larmät är inaktiverat.<br>
 +
 +
'''Uppmärksamhetsljud''' - Val om uppmärksamhetsljud ska spelas för detta larm, även om det inte är valt för målet.<br>
 +
 +
Under "Tidsblockerade målenheter" visas mål som är tidsblockerade för larmet.<br>
 +
 +
Knappen "Spela", simulerar att larmet har inkommit.<br>
 +
Knappen "Ta bort", raderar larmkonfigurationen.<br>
 +
 +
== Kontakt/Support ==
 +
 +
<strong>Telefon</strong><br>
 +
Växel: +46 (0)910 120 90<br><br>
 +
<strong>Epost</strong><br>
 +
Information: mailto:info@datapolarna.se<br>
 +
Support: mailto:support@datapolarna.se<br><br>
 +
<strong>Adress</strong><br>
 +
DataPolarna AB<br>
 +
Storåkersgatan 22, 931 45 Skellefteå<br>
 +
Besöksadress: Timotejvägen 39<br>

Nuvarande version från 12 april 2019 kl. 11.34

Inloggning

Ej implementerat


Hem

Startsidan visar källor och mål.
Voxalarm hem.png

Källa
En källa är en larmingång, det finns två typer av källor.

Serial är en seriell tcp/ip larmskrivare och konfigureras med källans namn, larmradernas uppbyggnad samt vilken tcp port som skrivaren lyssnar på.
För att larmer ska skrivas, konfigureras en seriell larmskrivare i kontrollsystemet som ska övervakas. Skrivarens namn är VoxAlarmserverns namn och angiven port.

Rest är en rest api larmmottagare och konfigureras med källans namn.
https://<voxalarm server>/api/alarm/trigger { "InputDeviceName": "", "AlarmKey": "", "Description": "", "Section": "", "Priority": 10 }
InputDeviceName, ange källans namn.
AlarmKey, nyckeln till det larm som ska aktiveras.
Description, beskrivning av larmer.
Section, larmets sektion.
Priority, larmets prioritet, 1-10.


Mål
Ett mål är en larmutgång, det finns en typ av mål.

Radio är en larmutgång till en kommunikationsradio och konfigureras med målets namn, minsta radiotystnad, eventuellt larm vid "för många larmer".
När en ny radiomodul ansluts dyker den upp som "Okänd enhet".
En enhet kopplar sig till servern genom att ansluta ett USB minne med filen voxalarm.config innehållande;
{ "serverAddress": "https://<voxalarm server>/" }


Redigera källa

Voxalarm kalledit.png

En källa har följande fält som är redigerbara:
Namn - Källans namn.
Typ - Typ av källa, Serial är en seriell tcp/ip larmskrivare, Rest är en rest api larmmottagare.
Beskrivning - Beskrivning av källan.

Under "Konfiguration" konfigureras tolkningen av larmrader för källtypen Serial.
Larmkod - Larmets identifiering, anges genom att bygga ihop en sträng med positioner och text. 29-59, 72-87 innebär position 29-59, plus ett mellanslag, plus position 72-87.
Beskrivning - Beskrivning av larmet, anges på samma sätt som Larmkod.
Tidsstämpel - Position där tidsstämpel börjar.
Tidsstämpelformat - Format på tidsstämpel, tex yyyy-mm-dd hh:nn:ss.
Prio - Larmets prioritet, anges på samma sätt som Larmkod.
Sektion - Larmets sektion, anges på samma sätt som Larmkod.
Aktiv - Position där aktiv text börjar.
Aktivkod - Texten som identifierar aktivt larm.
Upphört - Position där upphört text börjar.
Upphörtkod - Texten som identifierar upphöts larm.
Bekräfta - Position där bekräfta text börjar.
Bekräftakod - Texten som identifierar bekräfta larm.
Starttecken - Hex kod för start av rad. Tex 0A.
Starttecken - Hex kod för slut av rad. Tex 0D.
Maxlängd - Maxlängd på rad, om raden är längre en angiven maxlängd klipps början av raden bort.
Ignorera - Position där inorera text börjar.
Ignorerakod - Texten som identifierar ignorering av larm.
Teckenkodning - Teckenkodning, enda implementerade värde är CP437, där översättning av åäöÅÄÖ sker för CP437.
Port - Port som larmskrivaren lyssnar på.

Under "Köade larm" visas larm som ligger i kö att spelas från källan.
Under "Senast spelade larm" visas senaste larm som spelats från källan.
Under "Log" visas senaste mottagna larmrader.

Knappen "Start" startar larmskrivaren.
Knappen "Stop" stoppar larmskrivaren.
Knappen "Ta bort" tar bort källan.

Redigera mål

Voxalarm maledit.png

Ett mål har följande fält som är redigerbara:
Namn - Målets namn.
Minsta radiotystnad innan larm spelas - Minsta tid som radion varit ledig innan larm spelas.
Fördröj "Push To Talk" - Fördröjning av nycklingen av radion, används för att minimera tyst tid innan ljud hörs i radion.
Fördröj uppspelning - Den tid som ett larm köas innan det får spelas upp.
Aktiv - Anger om målet är aktivt eller ej.
Uppmärksamhetsljud - Ljud som spelas innan larm för uppmärksamhet.
Uppehåll vid många larm - Antal larm anger hur många larm som ska vara köade för uppehåll ska aktiveras. Minuter anger hur många minuter uppehållet varar. Ett larm kopplat till händelsen kan skapas/redigeras.
Ljudvolym - Ljudvolym.
Ljudkälla - Val av ljudkälla, analog används för 3,5mm jacket.

Under "Köade larm" visas larm som ligger i kö att spelas på målenheten.
Under "Senast spelade larm" visas senaste larm som spelats på målenheten.

Knappen "Avsluta uppeåll", avslutar aktivt uppehåll med omedelbar verkan.
Knappen "Hitta", aktiverar hitta funktionen under 1 minut, den gröna dioden blinkar T_T___.
Knappen "Ta bort", raderar målet.
Knappen "Starta om", startar om målenheten.

Övriga funktioner på den gröna dioden, T = tänd, _ = släckt
T_____ Radio ledig
T_T___ Hitta aktiverad
T_T_T_ Radion upptagen
TTTTTT PTT aktiv

Larm

Larmsidan visar konfigurerade larm.
Larm kan filtreras genom på status och genom att söka på larm koder.

Voxalarm larm.png

Ett larm har en eller flera källor som matchas mot inkomna larms källor.
Saknas källa matchas larmet mot inkomna larm oavsett källa.

Ett larm kan ha ett eller flera mål.


Redigera larm

Voxalarm larmedit.png

Ett larm har följande fält som är redigerbara:
Namn - Larmets nyckel som identifierar larmet i kombination med eventuell källa som larmet aktiverats via.
Ljudfil - Ljud som kopplas till larmet, och är det ljud som tex spelas upp i radio när ett larm aktiverats.
Beskrivning - Beskrivning av larmet.
Prio - Standard prioritet av larmet, standard prio används om inte mottaget larm har prio angiven.
Tidsblockering - Hur länge larmet är tidblockerat, när ett larm är tidsblockerat ignoreras larmet om det inträffar igen.
Huvudlarm - Om ett huvud larm är vald så tidsblockerar huvudlarmet även detta larm.
Giltig i - Den längsta tid som larmet köas. Om larmet inte skickats ut inom giltighetstiden raderas larmet.
Repeteringar - Antal repeteringar av larmet.
Tid mellan repetering - Den tid som systemet väntar innan larmet repeteras.
Källor - De källor som larmet matchas i kombination med larmets namn. Om ingen källa angivets matchas larmet oavsett källa.
Mål - De mål som larmet ska skickas till.
Sektion - Standard sektion för larmet, standard sektion används om inte mottaget larm har sektion angiven.
Status -

  • Ny larmet är nytt och användaren inte tagit ställning till om larmet ska vara aktivt eller inaktivt.
  • Aktiv larmet är aktivt och kommer matchas mot inkomna larm.
  • Mall larmet är en mall, ominkommet larm matchar mallen läggs ett nytt larm med status ny in i larmlistan.
  • Inaktiv larmät är inaktiverat.

Uppmärksamhetsljud - Val om uppmärksamhetsljud ska spelas för detta larm, även om det inte är valt för målet.

Under "Tidsblockerade målenheter" visas mål som är tidsblockerade för larmet.

Knappen "Spela", simulerar att larmet har inkommit.
Knappen "Ta bort", raderar larmkonfigurationen.

Kontakt/Support

Telefon
Växel: +46 (0)910 120 90

Epost
Information: mailto:info@datapolarna.se
Support: mailto:support@datapolarna.se

Adress
DataPolarna AB
Storåkersgatan 22, 931 45 Skellefteå
Besöksadress: Timotejvägen 39

Hämtad från "https://wiki.datapolarna.se/index.php?title=VoxAlarm&oldid=3457"