# Workswell Wiris Pro

{% hint style="info" %}
This section describes how to set up the Workswell Wiris Pro with Skynode. Please refer to[ this page](https://docs.auterion.com/hardware-integration/initial-vehicle-wiring#pixhawk-payload-bus) for wiring instructions and [this page](https://docs.auterion.com/hardware-integration/skynode/peripherals/pixhawk-payload-bus) for specifics about the Pixhawk Payload Bus.
{% endhint %}

## What you will need for this step

* Skynode Enterprise (powered as described in [Power Skynode](https://docs.auterion.com/hardware-integration/skynode/evaluation-kit/powering-skynode))
* Pixhawk Payload Bus (connected as described in [Pixhawk Payload Bus](https://docs.auterion.com/hardware-integration/skynode/peripherals/pixhawk-payload-bus))
* Microhard Air Unit (optional - connected as described in [Data Link Module](https://docs.auterion.com/hardware-integration/skynode/peripherals/data-link-module))
* Workswell Wiris Pro (not included in the kit)
* RJ45 Ethernet cable (not included in the kit)
* Monitor with HDMI input (not included in the kit)
* HDMI cable (not included in the kit)
* USB keyboard (not included in the kit)

## Supported features

* Full control of the payload from AMC
  * Photo triggering
    * Can be stored in external USB drive, Wiri's internal SSD or both
  * Video recording
    * Can only be stored in Wiri's internal SSD
* Video stream directly to AMC
* Configurable settings
  * EO or IR video stream
  * In IR mode: various colors palettes

{% hint style="info" %}
Update your Wiris Pro to the **1.6.42** firmware version if the camera is on an older version. All previous versions are not supported by Auterion OS. Workswell fimrware can be downloaded from [here](https://my.workswell.eu/login/?loginRedirectUrl=https%3A%2F%2Fmy.workswell.eu%2F&_fid=9wpk) by creating an account and registering the S/N from your camera. Instructions on how to see the current version and how to update can be found in the Workswell documentation.
{% endhint %}

## Setup Block Diagram

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-f63bc14fd0c3c2790e3876ef2a026d09ea09c090%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

The Workswell Wiris can be interfaced with Skynode via Ethernet using the RJ45 connector on the Pixhawk Payload bus. The Microhard Air Unit module connection slightly changes the first steps of the configuration.

### IP Settings with Microhard Air Unit module connected

The default Microhard DHCP server will assign an IP address in the range 192.168.168.100 - 192.168.168.200 to Skynode, therefore the IP of the Workswell Wiris should be changed to an IP outside this range, such as 192.168.168.230.

### IP Settings without Microhard Air Unit module connected

In this case, there is no DHCP server that will assign an IP to Skynode, therefore you need to set a static IP, such as 192.168.168.100. Then you should anyway change the IP address of the Workswell Wiris to be in the same network as Skynode, such as 192.168.168.230.

* Login into Skynode via [SSH](https://docs.auterion.com/flight-controller-customization/flight-controller-shell#ssh-to-the-mission-computer)
* Create the file `/data/override.env`
* Add the following environment variable

```
AP_CONFIGURE_ETHERNET_IP=192.168.168.100
```

* Reboot Skynode

## Configure Skynode Environment Variables

The Wiris driver supports several environment variables that can be configured to customize the camera connection and behavior. These variables should be added to `/data/override.env` on Skynode.

### Available Environment Variables

| Variable                              | Description                                                      | Type    |
| ------------------------------------- | ---------------------------------------------------------------- | ------- |
| `PAYLOAD_MNG_CTRL_IP_WIRIS`           | IP address of the Wiris camera                                   | string  |
| `PAYLOAD_MNG_CTRL_EO_BITRATE_WIRIS`   | Bitrate for electro-optical (visible light) video stream in kbps | integer |
| `PAYLOAD_MNG_CTRL_IR_BITRATE_WIRIS`   | Bitrate for infrared video stream in kbps                        | integer |
| `PAYLOAD_MNG_CTRL_FTP_USERNAME_WIRIS` | FTP username for camera file access                              | string  |
| `PAYLOAD_MNG_CTRL_FTP_PASSWORD_WIRIS` | FTP password for camera file access                              | string  |
| `PAYLOAD_MNG_CTRL_USB_ONLY_WIRIS`     | Enable USB-only mode (set to "1" to enable)                      | string  |

### Basic Configuration

At minimum, you need to configure the FTP credentials for AuterionOS to communicate with the camera. The username is always `wiris-pro` while the password is by default your license key. If you want to change your password, follow the steps highlighted in section [Configure FTP Password](#configure-ftp-password).

Add the following environment variables to `/data/override.env` and replace the password with your actual camera password:

```bash
PAYLOAD_MNG_CTRL_FTP_USERNAME_WIRIS="wiris-pro"
PAYLOAD_MNG_CTRL_FTP_PASSWORD_WIRIS="wiris-ftp-password"
```

### Advanced Configuration Examples

#### Custom IP Address

If your camera uses a different IP address:

```bash
PAYLOAD_MNG_CTRL_IP_WIRIS="192.168.1.100"
```

#### Video Bitrate Configuration

To optimize video streaming quality and bandwidth usage:

```bash
# Set EO (visible light) stream to 2 Mbps
PAYLOAD_MNG_CTRL_EO_BITRATE_WIRIS="2000"

# Set IR (thermal) stream to 1.5 Mbps
PAYLOAD_MNG_CTRL_IR_BITRATE_WIRIS="1500"
```

#### USB-Only Mode

To restrict communication to USB interface only:

```bash
PAYLOAD_MNG_CTRL_USB_ONLY_WIRIS="1"
```

{% hint style="info" %}
After modifying `/data/override.env`, reboot Skynode for the changes to take effect.
{% endhint %}

## Workswell Wiris Manual Settings <a href="#workswell-wiris-manual-settings" id="workswell-wiris-manual-settings"></a>

First of all, to enable the Wiris SDK over Ethernet you will need to buy an SDK license from Workswell: this will result in a license key.

To insert it, you will need to connect the camera via Ethernet to your laptop and then follow these instructions. First of all, give your laptop a static IP in the same range as the default Workswell Wiris one, for example 10.0.0.1.

Then, follow these steps:

* Open a telnet console to the camera on port 2240. On Linux this can be done with the following command

```
telnet 10.0.0.230 2240
```

* Now you can check if the camera is already activated with the following command

```
IACT
```

* If the previous command returns FALSE, you will need to activate it with the following command

```
ACTV <ACTIVATION-CODE>
```

Your Workswell Wiris is now ready to be configured and then connected to Skynode.

To access the camera settings, you need to connect the Workswell Wiris to a screen via HDMI and then connect a keyboard to it via USB. Turn on the camera and follow these steps to set the IP:

* Go to Advanced

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-ad9fba830bf55250f14647ea481c91ee7113f53a%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

* Go to System

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-89a61c2d6cf6e00c7a37290f684f3c0982262f28%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

* Change the static IP from 10.0.0.230 to 192.168.168.230

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-9fccc5c7530c75f1442e936cac46b7b6bc0df299%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Now you can connect the camera to Skynode via Ethernet on the Pixhawk Payload Bus and Skynode will automatically detect the payload and expose video and controls in AMC.

## Configure FTP Password on Camera

Connect a display via HDMI to your camera and attach a usb keyboard as well.

In the left tool strip select **Advanced** and navigate to **Ethernet SDK Protocol**

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-358617cfe834aee32b0b795aedb13986fc91dcbc%2Fwiris_ftp_password1%20(1).jpg?alt=media" alt=""><figcaption></figcaption></figure>

Select **Save New FTP Password**

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-29f2e78c3b7b49e02acfd03e37bbc6a2759e2668%2Fwiris_ftp_password2.jpg?alt=media" alt=""><figcaption></figcaption></figure>

Enter the new password into the dialog and confirm.

<figure><img src="https://3329189600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFW1Ge1p1f6WHyiYCb146%2Fuploads%2Fgit-blob-4fb4af1c7598229aa472b0c59d66da4614c34839%2Fwiris_ftp_password3%20(2).jpg?alt=media" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.auterion.com/hardware-integration/skynode/payloads/workswell-wiris-pro-and-wiris-security.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
