Skip to main content

Workswell Remote Protocol Client

Project description

Welcome to the WRP Client’s documentation! WRP Client and WRP Server are two parts of a driver that allows to connect to the Workswell InfraRed Camera using 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.

Installation

The simplest way to install WRP client is from the pypi:

pip install wrpclient

Alternative method is to build this repository:

git clone https://github.com/Kasape/wrpclient.git
cd wrpclient
python setup.py install

Usage

This 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:

from datetime import datetime
import wrp_client
import asyncio

client = 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 cameras
all_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 number
my_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 named xxx_async as shown in case of client.connect_async.

You can also ask camera for the continuous stream of frames:

def callback(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 suffix
my_camera.start_continuous_shot(callback)

# wait some time to collect images
asyncio.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 install Nest asyncio and run the following code before using wrpclient:

import nest_asyncio
nest_asyncio.apply()

Documentation

Above 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 on ReadTheDocs page or you can build it from a repository with code:

git clone https://github.com/Kasape/wrpclient.git
cd wrpclient/docs
pip install sphinx
make html

and open it with your browser on the address file://<path_to_repo>/docs/_build/html/index.html.

Licence

This project has GNU GPLv3 License.

Project details


Release history Release notifications

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wrpclient, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size wrpclient-0.1-py3-none-any.whl (24.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size wrpclient-0.1.tar.gz (24.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page