WORKSWELL Wiris, User Manual

Page: 2 / 44

Contents
1. User Informa on 6
1.1 Typographic Conven ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2 Help and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3 Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4 Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2. Revision history 7
3. Overview 8
3.1 Basic Informa on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.2 Ac va ng the SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.3 Example Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.4 WIRIS IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.5 Ge ng Help and Sugges ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4. Communica on protocol descrip on 10
4.1 Commands - Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.1.1 Set commands delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.1.2 Get commands delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.3 Check connec on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.4 Get WIRIS serial number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.5 Get WIRIS ar cle number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.6 Get WIRIS version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.7 Get CPU temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.1.8 Get thermal camera temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.1.9 Get device temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.2 Commands - Ac va on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.2.1 Ac vate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.2.2 Is ac vated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.3 Commands - Ethernet Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.3.1 Set Ethernet Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.3.2 Get Ethernet Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.4 GPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.1 Set thermo range to high . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.5 Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.5.1 Get range mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.5.2 Set range mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.5.3 Get manual range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.5.4 Set manual range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.5.5 Get span range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.5.6 Set span range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.5.7 Get environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.5.8 Get list of environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.5.9 Set environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1