https://github.com/spacebro/spacebrosc
converts OSC bundles to spacebro events.
https://github.com/spacebro/spacebrosc
Last synced: over 1 year ago
JSON representation
converts OSC bundles to spacebro events.
- Host: GitHub
- URL: https://github.com/spacebro/spacebrosc
- Owner: spacebro
- Created: 2017-02-04T19:49:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T10:04:55.000Z (over 7 years ago)
- Last Synced: 2025-01-21T21:46:26.638Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# spacebrOsc
Converts OSC bundles to spacebro events.
### Usage
spacebrOsc is meant to be used as is. You install it, provide a custom configuration file and run it.
##### Install
```sh
$ git clone git@github.com:spacebro/spacebrOsc.git
$ cd spacebrOsc/
$ npm i
```
##### Eventually use custom settings
```sh
$ cp settings/settings.default.js settings/settings.js
$ vim settings/settings.js
```
##### Run
```sh
$ node index.js
```
### Settings
```js
{
"verbose": false, // does spacebrOsc logs everything or not
"useCustomEventName": 'my-custom-event',
// if set to false, OSC message address will be used as spacebro event name
// else, provide a string that will be the event name and OSC message address will be sent as data
"spacebro": {
"host": "127.0.0.1", // host of your spacebro server
"port": 8888, // port of your spacebro server
"channelName": "spacebrosc" // channel name you want to use (optionnal)
},
"osc": {
"localAddress": "0.0.0.0",
// on which local ip do you want to open an UDP socket for your OSC sending app to connect
"localPort": 12345 // on which port you open that UDP socket
}
}
```
### Example
If you don't have an OSC sending app, you can test with the `tools/osc-emitter.js` script. Just make sure the settings matches.