Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dndrks authored Jan 19, 2024
1 parent 151cc4f commit 666fb42
Showing 1 changed file with 33 additions and 34 deletions.
67 changes: 33 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,43 +43,42 @@ To replace `[serialosc]` with `[monome-device]` in an older patch:
### Grid Studies

We've included 10 `grid-studies-X-x.maxpat` files to illustrate best-practices for patching with grid. Please refer to [the full companion text](https://monome.org/docs/grid/studies/max/) as you navigate.

## Patchers: crow

### Connectivity

The `[crow]` patcher connects a [crow](https://monome.org/docs/crow/) hardware module to Max. Via USB, `[crow]` can send and receive CV, talk to other devices connected to crow hardware via I2C, send Lua chunks to execute immediately, and send scripts to load into crow's flash.

### Help

Right-click `[crow]` and select *Open crow Help*, which will reveal:

- **anatomy**: demonstration of the necessary signal flow to start patching with crow in Max
- **basic cv input**: showcases reading CV through crow’s two hardware inputs either on-demand, as a stream, or when a signal crosses a specified threshold
- **adv cv input**: quantize incoming CV to a scale of semitones
- **basic cv output**: setting CV slew target voltages for crow’s 4 hardware outputs, and introduces `sprintf` techniques to help assign values dynamically
- **cv notes**: showcases MIDI-to-CV translation for v/8 notemaking, and introduces `pulse` and `ar` commands
- **cv shapes**: introduction to actions as user-definable envelopes/LFOs
- **quantize output**: quantize crow's output to a specific scale
- **i2c**: demonstrates i2c connectivity and simple interactions with Just Friends (Whimsical Raps), translatable to any i2c device that has pre-defined Teletype interactions (w/, Ansible, ER-301, Disting EX, etc)
- **^^**: an index of system commands that report on connected hardware + flash new scripts to the module

### Library

In addition to `[crow]`, there are many helper objects which can aid in development of crow Max and Max for Live applications. Each object comes with its own help-patcher and built in Max reference page.

- `crow.volts`: directly set one of crow’s outputs to a voltage (with an optional slew time)
- `crow.inputs`: a bpatcher gui to easily access data from crow’s inputs within Max
- `crow.ar`: easily configure and trigger an attack-release envelope on any of crow’s outputs
- `crow.adsr`: easily configure and trigger an ADSR envelope on one of crow’s outputs
- `crow.var`: assign a value, table, variable, or function return to a variable (or to an element of a table)
- `crow.function`: tell crow to execute a function, or generate a function call to pass to another crow. object.
- `crow.dyn`: quickly format a dynamic variable.
- `crow.n2v`: convert semitones to V/oct voltage levels.

## Patchers: crow

### Connectivity

The `[crow]` patcher connects a [crow](https://monome.org/docs/crow/) hardware module to Max. Via USB, `[crow]` can send and receive CV, talk to other devices connected to crow hardware via I2C, send Lua chunks to execute immediately, and send scripts to load into crow's flash.

### Help

Right-click `[crow]` and select *Open crow Help*, which will reveal:

- **anatomy**: demonstration of the necessary signal flow to start patching with crow in Max
- **basic cv input**: showcases reading CV through crow’s two hardware inputs either on-demand, as a stream, or when a signal crosses a specified threshold
- **adv cv input**: quantize incoming CV to a scale of semitones
- **basic cv output**: setting CV slew target voltages for crow’s 4 hardware outputs, and introduces `sprintf` techniques to help assign values dynamically
- **cv notes**: showcases MIDI-to-CV translation for v/8 notemaking, and introduces `pulse` and `ar` commands
- **cv shapes**: introduction to actions as user-definable envelopes/LFOs
- **quantize output**: quantize crow's output to a specific scale
- **i2c**: demonstrates i2c connectivity and simple interactions with Just Friends (Whimsical Raps), translatable to any i2c device that has pre-defined Teletype interactions (w/, Ansible, ER-301, Disting EX, etc)
- **^^**: an index of system commands that report on connected hardware + flash new scripts to the module

### Library

In addition to `[crow]`, there are many helper objects which can aid in development of crow Max and Max for Live applications. Each object comes with its own help-patcher and built in Max reference page.

- `crow.volts`: directly set one of crow’s outputs to a voltage (with an optional slew time)
- `crow.inputs`: a bpatcher gui to easily access data from crow’s inputs within Max
- `crow.ar`: easily configure and trigger an attack-release envelope on any of crow’s outputs
- `crow.adsr`: easily configure and trigger an ADSR envelope on one of crow’s outputs
- `crow.var`: assign a value, table, variable, or function return to a variable (or to an element of a table)
- `crow.function`: tell crow to execute a function, or generate a function call to pass to another crow. object.
- `crow.dyn`: quickly format a dynamic variable.
- `crow.n2v`: convert semitones to V/oct voltage levels.

--

Special thanks to Cycling '74 for supporting our continued explorations. In loving memory of Darwin Grosse.

May 2023
http://monome.org

0 comments on commit 666fb42

Please sign in to comment.