Package: wrpclient
Welcome to the WRP Client’s documentation! WRP Client andWRP Serverare two parts of a driver that allows to connect to theWorkswell InfraRed Camerausing Python. This repository contains the client part, that is written in Python. The second part,WRP Server, is written in C# because the Workswell company provides and supports access to the cameras only through their C# SDK and not throught any other language.InstallationThe simplest way to install WRP client is from the pypi:pipinstallwrpclientAlternative method is to build this repository:gitclonehttps://github.com/Kasape/wrpclient.gitcdwrpclientpythonsetup.pyinstallUsageThis project is implemented using asyncio library. But because using asyncio library can be a little problematic for beginners in Python, there are also synchronous wrappers about the asynchronous ones. First we have to create a instance of Client class and then connect it to the server:fromdatetimeimportdatetimeimportwrp_clientimportasyncioclient=wrp_client.Client()SERVER_IP_ADDRESS="127.0.0.1"# synchronous wrapper for the method (coroutine)# client.connect_async(ip_adress=SERVER_IP_ADDRESS)client.connect(ip_adress=SERVER_IP_ADDRESS,timeout="20")Once the client is connected to the server, we can get list of all cameras that was identified by the server.# get all camerasall_cameras=client.get_cameras(timeout="20")Or we can get only one camera identified by the serial number. If the camera is not available, ValueError exception is raised.
Then we have to open the camera to get frame(s):# find camera with specific serial numbermy_camera=client.get_camera(serial_number="ABCDEF",timeout="20")my_camera.open(timeout="20")# Return 2D frame (numpy matrix) with dtype np.float32 filled with raw data (decimal values of temperatures)frame=my_camera.get_frame(timeout="20")As you can see, all the functions above have parameter timeout. That is because each function is sending some request and is expecting response from to the server and latence of the server depends on the latence of the cameras. There are also asynchronous versions of these functions for more advanced users. They are namedxxx_asyncas shown in case ofclient.connect_async.You can also ask camera for the continuous stream of frames:defcallback(frame):time_str=datetime.now().strftime("%Y-%m-%d-%H-%M-%S-%f")frame_color=cv2.applyColorMap(frame,cv2.COLORMAP_JET)cv2.imwrite(f"frame-{time_str}.jpg",frame_color)# give handler for continuous shot that saves colorized images with timestamp suffixmy_camera.start_continuous_shot(callback)# wait some time to collect imagesasyncio.sleep(5)my_camera.stop_continuous_shot(callback)If you want to use the API in IPython enviroment (most common are Jupyter notebooks), you have to installNest asyncioand run the following code before using wrpclient:importnest_asyncionest_asyncio.apply()DocumentationAbove you can find guide for installation and example of usage. The full version of the documentation also containing class and methods description (API) can be found onReadTheDocs pageor you can build it from a repository with code:gitclonehttps://github.com/Kasape/wrpclient.gitcdwrpclient/docspipinstallsphinxmakehtmland open it with your browser on the addressfile://<path_to_repo>/docs/_build/html/index.html.LicenceThis project has GNU GPLv3 License.