oscanity 0.2.0

Lightweight command-line tools for sending and receiving OSC messages
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# OSCanity
Sanity for OSC. See what I did there?

![oscanity in action](./docs/oscanity-demo.gif)

OSCanity is a command-line utility for testing sending and receiving [OSC](http://opensoundcontrol.org/) messages.

## Usage
### Running the executables
If you have downloaded the compiled [release](https://github.com/anselanza/oscanity/releases) binaries, you can simply run either executable from your command-line, e.g. `./send` or `./receive`

If you have cloned/downloaded the source code instead, you can use `cargo run --bin release` or `cargo run --bin send`

### Receiving
Example command - listen for incoming OSC messages:
```
./receive 0.0.0.0:12345
```
This would listen on all network interfaces (`0.0.0.0` on the port `12345`). Substitute your own values (especially the port) as needed.

### Sending
#### Configure
Example command - send messages OSC messages to localhost:
```
./send 127.0.0.1:12345
```
This sets up a default "sending" host of `127.0.0.1:8080`, and sends OSC messages to the destination `127.0.0.1:12345` (in this case localhost).

If you need it, you can include the host address as well:
```
./send 192.168.1.130:5555 127.0.0.1:12345
```
Now the "sending" host is `192.168.1.130:555` and the destination is as before.

#### Now, send messages
The sending CLI does *nothing* at first (apart from validating any address settings).

Type messages in the format `address/ arg1 arg2 ...` followed by Enter/Return.

OSC types for messages are auto-detected. For example, the command:
```
/test hello 1 2 3.0 four
```
... will produce an OSC message with the address `/test` followed by 5 arguments, each with the expected type:
```
final args: [String("hello"), Int(1), Int(2), Float(3.0), String("four")]
```

## Background
This is my first working software written in Rust, so be nice.

The hard stuff is done by the library I am depending on here, [rosc](https://github.com/klingtnet/rosc) - "an implementation of the OSC 1.0 protocol in pure Rust".