> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/connectors/shop-floor-connectors/werma-win-ethernet.md).

# Werma WIN Ethernet

Collect machine states from Werma WIN stack lights over the wireless WIN system and process them in Connectware.

The Werma WIN system is a wireless communication system that makes machine state information available for digital processing. The system enables connectivity for stack lights and other industrial indicators. With Connectware, you can integrate Werma WIN data into your shop floor data structure.

## System Overview

The Werma WIN system consists of several key components that work together to provide wireless industrial communication.

### Werma WIN Ethernet Master

The WIN Ethernet Master acts as the primary device and access point for the wireless sensor network. It provides:

* **Ethernet connectivity**: The WIN Ethernet Master's Ethernet port must be reachable by Connectware
* **Network management**: A single WIN Ethernet Master manages access to multiple secondary devices
* **Data aggregation**: Collects and forwards data from all connected secondary devices

To commission data acquisition, you must know the IP address of the WIN Ethernet Master.

### Werma WIN Secondary Devices

Each machine or stack light is equipped with a dedicated secondary device. The Werma WIN endpoint properties call this device a slave. Key characteristics:

* **Identification**: Each secondary device is identified by its unique MAC address
* **Discovery**: MAC addresses can be discovered by inspecting Connectware logs or using the Werma WIN Windows Configuration tool
* **Wireless communication**: Communicates with the WIN Ethernet Master via proprietary wireless protocol

#### Data Points

Every secondary device provides the following data points:

* **RSSI**: Signal strength indicator for the wireless connection between the secondary device and the WIN Ethernet Master
* **Tiers (t1, t2, t3, t4)**: State of up to four digital switches, typically associated with specific colors
  * Possible values: `'on'`, `'off'`, or `'blink'`

#### Update Triggers

State updates from secondary devices can be triggered:

* At fixed time intervals
* On state changes of any tier (asynchronous)

### Supporting Software

#### Werma WIN Easy Software

Required for system setup and configuration, including:

* Association between the WIN Ethernet Master and secondary devices
* Network configuration
* Device management

This Windows-based software is shipped with the hardware.

#### Werma WIN Shop Floor Manager

Werma's proprietary shop floor management application can be used alongside Connectware. Since a Werma WIN Ethernet Master allows only one concurrent connection, use the Connectware Werma Proxy Service to distribute data to multiple applications simultaneously.

## Protocol Integration

The Connectware `Werma` protocol maps the proprietary Werma WIN Protocol into MQTT/JSON format.

**Configuration References:**

* [Connection Properties](/connectors/shop-floor-connectors/werma-win-ethernet/wermaconnection.md)
* [Endpoint Properties](/connectors/shop-floor-connectors/werma-win-ethernet/wermaendpoint.md)

## Service Commissioning File Example

Werma WIN Ethernet endpoints support only the `subscribe` operation. The following example demonstrates how to configure a Werma connection and endpoint that subscribes to a device by its MAC address:

{% code lineNumbers="true" %}

```yaml
wermaConnection:
  type: Cybus::Connection
  properties:
    protocol: Werma
    connection:
      host: !ref host
      port: !ref port
      password: !ref password
      connectionStrategy:
        initialDelay: 1000
        maxDelay: 10000
        incrementFactor: 2

wermaSubscribe:
  type: Cybus::Endpoint
  properties:
    protocol: Werma
    connection: !ref wermaConnection
    subscribe:
      mac: !ref macAddress
```

{% endcode %}

## Data Formats

### Tier Data

Individual tier state information:

```json
{
  "timestamp": 1629351968526,
  "value": "blink",
  "raw": "2"
}
```

`value` is `on`, `off`, or `blink`. `raw` is the state code as the Werma WIN Ethernet Master sends it, as a string: `"0"` for off, `"1"` for on, and `"2"` for blink.

### RSSI Data

Signal strength information:

```json
{
  "timestamp": 1629351968526,
  "value": 3
}
```

### Complete Device Data

All data points from a single device:

```json
{
  "timestamp": 1629351968526,
  "value": {
    "rssi": 3,
    "t1": "on",
    "t2": "blink",
    "t3": "on",
    "t4": "off"
  }
}
```

### Received Raw Data

Raw data is forwarded as received from the Werma WIN Ethernet Master without additional processing or decoration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cybus.io/connectors/shop-floor-connectors/werma-win-ethernet.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
