# Guide



# Interface Overview

[![awh-guide-overview.png](https://osr.wiki/uploads/images/gallery/2024-02/scaled-1680-/awh-guide-overview.png)](https://osr.wiki/uploads/images/gallery/2024-02/awh-guide-overview.png)

1. **Listening Port** - Specify the port for Ayva WebSocket Hub to monitor incoming connections. Any [TCode](https://osr.wiki/books/communication-protocols/page/tcode "TCode") received on this port will be routed to the connected outputs. Click the *Start* button to begin monitoring for incoming connections. Data forwarding will commence immediately upon establishing a connection.
2. **Add Output** - Use this dropdown menu to select and add output streams.
3. **Outputs** - This table lists all configured outputs—which are saved across sessions—along with their connection status. You can enable or disable streaming to any listed output by using the checkbox in the *Enabled* column.
4. **Incoming Connection State** - This indicates the status of the incoming connection, which can be *Disconnected*, *Listening* or *Connected.*
5. **Patreon Link** - Ayva Software is supported by the community. This is a link to the [Patreon](https://patreon.com/soritesparadox).

# Output Types

[![awh-guide-outputs.png](https://osr.wiki/uploads/images/gallery/2024-02/scaled-1680-/awh-guide-outputs.png)](https://osr.wiki/uploads/images/gallery/2024-02/awh-guide-outputs.png)

There are two main types of outputs: **Network** and **Serial**.

##### **Network**

[![add-buss-driver-serial.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/add-buss-driver-serial.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/add-buss-driver-serial.PNG)

Network outputs enable connections to devices or software via [TCP](https://en.wikipedia.org/wiki/Transmission_Control_Protocol) or [UDP](https://en.wikipedia.org/wiki/User_Datagram_Protocol) protocols. In TCP mode, Ayva WebSocket Hub attempts to establish a connection to a WebSocket at the `/ws` endpoint on the specified host and port. In UDP mode, packets are sent directly to the designated host and port. Note that because UDP is *connectionless*, a UDP output will always be displayed as *Connected*, even if no application or device is actively listening at the specified host and port.

TCP is typically used to connect to WiFi-enabled devices, while UDP is typically used to stream to a [Virt-a-mate](https://osr.wiki/books/glossary/page/virt-a-mate) plugin such as [BusDriver](https://osr.wiki/books/busdriver) (though it can also be used for WiFi-enabled devices that support UDP).

##### **Serial**

**[![awh-guide-3.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/awh-guide-3.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/awh-guide-3.PNG)**

**[![awh-guide-4.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/awh-guide-4.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/awh-guide-4.PNG)**

Serial outputs facilitate device connections via the Serial protocol, typically through USB. However, they can also operate over [virtual serial ports](https://en.wikipedia.org/wiki/Virtual_COM_port) that emulate physical connections for other protocols, including Bluetooth Classic.

# Appendix

##### **To be incorporated into the Guide**

[![awh-guide-5.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/awh-guide-5.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/awh-guide-5.PNG)

[![awh-guide-6.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/awh-guide-6.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/awh-guide-6.PNG)

[![add-buss-driver-serial.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/add-buss-driver-serial.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/add-buss-driver-serial.PNG)

[![virt-a-mate bus driver.png](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/virt-a-mate-bus-driver.png)](https://osr.wiki/uploads/images/gallery/2023-11/virt-a-mate-bus-driver.png)

[![serial-bus-driver-streaming.PNG](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/serial-bus-driver-streaming.PNG)](https://osr.wiki/uploads/images/gallery/2023-11/serial-bus-driver-streaming.PNG)

##### **Example**: Streaming from Ayva Stroker Lite

[![ayva-stroker-awh-1.png](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/ayva-stroker-awh-1.png)](https://osr.wiki/uploads/images/gallery/2023-11/ayva-stroker-awh-1.png)

[![ayva-stroker-awh.png](https://osr.wiki/uploads/images/gallery/2023-11/scaled-1680-/ayva-stroker-awh.png)](https://osr.wiki/uploads/images/gallery/2023-11/ayva-stroker-awh.png)