Oscgard

Getting started

1. Install the mod

   • via maiden

     ;install https://github.com/sasha-ilatovskii/oscgard

   • git clone to dust

     cd ~/dust/code && git clone https://github.com/sasha-ilatovskii/oscgard

   • download zip and extract to dust/code
2. Enable it in SYSTEM > MODS and restart the norns
3. Get and run a client app

   You need an OSC app that implements the oscgard/serialosc device protocol.
   See compatible clients below.

4. Discover devices

   Open the oscgard mod menu on norns (SYSTEM > MODS > OSCGARD).
   It will scan your network for OSC devices.

5. Assign virtual device to a port

   Choose grid or arc, and vport to use (1-4) and pick the discovered device from the list.

6. Patch your script

   Add the include line at the top of your script to route API calls through oscgard

   • for grid

     local grid = include("oscgard/lib/grid")

   • for arc

     local arc = include("oscgard/lib/arc")

7. You're good and have the emulated device up and running!

Built for WiFi

One message per refresh. 128x fewer packets than other emulators.
Any rate, no tearing.

• Messages for full refresh
  Others: up to 128oscgard: 1
• Bytes for full refresh
  Others: ~2,560oscgard: ~140
• Atomicity
  Others: Sequentialoscgard: Atomic
• Refresh rate
  Others: -oscgard: Adjust to your network

Drop-in API

Oscgard provides drop-in replacements for the norns grid and arc modules. The API is identical to real hardware.

-- Example script for Grid emulation
local grid = include("oscgard/lib/grid")
-- or with hardware fallback
-- local grid = util.file_exists(_path.code.."oscgard") and include("oscgard/lib/grid") or grid
local g = grid.connect()

g.key = function(x, y, z)
  g:led(x, y, z * 15)
  g:refresh()
end

-- Example script for Arc emulation
local arc = include("oscgard/lib/arc")
-- or with hardware fallback
-- local arc = util.file_exists(_path.code.."oscgard") and include("oscgard/lib/arc") or arc
local a = arc.connect()
local pos = {}
a.delta = function(n, d)
  -- light up ring led based on rotation
  if pos[n] == nil then
    pos[n] = 0
  end
  pos[n] = (pos[n] + d) % 64
  a:led(n, pos, 15)
  a:refresh()
end