background image

WORKSWELL

WIRIS Ethernet Stream

SDK

USER MANUAL

FW Version:

1.1.1

Release date:

11

th

September, 2019

Revision :

1.1 EN

Summary of Contents for Wiris

Page 1: ...WORKSWELL WIRIS Ethernet Stream SDK USER MANUAL FW Version 1 1 1 Release date 11th September 2019 Revision 1 1 EN...

Page 2: ...t 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 A...

Page 3: ...20 4 9 3 Recording start 20 4 9 4 Recording nish 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...

Page 4: ...tus 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 cam...

Page 5: ...Panel 42 7 6 Secondary Stream window 43 7 7 WIRIS Security 43 E mail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtov...

Page 6: ...r 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...

Page 7: ...d Rejec on for WWS New chapter for GUI Applica on E mail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtova vrchu 12 1...

Page 8: ...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...

Page 9: ...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...

Page 10: ...r 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 S...

Page 11: ...ial number Command GSRN Answer ABC DEF123 4 1 5 Get WIRIS ar cle number Returns WIRIS device serial number Command GATN Answer ABC DEF123 4 1 6 Get WIRIS version Returns WIRIS rmware version Command G...

Page 12: ...commands are inaccessible unless the Ethernet SDK is ac vated for the given WIRIS camera The ac va on needs to be done once per device A er the ac va on the WIRIS saves the ac va on code and does not...

Page 13: ...et Mode but it is highly recom mended to exclude the combina on 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 Com...

Page 14: ...nge Please refer to the WWP User Guide for more indepth explana on of these parameters Range se ngs is available only for WWP 4 5 1 Get range mode Returns the current range mode Command GRMD Answer AU...

Page 15: ...ndow 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 ab...

Page 16: ...OK 4 6 WWS Thermal Parameters Speci c parameters for WWS thermal camera 4 6 1 Get me stabiliza on Returns thermal camera me stabiliza on in seconds Command GTST Answer 2 4 4 6 2 Set me stabiliza on Se...

Page 17: ...Command GCRJ Answer 2 4 4 6 6 Set cold rejec on Sets cold rejec on in percent Command SCRJ 2 4 Answer OK 4 7 Zoom 4 7 1 Get thermal camera zoom Returns thermal camera zoom ra o E mail and Web support...

Page 18: ...e 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 ra o Command GZVV Answer 2 5 4 7 5 Get list o...

Page 19: ...Command GPTE Answer GRAY 4 8 2 Get pale e list Returns all the available pale es Each line is one pale e name Command GPTL 4 8 3 Set pale e Set pale e by name Command SPTE GRAY E mail and Web support...

Page 20: ...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 se ngs Command RCRS Answer OK or NOT_READY 4 9...

Page 21: ...BOVE 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 a...

Page 22: ...REEN BLUE Answer OK 4 11 Thermal camera Thermal camera se ngs 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 e...

Page 23: ...shu er se ngs Returns the current synchronous shu er se ngs Command GTSC Answer TRUE or FALSE 4 11 6 Set synchronous shu er se ngs Set the synchronous shu er op on on or o TRUE or FALSE Command STSC T...

Page 24: ...and GTSL Answer 123 4 12 Image and video se ngs WWS does not support the super resolu on and TIFF images WWS captures and records the thermal image and video instead of the radiometric image and video...

Page 25: ...be captured TRUE or FALSE Command GIVI Answer TRUE or FALSE 4 12 5 Get radiometric video se ngs Returns whether the video should be recorded TRUE or FALSE Command GVTH Answer TRUE or FALSE 4 12 6 Get...

Page 26: ...9 Set super resolu on image se ngs Returns whether the image should be captured TRUE or FALSE Command SISR TRUE Answer OK 4 12 10 Set visible image se ngs Sets whether the image should be captured TRU...

Page 27: ...t image loca on se ngs Command GILC Answer SSD SD_CARD or FLASH_DRIVE 4 12 14 Set image loca on Set the current image loca on se ngs This will change the memory where the images are captured SSD SD_CA...

Page 28: ...s 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 Com...

Page 29: ...er 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 C...

Page 30: ...emes without the values Command GTEX 4 15 3 Get pale e values Returns current pale e values used for crea ng the thermal image from gray image The pale e consists out of 256x3 values Each line is RGB...

Page 31: ...16 2 Shut down Shuts the WIRIS down Command SHDW Answer OK 4 16 3 Reboot Reboot the WIRIS Command REBT Answer OK E mail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 2...

Page 32: ...working with the RTSP streams The so ware is free and cross pla orm 5 1 GStreamer The best result with lowest delay can be achieved using GStreamer h ps gstreamer freedesktop org The command for launc...

Page 33: ...treamer video stream E mail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtova vrchu 12 155 00 Prague 13 Czech Republi...

Page 34: ...C video stream E mail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtova vrchu 12 155 00 Prague 13 Czech Republic Revi...

Page 35: ...ffplay fflags nobuffer flags low_delay framedrop strict experimental rtsp_transport tcp sync ext i rtsp 10 0 0 230 8554 visible E mail and Web support workswell eu www workswell eu Mobile 420 725 877...

Page 36: ...and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtova vrchu 12 155 00 Prague 13 Czech Republic Revision 1 1 EN 11th Sept...

Page 37: ...Since the full access is given it should be use with cau on These are the restric ons Do not delete or alter the current folder in use If these restric ons are broken it can cause the WIRIS to crash a...

Page 38: ...ail and Web support workswell eu www workswell eu Mobile 420 725 877 063 ID Reg No 29048575 VAT No CZ29048575 Headquarters U Albrechtova vrchu 12 155 00 Prague 13 Czech Republic Revision 1 1 EN 11th S...

Page 39: ...dent and may not be so interes ng 7 1 2 First launch On rst startup applica on requires you to Fill in your WIRIS IP address Fill in your ac va on code A er lling IP adress and clicking OK applica on...

Page 40: ...elected pale e 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 th...

Page 41: ...ecord bu on here with ability to set periodic capture and check whether it has been started Image Correc on Shu er was moved to quick menu 7 3 5 Measure Extremes se ngs are iden cal Alarms func onalit...

Page 42: ...ini ate periodic capture if set in Capture menu Record ini ates recording according to Image and Vid se ngs Advanced Images and Video submenu Shu er performs the thermal camera shu er immediately Rang...

Page 43: ...oesn t provide the same SDK interface as WIRIS Pro the applica on lacks of these following features Range in Main menu cannot be accessed In Measure Show temperatures op on is disabled and alarms cann...

Page 44: ...mail sales workswell eu Headquarters Workswell s r o U Albrechtova vrchu 12 155 00 Prague 13 Czech Republic Partners Worldwide Visit our partner list online Company contact details Mobile 420 725 877...

Reviews: