WORKSWELL WIRIS Stream SDK

USER MANUAL

FW Version: 1.1.1

Release date: 11th September, 2019

Revision : 1.1 EN Contents

1. User Informaon 6 1.1 Typographic Convenons ...... 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 Informaon ...... 8 3.2 Acvang the SDK ...... 8 3.3 Example Library ...... 9 3.4 WIRIS IP Address ...... 9 3.5 Geng Help and Suggesons ...... 9

4. Communicaon protocol descripon 10 4.1 Commands - Basic ...... 10 4.1.1 Set commands delimiter ...... 10 4.1.2 Get commands delimiter ...... 11 4.1.3 Check connecon ...... 11 4.1.4 Get WIRIS serial number ...... 11 4.1.5 Get WIRIS arcle 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 - Acvaon ...... 12 4.2.1 Acvate ...... 12 4.2.2 Is acvated ...... 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 4.6 WWS Thermal Parameters ...... 16 4.6.1 Get me stabilizaon ...... 16 4.6.2 Set me stabilizaon ...... 16 4.6.3 Get hot rejecon ...... 17 4.6.4 Set hot rejecon ...... 17 4.6.5 Get cold rejecon ...... 17 4.6.6 Set cold rejecon ...... 17 4.7 Zoom ...... 17 4.7.1 Get thermal camera zoom ...... 17 4.7.2 Get list of thermal camera zooms ...... 18 4.7.3 Set thermal camera zoom index ...... 18 4.7.4 Get visible camera zoom ...... 18 4.7.5 Get list of visible camera zooms ...... 18 4.7.6 Set visible camera zoom index ...... 19 4.8 Palees of thermal video stream ...... 19 4.8.1 Get palee ...... 19 4.8.2 Get palee list ...... 19 4.8.3 Set palee ...... 19 4.9 Capture and record ...... 20 4.9.1 Capture ...... 20 4.9.2 Is capturing ...... 20 4.9.3 Recording start ...... 20 4.9.4 Recording finish ...... 20 4.9.5 Is recording ...... 21 4.10 Alarms ...... 21 4.10.1 Get alarm mode ...... 21 4.10.2 Set alarm mode ...... 21 4.10.3 Get alarm values ...... 21 4.10.4 Set alarm values ...... 21 4.10.5 Get alarm colors ...... 22 4.10.6 Set alarm colors ...... 22 4.11 Thermal camera ...... 22 4.11.1 Get emissivity ...... 22 4.11.2 Set emissivity ...... 22 4.11.3 Get shuer period ...... 23 4.11.4 Set shuer period ...... 23 4.11.5 Get synchronous shuer sengs ...... 23 4.11.6 Set synchronous shuer sengs ...... 23 4.11.7 Perform thermal camera shuer ...... 24 4.11.8 Get seconds to next thermal camera shuer ...... 24 4.11.9 Get seconds from last thermal camera shuer ...... 24 4.12 Image and video sengs ...... 24 4.12.1 Get radiometric JPEG image sengs ...... 24 4.12.2 Get radiometric TIFF image sengs ...... 25 4.12.3 Get super-resoluon image sengs ...... 25 4.12.4 Get visible image sengs ...... 25

2 4.12.5 Get radiometric video sengs ...... 25 4.12.6 Get visible video sengs ...... 25 4.12.7 Set radiometric JPEG image sengs ...... 26 4.12.8 Set radiometric TIFF image sengs ...... 26 4.12.9 Set super-resoluon image sengs ...... 26 4.12.10 Set visible image sengs ...... 26 4.12.11 Set radiometric video sengs ...... 27 4.12.12 Set visible video sengs ...... 27 4.12.13 Get image locaon ...... 27 4.12.14 Set image locaon ...... 27 4.13 Date and Time ...... 28 4.13.1 Get date and me ...... 28 4.13.2 Set date and me ...... 28 4.14 Memory ...... 28 4.14.1 Get memory status ...... 28 4.14.2 Get memory size ...... 28 4.14.3 Get memory free ...... 29 4.14.4 Get captured images ...... 29 4.14.5 Get recorded thermal video ...... 29 4.14.6 Get recorded visible video ...... 29 4.15 Stream ...... 30 4.15.1 Get thermal camera resoluon ...... 30 4.15.2 Get thermal extremes ...... 30 4.15.3 Get palee values ...... 30 4.16 System ...... 31 4.16.1 Default sengs ...... 31 4.16.2 Shut down ...... 31 4.16.3 Reboot ...... 31

