# WS1

Running the WS1 driver under this one, configured by hand.

Generated by `tools/build_drivers.py` from the driver as installed on the machine that
ran it. Do not edit by hand.

> **There is a web interface for all of this.** It is on by default, and the driver
> prints its address when WeeWX starts:
>
> ```
> INFO user.ultimatepush.driver: The web interface is at
> http://1.2.3.4:8080/?token=abcdefg12345
> ```
>
> Everything on this page can be done there instead, and one thing is much easier:
> deciding which reading goes into which database column. See
> [Web interface](Web-interface).

## What it is

Driver for ADS WS1 weather stations. Thanks to Kevin and Paul Caccamo for adding the
serial-to-tcp capability.

## The smallest configuration that works

```ini
[Station]
    station_type = UltimatePush

[UltimatePush]
    driver = user.ultimatepush.driver

    [[hardware]]
        station_types = WS1

        [[[WS1]]]
            role = main

[WS1]
    driver = weewx.drivers.ws1
    mode = serial
    port = /dev/ttyUSB0
```

The `[WS1]` section belongs to that driver and is read by it, exactly as it would be if
it were the only driver WeeWX ran, so `weectl device` keeps working on it. What goes
under `[[hardware]]` belongs to this one: see [Hosted hardware](Hosted-hardware).

## Finding the port, or the address

Over a cable, the name to put in `port` is whichever device the adapter appears as:

```bash
ls -l /dev/serial/by-id/
```

Use the name under `by-id` rather than `/dev/ttyUSB0`. It is made from the adapter's
own manufacturer and serial number, so it survives a reboot and anything else being
plugged in.

Over the network, `host` is the console's address or hostname. Give it a fixed
address in your router, or it will move and stop being found.

The web interface offers the serial devices this machine has as a list.

## Every option

Straight out of `weewx.drivers.ws1`, with what its author wrote above each one.

#### mode

Driver mode - tcp, udp, or serial

One of `serial`, `tcp`, `udp`.

Default is `serial`.

#### port

If serial, specify the serial port device. (ex. /dev/ttyS0, /dev/ttyUSB0,
or /dev/cuaU0)
If TCP, specify the IP address and port number. (ex. 192.168.36.25:3000)

Default is `/dev/ttyUSB0`.

#### timeout

The amount of time, in seconds, before the connection fails if there is
no response

Default is `3`.

#### driver

The driver to use:

Default is `weewx.drivers.ws1`.

## More than one station

This driver is one station among however many others. Which of them fills `outTemp`, and
where the rest of their readings go, is in [Several stations](Several-stations).