WORKSWELL WIRIS PRO User manual

WORKSWELL
WIRIS Ethernet Stream
SDK
USER MANUAL
FW Version: 1.1.1
Release date: 11th September, 2019
Revision : 1.1 EN

Contents
1. User Informaon 6
1.1 TypographicConvenons...................................... 6
1.2 HelpandSupport .......................................... 6
1.3 Updates............................................... 6
1.4 Firmware .............................................. 6
2. Revision history 7
3. Overview 8
3.1 BasicInformaon .......................................... 8
3.2 AcvangtheSDK.......................................... 8
3.3 ExampleLibrary........................................... 9
3.4 WIRISIPAddress .......................................... 9
3.5 GengHelpandSuggesons.................................... 9
4. Communicaon protocol descripon 10
4.1 Commands-Basic.......................................... 10
4.1.1 Setcommandsdelimiter .................................. 10
4.1.2 Getcommandsdelimiter.................................. 11
4.1.3 Checkconnecon...................................... 11
4.1.4 GetWIRISserialnumber .................................. 11
4.1.5 GetWIRISarclenumber.................................. 11
4.1.6 GetWIRISversion...................................... 11
4.1.7 GetCPUtemperature.................................... 12
4.1.8 Get thermal camera temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.1.9 Getdevicetemperature .................................. 12
4.2 Commands-Acvaon....................................... 12
4.2.1 Acvate........................................... 12
4.2.2 Isacvated ......................................... 13
4.3 Commands-EthernetMode .................................... 13
4.3.1 SetEthernetMode ..................................... 13
4.3.2 GetEthernetMode..................................... 13
4.4 GPS ................................................. 14
4.4.1 Setthermorangetohigh.................................. 14
4.5 Range ................................................ 14
4.5.1 Getrangemode ...................................... 14
4.5.2 Setrangemode....................................... 14
4.5.3 Getmanualrange...................................... 15
4.5.4 Setmanualrange...................................... 15
4.5.5 Getspanrange ....................................... 15
4.5.6 Setspanrange ....................................... 15
4.5.7 Getenvironment ...................................... 15
4.5.8 Getlistofenvironments .................................. 16
4.5.9 Setenvironment ...................................... 16
1

4.6 WWSThermalParameters ..................................... 16
4.6.1 Getmestabilizaon.................................... 16
4.6.2 Setmestabilizaon.................................... 16
4.6.3 Gethotrejecon ...................................... 17
4.6.4 Sethotrejecon ...................................... 17
4.6.5 Getcoldrejecon...................................... 17
4.6.6 Setcoldrejecon...................................... 17
4.7 Zoom ................................................ 17
4.7.1 Getthermalcamerazoom ................................. 17
4.7.2 Get list of thermal camera zooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.7.3 Set thermal camera zoom index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.7.4 Getvisiblecamerazoom .................................. 18
4.7.5 Get list of visible camera zooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.7.6 Set visible camera zoom index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.8 Palees of thermal video stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.8.1 Getpalee ......................................... 19
4.8.2 Getpaleelist ....................................... 19
4.8.3 Setpalee ......................................... 19
4.9 Captureandrecord ......................................... 20
4.9.1 Capture........................................... 20
4.9.2 Iscapturing......................................... 20
4.9.3 Recordingstart ....................................... 20
4.9.4 Recordingfinish....................................... 20
4.9.5 Isrecording......................................... 21
4.10Alarms................................................ 21
4.10.1 Getalarmmode ...................................... 21
4.10.2 Setalarmmode....................................... 21
4.10.3 Getalarmvalues ...................................... 21
4.10.4 Setalarmvalues ...................................... 21
4.10.5 Getalarmcolors ...................................... 22
4.10.6 Setalarmcolors....................................... 22
4.11Thermalcamera........................................... 22
4.11.1 Getemissivity........................................ 22
4.11.2 Setemissivity........................................ 22
4.11.3 Getshuerperiod ..................................... 23
4.11.4 Setshuerperiod ..................................... 23
4.11.5 Get synchronous shuer sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.11.6 Set synchronous shuer sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.11.7 Perform thermal camera shuer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.11.8 Get seconds to next thermal camera shuer . . . . . . . . . . . . . . . . . . . . . . . 24
4.11.9 Get seconds from last thermal camera shuer . . . . . . . . . . . . . . . . . . . . . . 24
4.12Imageandvideosengs ...................................... 24
4.12.1 Get radiometric JPEG image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.12.2 Get radiometric TIFF image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.12.3 Get super-resoluon image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.12.4 Getvisibleimagesengs.................................. 25
2

4.12.5 Get radiometric video sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.12.6 Getvisiblevideosengs.................................. 25
4.12.7 Set radiometric JPEG image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.12.8 Set radiometric TIFF image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.12.9 Set super-resoluon image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.12.10 Set visible image sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.12.11 Set radiometric video sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.12.12 Set visible video sengs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.12.13Getimagelocaon ..................................... 27
4.12.14Setimagelocaon ..................................... 27
4.13DateandTime............................................ 28
4.13.1 Getdateandme ..................................... 28
4.13.2 Setdateandme...................................... 28
4.14Memory............................................... 28
4.14.1 Getmemorystatus..................................... 28
4.14.2 Getmemorysize ...................................... 28
4.14.3 Getmemoryfree...................................... 29
4.14.4 Getcapturedimages .................................... 29
4.14.5 Get recorded thermal video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.14.6 Get recorded visible video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.15Stream................................................ 30
4.15.1 Get thermal camera resoluon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.15.2 Getthermalextremes ................................... 30
4.15.3 Getpaleevalues ..................................... 30
4.16System................................................ 31
4.16.1 Defaultsengs....................................... 31
4.16.2 Shutdown ......................................... 31
4.16.3 Reboot ........................................... 31
5. RTSP Video Server 32
5.1 GStreamer.............................................. 32
5.2 VLC ................................................. 32
5.3 FFmpeg ............................................... 35
6. FTP data access 37
6.1 FTPconnecon ........................................... 37
6.2 Restriconsandwarnings...................................... 37
6.3 Soware............................................... 37
7. WIRIS Ethernet Stream SDK GUI Applicaon 39
7.1 Introducon............................................. 39
7.1.1 Installaon ......................................... 39
7.1.2 Firstlaunch ......................................... 39
7.1.3 Startupdefaultsengs................................... 40
7.2 MainWindow............................................ 40
7.3 Mainmenu ............................................. 40
3