5. RTSP Video 32 5.1 GStreamer ...... 32 5.2 VLC ...... 32 5.3 FFmpeg ...... 35

6. FTP data access 37 6.1 FTP connecon ...... 37 6.2 Restricons and warnings ...... 37 6.3 Soware ...... 37

7. WIRIS Ethernet Stream SDK GUI Applicaon 39 7.1 Introducon ...... 39 7.1.1 Installaon ...... 39 7.1.2 First launch ...... 39 7.1.3 Startup default sengs ...... 40 7.2 Main Window ...... 40 7.3 Main menu ...... 40

3 7.3.1 Range ...... 40 7.3.2 Funcons ...... 41 7.3.3 Palees ...... 41 7.3.4 Capture ...... 41 7.3.5 Measure ...... 41 7.3.6 Advanced ...... 42 7.4 Quick Menu ...... 42 7.5 Inspecon Panel ...... 42 7.6 Secondary Stream window ...... 43 7.7 WIRIS Security ...... 43

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 4 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 1. USER INFORMATION

1 User Informaon

1.1 Typographic Convenons

Following typographic convenons are used in this User Manual: UPPER CASE is used for the names of keys, buons and menu items COURIER is used for filenames and paths Italic is used for important informaon and document names bold is used for the links to other secons, for funcon names or sites

1.2 Help and Support

For technical quesons 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 [email protected].

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 hps://www.workswell-thermal-camera.com/firmware-update/ to download the latest firmware release. The update process itself is described in a later secon.

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.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 5 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 2. REVISION HISTORY

2 Revision history

1.0

Inial release

1.1

Added shuer sengs Added alarm color sengs Added Hot and Cold Rejecon for WWS New chapter for GUI Applicaon

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 6 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 3. OVERVIEW

3 Overview

This chapter includes basic informaon about the WIRIS Ethernet SDK.

3.1 Basic Informaon

Ethernet SDK is intended to stream video from WIRIS device and to control it over Ethernet connecon. It re- places the HDMI output and RC transceiver input. The SDK is currently compable 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 protocol and can be used with telnet terminal soware. The WIRIS also runs RTSP server for streaming the visible and thermal video. it can be viewed with GStreamer, FFmpeg, VLC or other soware 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 Acvang the SDK

The SDK in the WIRIS device needs to be acvated. It is not free of charge. Please contact the sales support for more informaon.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 7 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 3. OVERVIEW

It can be acvated with license code using TCP/IP server command.

3.3 Example Library

