Linux ja Windows XP Versio Päiväys Muokkaaja Kuvaus 0.2 16.2.2006 Mikko Halttunen Katselmoinin jälkeen 0.1 13.2.2006 Mikko Halttunen Alustava versio
Sisällysluettelo 1 Johdanto... 3 2 Simulaattorin asennus... 4 2.1 Laitteistovaatimukset... 4 2.2 Simulaattorin kääntäminen... 4 2.3 Simulaattorin tiedostot ja hakemistot... 5 2.4 Kirjastotiedostojen asennus... 6 2.4.1 Linux... 6 2.4.2 Windows... 6 2.5 Simulaattorin konfigurointi... 7 Yleiset asetukset:... 7 Ohjaavan tilan erikoisasetukset:... 8 2.6 Lokitiedosto... 8 3 Simulaattorin käyttö... 9 3.1 Linux... 9 3.1.1 Virheitä lähettävä tila:... 9 3.1.2 Virheitä lähettämätön tila:... 9 3.2 Windows... 9 3.2.1 Virheitä lähettävä tila:... 9 3.2.2 Virheitä lähettämätön tila:... 9 3.3 Käyttö:... 10
1 Johdanto Simulaattorin tehtävä on simuloida hälytintä. Simulaattori on Java -ohjelma, joka kommunikoi puhelimen kanssa sarjaportin välityksellä. Puhelin joko lähettää viestejä valppaalle satunnaisesti tai vastailee pelkästään valppaan viesteihin. Simulaattoria voidaan hallita tekstikäyttöliittymän avulla.
2 Simulaattorin asennus 2.1 Laitteistovaatimukset Simulaattori on tehty toimimaan Linux käyttöjärjestelmissä. Tämän lisäksi se toimii osittain myös Windows XP:llä. Lisäksi simulaattorin käyttöön tarvitaan tietokone, jossa on sarja tai USB -portti, tetra-puhelin, jossa on at-rajapinta, sekä kaapeli puhelimen ja tietokoneen välille. Ohjelman ajamista varten täytyy tietokoneella olla Javan 1.5 versio. Kääntämistä varten tarvitaan Apache Ant -ohjelmaa. 2.2 Simulaattorin kääntäminen Simulaattorin pystyy kääntämään valppaan juurihakemistosta löytyvällä simubuild.xml -tiedostolla komennolla: ant -buildfile simubuild.xml Skripti kääntää simulaattorin ja luo hakemiston simulator, johon skripti kopioi kaiken simulaattorin ajamiseen tarvittavan sisällön.
2.3 Simulaattorin tiedostot ja hakemistot Hakemistorakenteen tulisi näyttää seuraavalta: simulator/ simulator.jar SimulatorLog4j.properties simulator.properties javax.comm.properties simulator_map_usb_dev.sh start_simulator.bat start_simulator.sh Simulaattorin ohjelmakoodi Simulaattorin logituksen asetukset Simulaattorin yleiset asetukset Sarjayhteyden asetuksia (Tarvitaan linuxin asennuksessa) Skripti, jolla voi linuxissa tehdä /dev hakemistoon linkin USB-laitteesta sarjaportti-laitteeksi. Simulaattorin käynnistystiedosto Windowsissa Simulaattorin käynnistystiedosto Linuxissa simulator/lib/ junit3.8.1.jar liblinuxserialparallel.so Kirjastotiedosto Junit testejä varten Linuxin kirjasto puhelimen kanssa kommunikointiin log4j-1.2.9.jar Simulaattorin käyttämä kirjasto lokien tiedostoon kirjoittamiseen comm.jar RXTXcomm.jar rxtxserial.dll Linuxin puhelimen kanssa kommunikointiin Javasta käsin Windowsin kirjasto puhelimen kanssa kommunikointiin Javasta käsin. Windowsin kirjasto puhelimen kanssa kommunikointiin
2.4 Kirjastotiedostojen asennus 2.4.1 Linux Kopioi liblinuxserialparallel.so tiedosto lib hakemistosta hakemistoon %JAVA_HOME%/lib/i386/. Kyseisessä hakemistossa tulisi olla muitakin.so -tiedostoja. Hakemisto voisi olla esimerkiksi: /usr/lib/j2sdk1.5-sun/jre/lib/i386/ 2.4.2 Windows Windowsissa simulaattori käyttää rxtx -kirjastoa Sunin kirjaston sijaan. Tästä syystä Windowsissa täytyy kopioida rxtxserial.dll -tiedosto windows\system32 -hakemistoon.
2.5 Simulaattorin konfigurointi Simulaattorin käyttöasetukset löytyvät tiedostosta simulator.properties. Yleiset asetukset: Oletusarvo sarjaportille on /dev/ttys0. Tätä tulee käyttää silloin kun käyttöjärjestelmä on Linux ja USB -sarjakaapeli ei ole käytössä. Mahdolliset vaihtoehdot näytetään simulaattorin käynnistyksessä. Jos USB -kaapeli on käytössä, tulee portin olla /dev/ttys100. Windowsissa portin tulisi olla COM1 tai COM2. Mahdollisesti portit näytetään käyttäjälle simulaattorin käynnistyksen aikana <entry key="com.port">/dev/ttys0</entry> Simulaattorin puhelinnumero täytyy kirjoittaa alla olevalle riville kohtaan Simulaattorin_numero. Tätä tietoa käytetään lokitiedoston nimessä. <entry key="phonenumber.simulator">simulaattorin_numero</entry> Valppaan puhelinnumero täytyy kirjoittaa alla olevalle riville kohtaan Valppaan_numero. Muuten ohjelma ei tiedä mihin lähettää hälyytyksiä. <entry key="phonenumber.valpas">valppaan_numero</entry> Tämä rivi määrittää kuinka usein simulaattori tekee toimintoja. Tällaisia toimintoja ovat esimerkiksi vastaanotettujen viestien käsittely ja jos satunnaiset hälytykset ovat päällä, hälytysten lähettäminen. <entry key="simulator.activity.wait.time">10000</entry> Osoite, josta simulaattorin lokitiedoston asetukset luetaan. <entry key="simulator.log4j.properties.file">com/indagon/simulator/simulatorlog4j.prop erties</entry> Lokitiedoston päiväyksen muoto <entry key="simulator.log.date.time.pattern">hh:mm:ss/dd:mm:yy</entry> Yhteyden toiminnan tarkastamisen aika millisekunneissa. Jos puhelin ei vastaa määritellyssä ajassa, ilmoittaa simulaattori at-viasta lokitiedostoon. <entry key="connection.check.wait.time">60000</entry>
Ohjaavan tilan erikoisasetukset: Todennäköisyys satunnaisen hälytyksen lähettämiseen. Luku on prosenteissa. <entry key="propability.send.random.alarm.passive.state">0.1</entry> Todennäköisyys huollontarpeessa -viestin lähettämiselle. Luku prosenteissa. <entry key="propability.send.maintenance.message">10</entry> Todennäköisyys ei toleranssissa -viestin lähettämiseen. Luku prosenteissa. <entry key="propability.problem.not.in.tolerance">10</entry> Todennäköisyys viestin lähettämättä jättämiseen. Luku prosenteissa. <entry key="propability.skip.message.send">10</entry> 2.6 Lokitiedosto Vastaanotettujen viestien ja järjestelmäviestien tiedostoon kirjoittamisen hoitaa log4j niminen kirjasto. Tärkeimmät kohdat tiedostossa ovat: "log4j.rootlogger=info, stdout, file": Rivi kertoo, että kuinka paljon tietoa tiedostoon kirjoitetaan ohjelman toiminnasta INFO tai DEBUG tasoilla. INFO tasolla kirjoitetaan vain vastaanotetut ja lähetetyt viestit, sekä mahdolliset toimintavirheet. INFO -tason voi korvata DEBUG:illa, jolloin kirjataan kaikki ohjelman toiminnan aikana ilmenevät viestit.
3 Simulaattorin käyttö 3.1 Linux Jos käytetään USB -kaapelia, tulee tehdä symboliset linkit laitteesta /dev/ttyusb0 (olettaen, että laite on liitetty ensimmäiseen USB porttiin) laitteisiin /dev/ttys100 sekä /dev/ttys100 käyttäen valmista skriptiä simulator_map_usb_dev.sh tai kirjoittaen alla olevat käskyt konsoliin: ln -s /dev/ttyusb0 /dev/ttys100 ln -s /dev/ttyusb0 /dev/ttys100 Simulaattori käynnistetään Linuxissa start_simulator.sh -skriptillä. Lisää tietoa käynnistyksestä ja mahdolliset portit saa ajamalla start_simulator.sh -skriptin ilman argumentteja. start_simulator.sh 3.1.1 Virheitä lähettävä tila: Simulaattorin käynnistys virheitä lähettävään tilaan onnistuu alla olevalla komennolla: start_simulator.sh -p -s 3.1.2 Virheitä lähettämätön tila: Virheitä lähettämätön tila käynnistyy komennolla: start_simulator.sh -v -s 3.2 Windows Simulaattori ei toimi Windowsissa USB -kaapelilla. Simulaattori käynnistetään Windowsissa start_simulator.bat käynnistystiedostolla simulaattorin käännettäessä tehdystä hakemistosta. 3.2.1 Virheitä lähettävä tila: Simulaattorin käynnistys virheitä lähettävään tilaan onnistuu alla olevalla komennolla: start_simulator.bat -p -s 3.2.2 Virheitä lähettämätön tila: Virheitä lähettämätön tila käynnistyy komennolla: start_simulator.bat -v -s
3.3 Käyttö: Simulaattoria käytetään komentoriviltä. Käynnistyksen jälkeen simulaattori jää odottamaan viestejä valppaalta tai jos virheiden automaattinen lähetys on päällä, lähettelee simulaattori satunnaisesti viestejä. Virheitä lähettämättömässä tilassa simulaattori ei itse lähetä hälytyksiä valppaalle. Vastaanotetut ja lähetetyt virheet tulostetaan sekä lokitiedostoon että konsoliruudulle. Simulaattorilla voi lähettää kuitenkin hälytyksiä käyttöliittymän kautta kirjoittamalla sa, ss tai sn. Alla selitykset komennoille: Simulaattorin komennot: q sa ss sn h Sammuttaa simulaattorin Lähettää hälytyksen valppaalle Lähettää sensorihälytyksen valppaalle Lähettää ei toleranssissa viestin valppaalle Tulostaa pikaohjeet näytölle