Skip to content

Commit

Permalink
norns: 'preset' -> 'parameter set' / 'PSET'
Browse files Browse the repository at this point in the history
  • Loading branch information
dndrks committed Oct 25, 2024
1 parent 0527ce6 commit a0c0894
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion norns/help/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For support with specific scripts and libraries, please visit [lines](https://ll

## back up norns

All data that you create with norns -- scripts you've downloaded or created, audio you've imported or recorded, MIDI mappings and presets, etc -- is stored in a central location: `dust`.
All data that you create with norns -- scripts you've downloaded or created, audio you've imported or recorded, MIDI mappings and PSETs, etc -- is stored in a central location: `dust`.

### via WiFi

Expand Down
6 changes: 3 additions & 3 deletions norns/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ nav_exclude: true

# file management on norns

There are a few types of data that you will collect on norns: projects / apps, sound files, and presets. All of these live inside of **dust**, a special folder in norns.
There are a few types of data that you will collect on norns: projects / apps, sound files, and PSETs / PMAPs. All of these live inside of **dust**, a special folder in norns.

In the [maiden](../maiden) section, we reviewed how to write scripts of your own and how to download scripts from the community. These changes all commit to `dust`, but maiden is not the best way to exchange files between your computer and norns.

### wifi-powered file transfers

These tools can help you confidently add, change, transfer, and remove files from norns:

- [file share](../fileshare): samba is a protocol which allows you to connect norns to a computer (via WiFi) and browse the contents of norns like you would a thumb drive. Use this to import/export audio files or to back up your scripts and presets.
- [file share](../fileshare): samba is a protocol which allows you to connect norns to a computer (via WiFi) and browse the contents of norns like you would a thumb drive. Use this to import/export audio files or to back up your scripts and PSETs.
- [SFTP](/docs/norns/advanced-access/#sftp): A client which allows you to connect norns to a PC or Mac (via WiFi) and browse the contents of norns like you would a thumb drive. Same uses as above.

Please click either link above to learn more about each method.

### no wifi? (mac + linux)

For times when you are unable to connect norns to WiFi (no dongle, no network, etc), you can back up **dust** to a USB drive. **dust** includes your scripts, sound files, and presets.
For times when you are unable to connect norns to WiFi (no dongle, no network, etc), you can back up **dust** to a USB drive. **dust** includes your scripts, sound files, and PSETs.

First, connect norns to your computer via its power cable. Then, open a terminal and type:

Expand Down
12 changes: 6 additions & 6 deletions norns/play.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,31 +228,31 @@ Scrolling down further, we find some of the script's parameters. These are chose

**To fine-adjust a parameter, hold K3 as you turn E3.** If the parameter is linearly or exponentially scaled (eg. LEVELS > OUTPUT), this will adjust the value by 1/20th of its usual delta step.

### saving presets
### saving parameter sets {#saving-PSETs}

To recall and build on the changes you've made in a future session, we can save a script's parameter state as a PSET (preset).
To recall and build on the changes you've made in a future session, we can save a script's parameter state as a PSET (ParameterSET).

![](/docs/norns/image/play-images/menu-params_pset.png)
[*figure 5: saving parameters / PSET*](image/play-images/menu-params_pset.png)
[*figure 5: saving parameter sets / PSET*](image/play-images/menu-params_pset.png)

Use **E2** to navigate down the left column of the PSET screen.
Use **E3** to navigate down the right.
The currently loaded PSET will have an asterisk * next to it.

**save preset / PSET**
**save PSET**

- select `SAVE` and press **K3** to open the naming dialogue
- use **E3** to switch to the alphabet and **E2** to choose letters
- **K3** enters the selected letter
- use **E3** to navigate back to the controls (use **E2** and **K3** on `DEL` to delete a letter)
- press **K3** on `OK` to save

**load preset / PSET**
**load PSET**

- select `LOAD` and use **E3** to choose a saved PSET
- press **K3** to load the selected PSET

**delete preset / PSET**
**delete PSET**

- select `DELETE` and use **E3** to choose a saved PSET
- press **K3** to delete the selected PSET
Expand Down
2 changes: 1 addition & 1 deletion norns/reference/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ Will print:

### PSET save/load/delete callback

Parameters are designed to make MIDI mapping and saving control values for a script very straightforward, using the [PMAP](/docs/norns/control-clock/#pmaps) and [PSET](/docs/norns/play/#saving-presets) functionality. However, you may find that you need to generate and save data which doesn't fit the parameters model, like tables of sequencer steps (though `awake` does show [how to efficiently work with patterns as parameters](https://github.com/tehn/awake/blob/73d4accfc090aaab58f1586eaf4d9cf54d3cff01/awake.lua#L62-L86)).
Parameters are designed to make MIDI mapping and saving control values for a script very straightforward, using the [PMAP](/docs/norns/control-clock/#pmaps) and [PSET](/docs/norns/play/#saving-PSETs) functionality. However, you may find that you need to generate and save data which doesn't fit the parameters model, like tables of sequencer steps (though `awake` does show [how to efficiently work with patterns as parameters](https://github.com/tehn/awake/blob/73d4accfc090aaab58f1586eaf4d9cf54d3cff01/awake.lua#L62-L86)).

If you wish to perform additional actions when a PSET is saved, loaded or deleted, such as managing non-params data into your script, `params.action_write` / `params.action_read` / `params.action_delete` are script-definable callback functions which are triggered whenever a PSET is saved, loaded, or deleted. Here's a quick overview of their use:

Expand Down
10 changes: 5 additions & 5 deletions norns/study-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ It might help to approach these from a user perspective first -- take a minute t
- parameters surface variables from our code to the norns UI as readable names
- parameters facilitate MIDI mapping of these variables + recall the mapping when the script is reloaded
- parameter ID's facilitate OSC control over these variables
- parameters can be saved through the preset / PSET mechanism, to capture and recall unique script states
- parameter values can be saved through the PSET mechanism, to capture and recall unique script states

### defining a parameter

Expand Down Expand Up @@ -826,9 +826,9 @@ end

This code snippet will print `49` to the REPL, whereas commenting out the `params:bang()` will result in no print at script start.

### presets
### PSETs

As mentioned at the start of this section, parameters are especially powerful because their states can be saved and restored. While it's easy enough to save, load, and manage presets through the norns UI, perhaps you'll want to play around with preset functions through code.
As mentioned at the start of this section, parameters are especially powerful because their states can be saved and restored. While it's easy enough to save, load, and manage parameter sets through the norns UI, perhaps you'll want to play around with PSET functions through code.

Run the `parameters pt.3` code and adjust the cutoff value to taste. Let's save this state by executing the following on the command line:

Expand All @@ -838,7 +838,7 @@ Run the `parameters pt.3` code and adjust the cutoff value to taste. Let's save

Here's what we did:

- told the `params` system to `write` a new preset (PSET)
- told the `params` system to `write` a new PSET
- specified slot `1` as the destination
- specified `later` as the name for the PSET

Expand All @@ -852,7 +852,7 @@ You can similarly load any PSET slot with:
>> params:read(1)
```

After a read, the norns system will cycle through every parameter to set its value to the preset's values, but it won't perform the `action` function. In order to pass the preset's values through the parameter's actions, you'll need to include a `params:bang()`, which triggers every parameter.
After a read, the norns system will cycle through every parameter to set its value to the PSET's values, but it won't perform the `action` function. In order to pass the PSET's values through the parameter's actions, you'll need to include a `params:bang()`, which triggers every parameter.

```lua
>> params:read(1)
Expand Down
4 changes: 2 additions & 2 deletions norns/wifi-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ If filesystem expansion doesn't resolve the issue (or if you know you have a *lo

## transfer

In [**play**](/docs/norns/play), we loaded loops and recorded our own audio using the **TAPE**. All of the files that you interact with (audio, scripts, presets, etc), live inside a special folder in norns called `dust`.
In [**play**](/docs/norns/play), we loaded loops and recorded our own audio using the **TAPE**. All of the files that you interact with (audio, scripts, PSETs, etc), live inside a special folder in norns called `dust`.

Here's the `dust` file tree:

Expand Down Expand Up @@ -183,7 +183,7 @@ norns records 48khz stereo WAV files -- please only import uncompressed 48kHz fi

If you have edited any scripts to your own needs, or written any scripts of your own, please make sure you’ve copied those files to another computer or web repository.

If you have only downloaded scripts from others (or have already backed up your own scripts/modifications) and wish to retain audio files, script presets, midi mappings, etc, simply copy your entire `audio` and `data` folders, which live inside of `dust`, via Samba (as described above) or [SFTP](/docs/norns/advanced-access/#sftp).
If you have only downloaded scripts from others (or have already backed up your own scripts/modifications) and wish to retain audio files, script PSETs, midi mappings (PMAPs), etc, simply copy your entire `audio` and `data` folders, which live inside of `dust`, via Samba (as described above) or [SFTP](/docs/norns/advanced-access/#sftp).

Restoring from this backup is as simple as copying the contents of the folders from your non-norns computer back to the `/home/we/dust/audio` and `/home/we/dust/data` directories on norns.

Expand Down

0 comments on commit a0c0894

Please sign in to comment.