Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

231117 update #414

Merged
merged 10 commits into from
Nov 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion norns/control-clock.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ norns will remember these devices until they're manually removed, even if they a

### manage

Let's say we're running a sequencer and we want to send MIDI out a connected USB-MIDI interface. The device list in [figure 1](image/control_clock-images/device-management.png) shows a `16n` at port 1, but we want this to be the `UM-ONE`.
Let's say we're running a sequencer and we want to send MIDI out a connected USB-MIDI interface. The device list in [figure 1](image/control_clock-images/device-management.png) shows a `16n` at port 1, but we want this to be the `MFT` (MIDI Fighter Twister).

If a script doesn't allow you to specify a MIDI device port for incoming or outgoing MIDI, the script will default to the device at port 1.
{: .label}
Expand Down Expand Up @@ -107,6 +107,8 @@ To MIDI-learn:

- **accum**: enable when using relative midi cc streams (for controllers that send deltas rather than 0-127 absolute streams)

- **echo**: enable when using devices which can receive MIDI values to redraw LEDs or stateful text (eg. MIDI Fighter Twister or Faderfox EC4)

#### PMAPs

Every time a parameter is mapped, norns will save this configuration as a PMAP file. PMAPs are unique to the currently-loaded script and are stored under `data/[scriptname]/[scriptname].pmap`.
Expand Down
Binary file modified norns/image/control_clock-images/device-map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added norns/image/play-images/display.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions norns/play.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,11 +344,25 @@ The SYSTEM menu contains a number of helpful entries:
- `SETTINGS` allows you to:
- `RESET` your norns back to its default settings, erasing your favorites, disabling all mods, and restoring global audio levels to their defaults.
- change your [`PASSWORD`](/docs/norns/wifi-files/#settings-password) for SSH, SMB, and hotspot
- tune the `DISPLAY` brightness, contrast, and gamma
- toggle the on-screen `BATTERY WARNING` on and off
- `RESTART` will restart the unit without erasing any settings
- `UPDATE` will perform a [system update](/docs/norns/wifi-files/#update), if you're connected to WiFi.
- `LOG` will export any messages and errors initiated by matron (the Lua layer), SuperCollider, and the general Linux system. If something isn't performing as expected, this mechanism is the most helpful tool for diagnosing trouble. See [the logs section of the *maiden* docs](/docs/norns/maiden/#logs) for more info.

### DISPLAY

![](/docs/norns/image/play-images/display.png)
[*figure 10: the norns DISPLAY menu*](image/play-images/display.png)

This menu allows you to fine-tune the norns display, offering adjustments for:

- BRIGHTNESS: 0 to 15, default 15
- CONTRAST: 0 to 255, default 127
- GAMMA: 1.00 to 30.00, default 1.0

Any adjustment will create and update a `system.display` file under `dust/data`. This file can be safely deleted to quickly restore defaults upon RESTART.

## where to next?

Now that you know the basics of navigating the system, adjusting a script's parameters, and recording the results, you might want to explore the [**community scripts**](/docs/norns/community-scripts) available for norns.
Expand Down
83 changes: 42 additions & 41 deletions norns/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,47 +23,48 @@ to access the complete norns API, you can either:

## commands

| Module | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [arc](arc) | Connect a script to a hardware [arc](https://monome.org/docs/arc) |
| [audio (api)](/docs/norns/api/modules/audio.html) | Directly set system audio levels |
| [clock](clock) | Coroutine system which executes functions on beat-synced and free-running schedules |
| [controlspec](controlspec) | PARAM menu control constructor with presets |
| [crow (api)](/docs/norns/api/modules/crow.html) | Connect a script to a hardware [crow](https://monome.org/docs/crow) |
| [encoders](encoders) | Decipher the norns on-board encoders |
| [engine (api)](/docs/norns/api/modules/engine.html) | Register a SuperCollider engine |
| [gamepad](gamepad) | Connect a script to a gamepad controller |
| [grid](grid) | Connect a script to a hardware [grid](https://monome.org/docs/grid) |
| [hid (api)](/docs/norns/api/modules/hid.html) | Connect a script to HID hardware |
| [keyboard](keyboard) | Decipher keyboard (typing, not piano) input |
| [metro](metro) | High-resolution time-based counter |
| [midi](midi) | Connect a script to MIDI hardware |
| [osc](osc) | Connect a script to OSC streams |
| [params](params) | Create script parameters, displayed in the PARAMETERS menu |
| [poll](poll) | System polling for CPU, incoming/outgoing amplitude, and incoming pitch |
| [screen (api)](/docs/norns/api/modules/screen.html) | Draw to the norns on-board screen |
| [softcut (api)](/docs/norns/api/modules/softcut.html) | Two audio buffers which can be recorded into and played by six individual voices |
| [tab (api)](/docs/norns/api/modules/lib.tabutil.html) | Table utilities |
| [util (api)](/docs/norns/api/modules/lib.util.html) | Helpful utility functions |
| [lib/elca (api)](/docs/norns/api/modules/lib.elca.html) | Elementary cellular automata generator |
| [lib/envgraph (api)](/docs/norns/api/modules/lib.EnvGraph.html) | Envelope graph drawing module |
| [lib/er](./lib/er) | Euclidean rhythm generator |
| [lib/fileselect](./lib/fileselect) | File select utility |
| [lib/filtergraph (api)](/docs/norns/api/modules/lib.FilterGraph.html) | Filter graph drawing module |
| [lib/filters (api)](/docs/norns/api/modules/lib.filters.html) | Value smoother |
| [lib/formatters (api)](/docs/norns/api/modules/lib.formatters.html) | PARAM menu formatter functions |
| [lib/graph (api)](/docs/norns/api/modules/lib.Graph.html) | Graph drawing module |
| [lib/intonation](./lib/intonation) | Library of various tunings, including 12 tone and gamuts |
| [lib/lattice](./lib/lattice) | Simple and extensible sequencers driven by a superclock |
| [lib/lfo](./lib/lfo) | Single-clock framework for generating movement (beat-synced or free) inside of a script |
| [lib/listselect](./lib/listselect) | List select utility |
| [lib/musicutil](./lib/musicutil) | Utility module for common music maths |
| [lib/pattern_time](./lib/pattern_time) | Timed-event pattern recorder / player |
| [lib/sequins](./lib/sequins) | Build and modify sequencers + arpeggiators |
| [lib/timeline](./lib/timeline) | Sequence events in time |
| [lib/textentry](./lib/textentry) | Text entry UI |
| [lib/ui](./lib/ui) | UI widgets module |
| [lib/voice](/docs/norns/api/modules/lib.voice.html) | Experimental voice allocation module |
| Module | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| [arc](arc) | Connect a script to a hardware [arc](https://monome.org/docs/arc) |
| [audio (api)](/docs/norns/api/modules/audio.html) | Directly set system audio levels |
| [clock](clock) | Coroutine system which executes functions on beat-synced and free-running schedules |
| [controlspec](controlspec) | PARAM menu control constructor with presets |
| [crow (api)](/docs/norns/api/modules/crow.html) | Connect a script to a hardware [crow](https://monome.org/docs/crow) |
| [encoders](encoders) | Decipher the norns on-board encoders |
| [engine (api)](/docs/norns/api/modules/engine.html) | Register a SuperCollider engine |
| [gamepad](gamepad) | Connect a script to a gamepad controller |
| [grid](grid) | Connect a script to a hardware [grid](https://monome.org/docs/grid) |
| [hid (api)](/docs/norns/api/modules/hid.html) | Connect a script to HID hardware |
| [keyboard](keyboard) | Decipher keyboard (typing, not piano) input |
| [metro](metro) | High-resolution time-based counter |
| [midi](midi) | Connect a script to MIDI hardware |
| [osc](osc) | Connect a script to OSC streams |
| [params](params) | Create script parameters, displayed in the PARAMETERS menu |
| [poll](poll) | System polling for CPU, incoming/outgoing amplitude, and incoming pitch |
| [screen (api)](/docs/norns/api/modules/screen.html) | Draw to the norns on-board screen |
| [softcut (api)](/docs/norns/api/modules/softcut.html) | Two audio buffers which can be recorded into and played by six individual voices |
| [tab (api)](/docs/norns/api/modules/lib.tabutil.html) | Table utilities |
| [util (api)](/docs/norns/api/modules/lib.util.html) | Helpful utility functions |
| [lib/elca (api)](/docs/norns/api/modules/lib.elca.html) | Elementary cellular automata generator |
| [lib/envgraph (api)](/docs/norns/api/modules/lib.EnvGraph.html) | Envelope graph drawing module |
| [lib/er](./lib/er) | Euclidean rhythm generator |
| [lib/fileselect](./lib/fileselect) | File select utility |
| [lib/filtergraph (api)](/docs/norns/api/modules/lib.FilterGraph.html) | Filter graph drawing module |
| [lib/filters (api)](/docs/norns/api/modules/lib.filters.html) | Value smoother |
| [lib/formatters (api)](/docs/norns/api/modules/lib.formatters.html) | PARAM menu formatter functions |
| [lib/graph (api)](/docs/norns/api/modules/lib.Graph.html) | Graph drawing module |
| [lib/intonation](./lib/intonation) | Library of various tunings, including 12 tone and gamuts |
| [lib/lattice](./lib/lattice) | Simple and extensible sequencers driven by a superclock |
| [lib/lfo](./lib/lfo) | Single-clock framework for generating movement (beat-synced or free) inside of a script |
| [lib/listselect](./lib/listselect) | List select utility |
| [lib/musicutil](./lib/musicutil) | Utility module for common music maths |
| [lib/pattern_time](./lib/pattern_time) | Timed-event pattern recorder / player |
| [lib/reflection](./lib/reflection) | Record clock-synced changes to data over time, with variable-rate playback, overdubbing, and pattern management tools |
| [lib/sequins](./lib/sequins) | Build and modify sequencers + arpeggiators |
| [lib/timeline](./lib/timeline) | Sequence events in time |
| [lib/textentry](./lib/textentry) | Text entry UI |
| [lib/ui](./lib/ui) | UI widgets module |
| [lib/voice](/docs/norns/api/modules/lib.voice.html) | Experimental voice allocation module |

## folder structure

Expand Down
2 changes: 1 addition & 1 deletion norns/reference/gamepad.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Deciphers gamepad input and executes user-assignable callbacks. Since many gamep
Plug + play models:

- iBUFFALO Classic USB Gamepad

- Xbox 360
- Retrolink B00GWKL3Y4 ((S)NES-style, also sold by under other brands: iNNext, Elecom...)

Contributed and maintained by [`@p3r7`](https://github.com/p3r7/)
Loading