Miten valmistajien pitäisi dokumentoida skaalaus, etumerkilliset arvot ja poikkeukset
Hyvän Modbus-dokumentaation pitää kertoa käyttäjälle, miten raakadata muutetaan oikeaksi arvoksi. Kolme asiaa ovat erityisen tärkeitä: skaalaus, etumerkilliset arvot ja poikkeukset.
Skaalaus
Moni laite ei tallenna arvoja täsmälleen siinä muodossa kuin ne näytetään käyttäjälle. Sen sijaan laite tallentaa raakaarvon, joka täytyy skaalata.
Esimerkki:
- raakaarvo 253
- todellinen lämpötila 25.3 °C
- jaa 10:llä
Manuaalin pitäisi kertoa tämä selvästi. Älä odota, että käyttäjä arvaa.
Jokaisesta skaalatusta arvosta pitäisi dokumentoida:
- raakamuoto
- skaalaussääntö
- lopullinen yksikkö
- yksi esimerkki
Etumerkilliset arvot
Jotkin arvot voivat mennä nollan alapuolelle. Jos näin voi tapahtua, manuaalin täytyy kertoa onko rekisteri signed.
Ilman tätä negatiivinen arvo voidaan lukea suurena positiivisena numerona.
Jokaisesta signed-arvosta pitäisi dokumentoida:
- signed vai unsigned
- arvoalue
- yksi esimerkki negatiivisella arvolla, jos se on mahdollista
Poikkeukset
Kaikki pyynnöt eivät onnistu. Käyttäjän täytyy tietää, miten laite käyttäytyy virhetilanteissa.
Dokumentoi:
- tukemattomat function codet
- virheelliset rekisteripyynnöt
- kirjoitusyritykset vain-luku-rekistereihin
- Modbus-poikkeuskoodit jos niitä käytetään
- mahdolliset erityiset vikaarvot jos niitä palautetaan
- rajoitukset laitteessa esim. voi lukea vain 100ms välein
Miksi tämä on tärkeää
Jos skaalaus puuttuu, arvot näyttävät vääriltä.
Jos signed-muoto puuttuu, negatiiviset arvot näkyvät väärin.
Jos poikkeuskäytös kuvaus puuttuu, tukityö lisääntyy koska käyttäjä ei tiedä onko vika pyynnössä vai laitteessa.
Lopuksi
Hyvän manuaalin pitäisi kertoa käyttäjälle täsmälleen miten arvo luetaan, miten se tulkitaan ja mitä tapahtuu jos jokin menee pieleen.
Konsultointi
Minut voi palkata auttamaan Modbus-laitteiden dokumentoinnissa, testauksessa ja vianetsinnässä.