7.3.1 Range............................................ 40
7.3.2 Funcons.......................................... 41
7.3.3 Palees........................................... 41
7.3.4 Capture........................................... 41
7.3.5 Measure .......................................... 41
7.3.6 Advanced.......................................... 42
7.4 QuickMenu............................................. 42
7.5 InspeconPanel........................................... 42
7.6 SecondaryStreamwindow ..................................... 43
7.7 WIRISSecurity............................................ 43
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
4

1. USER INFORMATION
1 User Informaon
1.1 Typographic Convenons
Following typographic convenons are used in this User Manual:
UPPER CASE is used for the names of keys, buons and menu items
COURIER is used for filenames and paths
Italic is used for important informaon and document names
bold is used for the links to other secons, for funcon names or Internet sites
1.2 Help and Support
For technical quesons that were not answered in this User Manual feel free to contact your dealer or visit the
product website at www.drone-thermal-camera.com, or send an email on [e-mail].
1.3 Updates
The primary aim of Workswell s.r.o. company is to supply their products in a way that meets the current needs
of its users and at the same me to remove all the weaknesses that were found in their use as quickly possible.
For this reason, Workswell s.r.o. regularly releases updates for all their products.
Visit hps://www.workswell-thermal-camera.com/firmware-update/ to download the latest firmware release.
The update process itself is described in a later secon.
1.4 Firmware
Firmware is the „internal“ control program of the device. From the user’s point of view, only the official firmware
released by Workswell s.r.o. company can be used for update of the device.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
5

2. REVISION HISTORY
2 Revision history
1.0
Inial release
1.1
Added shuer sengs
Added alarm color sengs
Added Hot and Cold Rejecon for WWS
New chapter for GUI Applicaon
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
6

3. OVERVIEW
3 Overview
This chapter includes basic informaon about the WIRIS Ethernet SDK.
3.1 Basic Informaon
Ethernet SDK is intended to stream video from WIRIS device and to control it over Ethernet connecon. It re-
places the HDMI output and RC transceiver input.
The SDK is currently compable with two models of WIRIS:
WIRIS PRO (WWP)
WIRIS SECURITY (WWS)
Differences between models will be noted.
Figure 3.1 – Supported devices.
The WIRIS runs a TCP/IP server for the control. It can be controlled with simple text commands. The opened
server is similar to telnet protocol and can be used with telnet terminal soware.
The WIRIS also runs RTSP server for streaming the visible and thermal video. it can be viewed with GStreamer,
FFmpeg, VLC or other soware capable of opening RTSP streams.
Lastly, the FTP server is opened for data management.
Please note that the simultaneous usage of HDMI output, keyboard and RC controller with the Ethernet SDK is
not possible.
3.2 Acvang the SDK
The SDK in the WIRIS device needs to be acvated. It is not free of charge. Please contact the sales support for
more informaon.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
7

3. OVERVIEW
It can be acvated with license code using TCP/IP server command.
3.3 Example Library
We have prepared simple open-source example library for the TCP/IP communicaon.
It is cross-plaorm (Linux, Windows or Mac) and uses the Boost ASIO library.
Current version of the example library can be downloaded from the Workswell website.
3.4 WIRIS IP Address
The default WIRIS IP Address is 10.0.0.230 and the default mask is 255.255.255.0.
These values can be changed in Advanced System Menu.
3.5 Geng Help and Suggesons
The WIRIS Ethernet SDK was created as stable and robust as possible. Sll, if you find any bugs, inconveniences
or if you have any suggesons for improvement, please contact us at [email protected].
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
8

4. COMMUNICATION PROTOCOL DESCRIPTION
4 Communicaon protocol descripon
This chapter contains informaon about the TCP/IP communicaon protocol and commands.
The server descripon:
Port 2240
Text-based communicaon protocol
Can be connected to with telnet soware
Each command received by the server is at least acknowledged
The commands are case sensive, the server responses are always in upper case
All temperatures are in degrees Celsius
The most common responses are OK in case of success and ERR in case of error. When parameters are given or
returned, they are separated by one space.
Parameter Value
Protocol TCP
Port number 2240
Table 4.1 – Protocol parameters
4.1 Commands - Basic
Hereby the commands for controlling the WIRIS device follow. The basic commands can be used without the
Ethernet SDK acvaon.
4.1.1 Set commands delimiter
Set the delimiter for command messages. This delimiter is used for detecng the end of a command. Default
value is LINE for the ’\n’ character. It can be changed to NULL for the ’\0’ character.
The LINE is used for telnet, the NULL is beer for soware development.
Command
•SDLM NULL
Answer
•OK
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.1 EN, 11th Sept, 2019
All pictures are only for illustraon.
Real values may vary.
9