2023 update

.gitignore

@@ -0,0 +1,6 @@
+
+docs/.DS_Store
+docs/grid-studies/.DS_Store
+javascript/.DS_Store
+patchers/.DS_Store
+docs/grid-studies/images/.DS_Store

README.md

@@ -1,32 +1,50 @@
-# Monome package for Max 7.
+# monome device package for Max
 
 Tools for using adaptable hardware interfaces.
 
-## Applications
+Before using these patchers, please install [serialosc](https://monome.org/docs/serialosc) on your computer.
 
-* meadowphysics - rhizomatic cascading counter (grid)
-* flin - cyclic polyrhythm music box (grid)
-* step - live step sequencer (grid)
-* corners - performative physics-based controller generator (grid)
+## Patchers
 
-* returns - knob routing with integrated LFOs (arc)
+### Connectivity
+
+The `[monome-device]` [bpatcher](https://docs.cycling74.com/max8/refpages/bpatcher) connects monome devices to Max.
+
+`[monome-device]` is designed as *Paste Replace* substitute for the historical `[serialosc]` bpatcher. It supports all of the expected commands, but with protections against overloading the serial bus with non-FTDI (2021 and after) grids. Instead of allowing hundreds of `led` messages to pass over the bus simultaneously, `[monome-device]` uses a 120 fps redraw mechanism which converts `led` messages into more-efficient `map` messages.
+
+To replace `[serialosc]` with `[monome-device]` in an older patch:
+
+- unlock the patch and locate the `[serialosc]` bpatcher
+- open the Inspector Window for the bpatcher and take note of any *Arguments* assigned to the `[serialosc]` instance (we'll refer to this string as `<arguments>`)
+- open a blank patcher and instantiate a new object:
+  - if there were `<arguments>`,  enter `bpatcher monome-device @args <arguments>`
+  - if there were no `<arguments>`,  enter `bpatcher monome-device`
+- if you hit <kbd>ENTER</kbd>, you'll see the monome device dropdown populate
+- copy this `[monome-device]` instance and in your original patch, right-click the `[serialosc]` instance and select *Paste Replace*
+
+### Instruments
+
+- `meadowphysics` - rhizomatic cascading counter (grid)
+- `flin` - cyclic polyrhythm music box (grid)
+- `step` - live step sequencer (grid)
+- `corners` - performative physics-based controller generator (grid)
+- `grid-midi` - isomorphic keyboard
+- `returns` - knob routing with integrated LFOs (arc)
 
 ## Testing and How-to
 
-* grid-test
-* grid-howto
-* arc-test
-* arc-howto
+- `grid-test` - confirms grid keypresses are registering to Max and redrawing on your hardware
+- `grid-howto` - demonstrates some introductory patching techniques for grid
+- `arc-test` - confirms arc interactions are registering to Max and redrawing on your hardware
+- `arc-howto` - demonstrates some introductory patching techniques for arc
 
 ## Grid Studies
 
-An in-depth tutorial on patching for the grid.
-
+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.
 
 --
-More coming soon!
 
-Special thanks to Darwin Grosse and Cycling 74 for supporting our continued exploration.
+Special thanks to Cycling '74 for supporting our continued explorations. In loving memory of Darwin Grosse.
 
-November 2015
-http://monome.org
+May 2023  
+http://monome.org

docs/grid-studies/files/grid-studies-1-1.maxpat

@@ -2,14 +2,15 @@
 	"patcher" : 	{
 		"fileversion" : 1,
 		"appversion" : 		{
-			"major" : 7,
-			"minor" : 0,
-			"revision" : 3,
-			"architecture" : "x86",
+			"major" : 8,
+			"minor" : 5,
+			"revision" : 4,
+			"architecture" : "x64",
 			"modernui" : 1
 		}
 ,
-		"rect" : [ 38.0, 79.0, 862.0, 632.0 ],
+		"classnamespace" : "box",
+		"rect" : [ 38.0, 100.0, 862.0, 632.0 ],
 		"bglocked" : 0,
 		"openinpresentation" : 0,
 		"default_fontsize" : 12.0,
@@ -36,7 +37,20 @@
 		"tags" : "",
 		"style" : "",
 		"subpatcher_template" : "",
+		"assistshowspatchername" : 0,
 		"boxes" : [ 			{
+				"box" : 				{
+					"id" : "obj-75",
+					"linecount" : 2,
+					"maxclass" : "comment",
+					"numinlets" : 1,
+					"numoutlets" : 0,
+					"patching_rect" : [ 9.5, 588.0, 160.0, 33.0 ],
+					"text" : "grid studies: max 1-1\nhttp://monome.org"
+				}
+
+			}
+, 			{
 				"box" : 				{
 					"args" : [ "/monome" ],
 					"bgmode" : 0,
@@ -46,12 +60,13 @@
 					"enablevscroll" : 0,
 					"id" : "obj-1",
 					"lockeddragscroll" : 0,
+					"lockedsize" : 0,
 					"maxclass" : "bpatcher",
-					"name" : "serialosc.maxpat",
-					"numinlets" : 2,
-					"numoutlets" : 4,
+					"name" : "monome-device.maxpat",
+					"numinlets" : 3,
+					"numoutlets" : 6,
 					"offset" : [ 0.0, 0.0 ],
-					"outlettype" : [ "", "int", "", "" ],
+					"outlettype" : [ "", "int", "", "", "", "" ],
 					"patching_rect" : [ 30.0, 396.0, 200.0, 22.0 ],
 					"varname" : "serialosc",
 					"viewvisibility" : 1
@@ -61,21 +76,21 @@
  ],
 		"lines" : [  ],
 		"dependency_cache" : [ 			{
-				"name" : "serialosc.maxpat",
-				"bootpath" : "~/Work/web/monome.github.io/docs/grid-studies/max/files",
-				"patcherrelativepath" : ".",
-				"type" : "JSON",
+				"name" : "monome-device.js",
+				"bootpath" : "~/Documents/GitHub/monome-max-package/patchers",
+				"patcherrelativepath" : "../../../patchers",
+				"type" : "TEXT",
 				"implicit" : 1
 			}
 , 			{
-				"name" : "serialosc.js",
-				"bootpath" : "~/Work/web/monome.github.io/docs/grid-studies/max/files",
-				"patcherrelativepath" : ".",
-				"type" : "TEXT",
+				"name" : "monome-device.maxpat",
+				"bootpath" : "~/Documents/GitHub/monome-max-package/patchers",
+				"patcherrelativepath" : "../../../patchers",
+				"type" : "JSON",
 				"implicit" : 1
 			}
  ],
-		"embedsnapshot" : 0
+		"autosave" : 0
 	}
 
 }