TINYWOLF(5)

2024-05-07

NAME

Tinywolf - configuration file format for routing OSC messages

DESCRIPTION

The configuration file for Tinywolf defines the application's behavior. It is written in the YAML format. The top-level keys are all optional. These are the top-level keys used in Tinywolf:

aggregates

This is a dictionary mapping aggregate device names to a list of device names and target address literals (both represented as a string). An aggregate device will forward an incoming message to all the targets specified.

devices

This is a dictionary mapping device names to an IP/hostname and port. The target address is represented as a string.

port

Defines the UDP port where to listen for incoming OSC messages.

verbosity

Sets the level of verbosity. This is a number between 0 and 7 describing the amount of logs printed.

Level Description
0 Trace
1 Debug
2 Info
3 Notice
4 Warn
5 Error
6 Fatal
7 None

EXAMPLES


port: 10900
verbosity: 2
devices:
  dev1: abc.xyz:1234
  dev2: 192.168.0.42:42069
  dev3: 127.0.0.1:1337
aggregates:
  a1:
    - dev1
    - dev2
    - 10.0.0.1:7353

SEE ALSO

tinywolf(1)

STANDARDS

These configuration files are encoded using YAML version 1.1.

AUTHORS

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/tinywolf. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.