We have prepared simple open-source example library for the TCP/IP communicaon. It is cross-plaorm (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 Geng Help and Suggesons

The WIRIS Ethernet SDK was created as stable and robust as possible. Sll, if you find any bugs, inconveniences or if you have any suggesons for improvement, please contact us at [email protected].

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 8 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. DESCRIPTION

4 Communicaon protocol descripon

This chapter contains informaon about the TCP/IP communicaon protocol and commands. The server descripon: Port 2240 Text-based communicaon protocol Can be connected to with telnet soware Each command received by the server is at least acknowledged The commands are case sensive, 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 acvaon.

4.1.1 Set commands delimiter

Set the delimiter for command messages. This delimiter is used for detecng 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 beer for soware development. Command • SDLM NULL Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 9 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.1.2 Get commands delimiter

Returns the current commands delimiter. Command • GDLM Answer • LINE or NULL

4.1.3 Check connecon

Command used for checking the connecon. Command • HIWS Answer • OK

4.1.4 Get WIRIS serial number

Returns WIRIS device serial number. Command • GSRN Answer • ABC-DEF123

4.1.5 Get WIRIS arcle number

Returns WIRIS device serial number. Command • GATN Answer • ABC-DEF123

4.1.6 Get WIRIS version

Returns WIRIS firmware version. Command • GFWV

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 10 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Answer • 1.2.3

4.1.7 Get CPU temperature

Returns WIRIS device internal temperature. Command • GTCU Answer • 32.10

4.1.8 Get thermal camera temperature

Returns WIRIS thermal camera core temperature. Command • GTIC Answer • 32.10

4.1.9 Get device temperature

Returns WIRIS internal device temperature. Command • GTIN Answer • 32.10

4.2 Commands - Acvaon

All the following commands are inaccessible unless the Ethernet SDK is acvated for the given WIRIS camera. The acvaon needs to be done once per device. Aer the acvaon, the WIRIS saves the acvaon code and does not need to be acvated again.

4.2.1 Acvate

To acvate the device, send the license number with following command. Command

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 11 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

• ACTV ACTIVATION-NUMBER-123 Answer • OK

4.2.2 Is acvated

Check if WIRIS is acvated. Command • IACT Answer • TRUE or FALSE

4.3 Commands - Ethernet Mode

This command will start or stop the Ethernet Mode. In Ethernet Mode mode, WIRIS will stop streaming cameras to HDMI. The RTSP server is started. Please note that all the following commands can be used without the Ethernet Mode, but it is highly recom- mended to exclude the combinaon of Ethernet set commands and the usage of RC or keyboard.

4.3.1 Set Ethernet Mode

Sets the Ethernet Mode ON or OFF with TRUE or FALSE. Command • SETH TRUE Answer • OK

4.3.2 Get Ethernet Mode

Returns if the Ethernet Mode is acve. Command • GETH Answer • TRUE or FALSE

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 12 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.4 GPS

4.4.1 Set thermo range to high

Get the current GPS coordinates as long as it is provided to the camera; it relies on external source. Returns ei- ther N/A when GPS is not connected, INVALID when GPS data is not valid or the coordinates in following format: LATITUDE 14.4444 S LONGITUDE 57.5555 W AlLTITUDE 156.156

Command • GGPS Answer • INVALID, N/A or coordinates

4.5 Range

Please refer to the WWP User Guide for more indepth explanaon of these parameters. Range sengs is available only for WWP.

4.5.1 Get range mode

Returns the current range mode. Command • GRMD Answer • AUTOMATIC, MANUAL or SPAN

4.5.2 Set range mode

Sets the thermal range mode to AUTOMATIC, MANUAL or SPAN. Command • SRMD AUTOMATIC Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 13 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.5.3 Get manual range

Returns the currently set manual thermal range minimum and maximum. Command • GRMM Answer • 20.0 40.0

4.5.4 Set manual range

Sets the thermal manual range minimum and maximum Command • SRMM 20.0 40.0 Answer • OK

4.5.5 Get span range

Returns the current span range window and center. Command • GRWC Answer • 10.0 30.0

4.5.6 Set span range

Sets the manual range window and center Command • SRWC 10.0 30.0 Answer • OK

4.5.7 Get environment

Returns current thermal environment (absolute temperature range) seng. Command • GREN

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 14 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Answer • -25.0 150.0

4.5.8 Get list of environments

Returns the list of available thermal environments. Each line is one environment. Command • GREL

4.5.9 Set environment

Sets the environment sengs. Use just the maximum value of the range. This command can take up to 10 seconds to perform. Command • SREN 150.0 Answer • OK

4.6 WWS Thermal Parameters

Specific parameters for WWS thermal camera.

4.6.1 Get me stabilizaon

Returns thermal camera me stabilizaon in seconds. Command • GTST Answer • 2.4

4.6.2 Set me stabilizaon

Sets thermal camera me stabilizaon in seconds. Command • STST 2.4 Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 15 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.6.3 Get hot rejecon

Returns hot rejecon in percent. Command • GHRJ Answer • 2.4

4.6.4 Set hot rejecon

Sets hot rejecon in percent. Command • SHRJ 2.4 Answer • OK

4.6.5 Get cold rejecon

Returns cold rejecon in percent. Command • GCRJ Answer • 2.4

4.6.6 Set cold rejecon

Sets cold rejecon in percent. Command • SCRJ 2.4 Answer • OK

4.7 Zoom

4.7.1 Get thermal camera zoom

Returns thermal camera zoom rao.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 16 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Command • GZTV Answer • 2.5

4.7.2 Get list of thermal camera zooms

Get list of all available zooms of thermal camera. Each line has index number and zoom rao value. Command • GZTL Answer • 0 1.0 • 1 2.0 • ...

4.7.3 Set thermal camera zoom index

Sets the thermal camera zoom index number. Thermal camera has only digital zoom, so the stream is not inflicted by the zoom value. The zoom changes the area where maximum and minimum values are looked for. Command • SZTN 1 Answer • OK

4.7.4 Get visible camera zoom

Returns visible camera zoom rao. Command • GZVV Answer • 2.5

4.7.5 Get list of visible camera zooms

Get list of all available zooms of visible camera. Each line has index number and zoom rao value.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 17 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Command • GZVL Answer • 0 1.0 • 1 2.0 • ...

4.7.6 Set visible camera zoom index

Sets the visible camera zoom index number. Command • SZVN 1 Answer • OK

4.8 Palees of thermal video stream

4.8.1 Get palee

Returns current palee name. Command • GPTE Answer • GRAY

4.8.2 Get palee list

Returns all the available palees. Each line is one palee name. Command • GPTL

4.8.3 Set palee

Set palee by name. Command • SPTE GRAY

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 18 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.9 Capture and record

4.9.1 Capture

Triggers the image capture. The command returns an acknowledgement right away, but the capture itself can take up to several seconds depending on the sengs. Returns NOT_READY in the case the capture cannot be iniated due to the last one not being finished yet. Command • CPTR Answer • OK or NOT_READY

4.9.2 Is capturing

Check if capture in progress. Command • ICPT Answer • TRUE or FALSE

4.9.3 Recording start

Start recording thermal and visible video according to sengs. Command • RCRS Answer • OK or NOT_READY

4.9.4 Recording finish

Stops recording of thermal and visible video. Command • RCRF Answer • OK or NOT_READY

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 19 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.9.5 Is recording

Check if recording is in progress. Command • IRCR Answer • TRUE or FALSE

4.10 Alarms

4.10.1 Get alarm mode

Returns current alarm mode. Command • GALM Answer • OFF, ABOVE, BELOW, BETWEEN, or OUTSIDE

4.10.2 Set alarm mode

Set alarm mode OFF, ABOVE, BELOW, BETWEEN, or OUTSIDE. Command • SALM OFF Answer • OK

4.10.3 Get alarm values

Get alarm thresholds; below and above. Command • GALV Answer • 20.0 40.0

4.10.4 Set alarm values

Set alarm thresholds; below and above.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 20 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Command • SALV 20.0 40.0 Answer • OK

4.10.5 Get alarm colors

Get alarm colors: above, between and below. Possible colors are red, green or blue. Command • GALC Answer • RED GREEN BLUE

4.10.6 Set alarm colors

Set alarm colors: above, between and below. Possible colors are red, green or blue. Command • SALC RED GREEN BLUE Answer • OK

4.11 Thermal camera

Thermal camera sengs are currently supported only for WWP.

4.11.1 Get emissivity

Returns current thermal camera emissivity. Command • GTEM Answer • 0.95

4.11.2 Set emissivity

Set thermal camera emissivity from 0.5 to 1.0.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 21 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Command • STEM 0.95 Answer • 0.95

4.11.3 Get shuer period

Get thermal camera shuer period in seconds. Command • GTCP Answer • 120

4.11.4 Set shuer period

Set thermal camera shuer period in seconds 120-1800. Command • STCP 120 Answer • OK

4.11.5 Get synchronous shuer sengs

Returns the current synchronous shuer sengs. Command • GTSC Answer • TRUE or FALSE

4.11.6 Set synchronous shuer sengs

Set the synchronous shuer opon on or off, TRUE or FALSE. Command • STSC TRUE Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 22 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.11.7 Perform thermal camera shuer

Performs the thermal camera shuer immediately. Command • DTSR Answer • OK

4.11.8 Get seconds to next thermal camera shuer

Returns the number of seconds to next shuer or ”N/A” if asynchronous. Command • GTSN Answer • 123 or N/A

4.11.9 Get seconds from last thermal camera shuer

Returns the number of seconds from last thermal camera shuer. Command • GTSL Answer • 123

4.12 Image and video sengs

WWS does not support the super-resoluon and TIFF images. WWS captures and records the thermal image and video instead of the radiometric image and video.

4.12.1 Get radiometric JPEG image sengs

Returns whether the image should be captured, TRUE or FALSE. Command • GIRJ Answer • TRUE or FALSE

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 23 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.12.2 Get radiometric TIFF image sengs

Returns whether the image should be captured, TRUE or FALSE. Command • GIRT Answer • TRUE or FALSE

4.12.3 Get super-resoluon image sengs

Returns whether the image should be captured, TRUE or FALSE. Command • GISR Answer • TRUE or FALSE

4.12.4 Get visible image sengs

Returns whether the image should be captured, TRUE or FALSE. Command • GIVI Answer • TRUE or FALSE

4.12.5 Get radiometric video sengs

Returns whether the video should be recorded, TRUE or FALSE. Command • GVTH Answer • TRUE or FALSE

4.12.6 Get visible video sengs

Returns whether the video should be recorded, TRUE or FALSE. Command • GVVI

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 24 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Answer • TRUE or FALSE

4.12.7 Set radiometric JPEG image sengs

Sets whether the image should be captured, TRUE or FALSE. Command • SIRJ TRUE Answer • OK

4.12.8 Set radiometric TIFF image sengs

Sets whether the image should be captured, TRUE or FALSE. Command • SIRT TRUE Answer • OK

4.12.9 Set super-resoluon image sengs

Returns whether the image should be captured, TRUE or FALSE. Command • SISR TRUE Answer • OK

4.12.10 Set visible image sengs

Sets whether the image should be captured, TRUE or FALSE. Command • SIVI TRUE Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 25 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.12.11 Set radiometric video sengs

Sets whether the video should be recorded, TRUE or FALSE. Command • SVTH TRUE Answer • OK

4.12.12 Set visible video sengs

Sets whether the video should be recorded, TRUE or FALSE. Command • SVVI TRUE Answer • OK

4.12.13 Get image locaon

Return the current image locaon sengs. Command • GILC Answer • SSD, SD_CARD or FLASH_DRIVE

4.12.14 Set image locaon

Set the current image locaon sengs. This will change the memory where the images are captured, SSD, SD_CARD or FLASH_DRIVE. Command • SILC SSD Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 26 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.13 Date and Time

4.13.1 Get date and me

Return the current date and me in strict format yyyy/MM/dd-hh:mm:ss. Command • GDTI Answer • 2019/06/21-10:44:51

4.13.2 Set date and me

Set the date and me in strict format yyyy/MM/dd-hh:mm:ss. Command • SDTI 2019/06/21-10:44:51 Answer • OK

4.14 Memory

Thera are three types of memory: SSD, SD_CARD or FLASH_DRIVE. The following commands returns the status of each memory on one line like: SSD SOME_STATUS SD_CARD SOME_STATUS FLASH_DRIVE SOME_STATUS

4.14.1 Get memory status

Return the current memory status, each line one memory type. Command • GMST Answer • READY, CONNECTED or N/A

4.14.2 Get memory size

Return the current memory size in bytes, each line one memory type.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 27 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

Command • GMSI Answer • SSD 123456789

4.14.3 Get memory free

Return the current free memory in percent, each line one memory type. Command • GMFR Answer • SSD 88.88

4.14.4 Get captured images

Return the current captured images, each line one memory type. Command • GMCP Answer • SSD 1234

4.14.5 Get recorded thermal video

Return the recorded radiometric video in seconds. Command • GTRC Answer • 1234

4.14.6 Get recorded visible video

Return the recorded visible video in seconds. Command • GVRC Answer • 1234

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 28 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.15 Stream

4.15.1 Get thermal camera resoluon

Return the resoluon of thermal camera - width and height. Command • GTRE Answer • 640 512

4.15.2 Get thermal extremes

Return the current thermal camera extremes. The extreme consists out of coordinates X and Y and the extreme value in degrees Celsius. Each extreme takes one line like: MAXIMUM X Y VALUE MINIMUM 300 100 10.000 CENTER 320 256 25.555 WWS returns only the posions of extremes, without the values. Command • GTEX

4.15.3 Get palee values

Returns current palee values used for creang the thermal image from gray image. The palee consists out of 256x3 values. Each line is RGB pixel represented by three values from 0 to 255. The top most value is the hoest color, the boom values is the coldest color. Here is short example of answer: 0 0 0 2 0 2 4 0 4 . . . Command • GPLV

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 29 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 4. COMMUNICATION PROTOCOL DESCRIPTION

4.16 System

4.16.1 Default sengs

Set the default sengs, can take up to 10 seconds. This command will exit the Ethernet Mode. Command • SDST Answer • OK

4.16.2 Shut down

Shuts the WIRIS down. Command • SHDW Answer • OK

4.16.3 Reboot

Reboot the WIRIS. Command • REBT Answer • OK

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 30 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 5. RTSP VIDEO SERVER

5 RTSP Video Server

This chapter contains informaon about the RTSP server and video streams. When the Ethernet Mode is acvated, the RTSP server is opened on standard port. The address is: Thermal stream • rtsp://10.0.0.230:8554/thermal Visible stream • rtsp://10.0.0.230:8554/visible The IP address may differ according to the sengs. The sever uses RTP protocol for media stream delivery. Currently only the stream can be opened, no other commands are available. The video streams are H264 encoded. The resoluon of visible stream is always HD (1280x720) with 20Hz. The resoluon of thermal stream depends on the model: WWP • 640x512, 30Hz or 8.5Hz WWS • 800x600, 25Hz or 8.3Hz Following soware was tested to be working with the RTSP streams. The soware is free and cross-plaorm.

5.1 GStreamer

The best result with lowest delay can be achieved using GStreamer. hps://gstreamer.freedesktop.org/ The command for launching the video stream is: gst-launch-1.0 rtspsrc location=rtsp://10.0.0.230:8554/visible latency=100 ! rtph264depay ! avdec_h264 ! autovideosink

5.2 VLC

The streams can be opened using VLC media player. hps://www.videolan.org/vlc/index.cs.html The command for launching the video stream is: vlc --network-caching 250 --clock-jitter=0 rtsp://10.0.0.230:8554/visible The network caching parameter sets the video delay. Too low value may cause instability.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 31 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 5. RTSP VIDEO SERVER

Figure 5.1 – Windows console with the GStreamer command.

Figure 5.2 – Windows GStreamer video stream.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 32 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 5. RTSP VIDEO SERVER

Figure 5.3 – Windows console with the VLC command.

Figure 5.4 – Windows VLC video stream.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 33 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 5. RTSP VIDEO SERVER

Figure 5.5 – Windows console with the FFmpeg command.

5.3 FFmpeg

The FFmpeg libraries can be also used for the video stream. hps://ffmpeg.org/ The command for launching the video stream is: ffplay -fflags nobuffer -flags low_delay -framedrop -strict experimental -rtsp_transport tcp -sync ext -i "rtsp://10.0.0.230:8554/visible"

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 34 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 5. RTSP VIDEO SERVER

Figure 5.6 – Windows FFmpeg video stream.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 35 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 6. FTP DATA ACCESS

6 FTP data access

This chapter contains informaon about the FTP server and WIRIS data access.

6.1 FTP connecon

There is a standard FTP server running on the WIRIS device. You can access it with the WIRIS IP address and following login: User: wiris Without password You have full access to the saved data. You can download, rename and delete the files. You can also connect as anonymous user, but anonymous user does not have the write access.

6.2 Restricons and warnings

Since the full access is given, it should be use with cauon. These are the restricons: Do not delete or alter the current folder in use! If these restricons are broken, it can cause the WIRIS to crash and reboot.

6.3 Soware

The server can be accessed with web browser (Firefox, Chrome, Opera, ...). For details please refer to the support of the browser. We recommend using the Filezilla soware. hps://filezilla-project.org/.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 36 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 6. FTP DATA ACCESS

Figure 6.1 – Connecng to FTP server with Filezilla.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 37 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 7. WIRIS ETHERNET STREAM SDK GUI APPLICATION

7 WIRIS Ethernet Stream SDK GUI Applicaon

This chapter contains informaon about WIRIS Ethernet Stream SDK GUI applicaon, which was developed to demonstrate possible usage of this SDK.

7.1 Introducon

7.1.1 Installaon

The app can be downloaded directly from Workswell website. WIRIS Ethernet Stream SDK GUI is fully open source, therefore you can access all source files, which can serve as an example for developing your own applicaon. You can find them on GitHub: hps://github.com/SowareWorkswell/EthernetStreamSDKGUI Note that the most important part of this project is ”ControllerCore” class (with its dependencies like Thread classes and NetworkClient class), which demonstrates basic usage of SDK, other files are plaorm dependent and may not be so interesng

7.1.2 First launch

On first startup applicaon requires you to: Fill in your WIRIS IP address Fill in your acvaon code Aer filling IP adress and clicking OK, applicaon will try to contact your WIRIS device, this step can fail if your device is unreachable or your Wiris Firmware is too obsolete and is not supported by the applicaon.(Applicaon will always show you the cause) When connected to WIRIS via HDMI, IP address and mask can be changed in Advanced - System sengs When successfully connected, applicaon may ask you to fill in your acvaon code (but only if it has never been acvated in the past)

Figure 7.1 – WIRIS Ethernet Stream SDK GUI - Connecon Window

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 38 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 7. WIRIS ETHERNET STREAM SDK GUI APPLICATION

Aer compleng these inial steps you should be able to see main applicaon window.

7.1.3 Startup default sengs

Most sengs are read from WIRIS during startup, except some of sengs which applicaon set to default values: Image storage is set to SSD Alarm mode is set to OFF Zooms are both set to 1 All measure sengs are set to OFF

7.2 Main Window

WIRIS Ethernet Stream SDK GUI visuals are strongly inspired by nave look of WIRIS HDMI output - user should be familiar with most of included features - reading chapter 11 in WIRIS PRO User Manual before connuing is recommended: hps://www.workswell-thermal-camera.com/documents/ This brief manual includes mainly parts of the applicaon, that differ from nave WIRIS output. The main window is divided into 4 main parts: Main stream window - in the center, displays thermal stream by default, you can also find currently selected palee on its right side together with current range mode indicator on its very top Secondary stream window - in the right upper corner, displays visible stream by default Main menu - le side of the main window, keeps all items that are included in nave WIRIS Quick menu - at the very boom(replaces original Status bar), is used for some of frequently accessed features Inspecon panel - on the right, below secondary stream window, includes status bar and some extra in- formaon

7.3 Main menu

Main menu appearance is idencal with nave WIRIS Main menu but each item contents can slightly differ.

7.3.1 Range

Range contents are idencal, however they are slightly differently styled, you can now use radio buon at the top to toggle between AUTOMATIC, MANUAL and SPAN ranges and there is also new radio buon for changing eviroments.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 39 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 7. WIRIS ETHERNET STREAM SDK GUI APPLICATION

Figure 7.2 – WIRIS Ethernet Stream SDK GUI - Main Window

7.3.2 Funcons

This secon now includes both thermal and visible zoom and Main Camera toggle. However there are no sengs for Image opacity, Layout and Lock Zoom.

7.3.3 Palees

This secon is idencal.

7.3.4 Capture

You can find both Capture and Record buon here with ability to set periodic capture and check whether it has been started, Image Correcon (Shuer) was moved to quick menu.

7.3.5 Measure

Extremes sengs are idencal. Alarms funconality stayed the same but is now interpreted graphically by a slider.

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 40 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 7. WIRIS ETHERNET STREAM SDK GUI APPLICATION

7.3.6 Advanced

A couple of submenus from this item has been removed. Only following submenus can be found here: Thermal Camera - Emissivity and shuer period can be found here Images and Video - This submenu is idencal except Image Screenshot JPEG opon Alarms - You can set alarm colors here Memory - You can find status of all storage devices here System - This submenu is idencal, however Language and Units opon cannot be changed Info - This submenu is idencal

7.4 Quick Menu

Quick Menu consist of several acons that are likely to be used frequently: Capture - iniates capturing according to Image and Video sengs (Advanced/Images and Video sub- menu), it can also iniate periodic capture(if set in Capture menu) Record - iniates recording according to Image and Vid sengs (Advanced/Images and Video submenu) Shuer - performs the thermal camera shuer immediately Range - toggles range to manual mode and allows user to quickly adjust range Pause - pauses or connues the main camera stream - can be used to lower bandwidth requirements

7.5 Inspecon Panel

Standard Status bar can be found, there are also some addional features: WIRIS Type - Pro/Security WIRIS IP Address CPU temperature IR Core temperature WIRIS Firmware version WIRIS Serial Number Latency Current alarm mode info Connecon state

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 41 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic 7. WIRIS ETHERNET STREAM SDK GUI APPLICATION

Figure 7.3 – WIRIS Ethernet Stream SDK GUI - Secondary Stream Window

7.6 Secondary Stream window

This window is used to display either visible or thermal stream, you can find following buons here: Switch stream windows - is used to switch stream windows quickly Pause stream - pauses or connues the secondary camera stream - can be used to lower bandwidth re- quirements Separate window - opens new resizable window with secondary stream

7.7 WIRIS Security

If you are using WIRIS Security device which doesn’t provide the same SDK interface as WIRIS Pro, the applicaon lacks of these following features: Range in Main menu cannot be accessed In Measure, Show temperatures opon is disabled and alarms cannot be set In Advanced - Thermal Camera and Alarms submenus are hidden, in Memory - radiometric sengs have been removed Inspecon panel lacks of Alarm and Environment info Quick menu - NUC and Man. range have been removed Main stream window - palee values are hidden

Headquarters E-mail and Web Mobile: ID: Revision 1.1 EN, 11th Sept, 2019 U Albrechtova vrchu 12 [email protected] +420 725 877 063 Reg. No.: 29048575 All pictures are only for illustraon. 155 00, Prague 13 42 www.workswell.eu VAT No.: CZ29048575 Real values may vary. Czech Republic Contacts

Sales Department Headquarters Partners Worldwide

Mobile: +420 725 955 464 Workswell s.r.o. Visit our partner list online E-mail: [email protected] U Albrechtova vrchu 12 155 00, Prague 13 Czech Republic

Company contact details Mobile: +420 725 877 063 E-mail: [email protected]

Web: www.workswell.eu