From bb87eb3ffa6b55dae5a7f8d62e66e06eec510355 Mon Sep 17 00:00:00 2001
From: equilet <jml@dabkitsch.com>
Date: Wed, 23 May 2018 01:43:16 -0500
Subject: [PATCH] updated docs for first day

---
 max/software_API.txt           |  4 +--
 max/software_documentation.txt | 59 ++++++++++++++++++++++++++--------
 2 files changed, 48 insertions(+), 15 deletions(-)

diff --git a/max/software_API.txt b/max/software_API.txt
index e3121ed..89196be 100644
--- a/max/software_API.txt
+++ b/max/software_API.txt
@@ -6,10 +6,10 @@ output:
 
 		/m1/min
 		/m1/max
-		/m1/freq
+		/m1/freq - disabled in summon mode
 		/m2/min
 		/m2/max
-		/m2/freq
+		/m2/freq - disabled in summon mode
 
 	cardioid spread
 
diff --git a/max/software_documentation.txt b/max/software_documentation.txt
index ad7b7e3..dd063ba 100644
--- a/max/software_documentation.txt
+++ b/max/software_documentation.txt
@@ -2,8 +2,8 @@
 
 ==========================================================
 
-cardioid_modulate~ (frequency of virtual leslie)
-
+cardioid_modulate~ (virtual leslie)
+  
     - used in "migrate" & "summon" modes
     - alters delays incoming signals in two stages and forwards to three outputs of zpn pod
 
@@ -11,22 +11,22 @@ Param nodes @m1 @m2 (modulation 1 and modulation 2)
 
     values are passed through the right inlet
 
-namespace: 
+Namespace: 
 
-    /m1/freq
+    /m1/freq (overloaded in summon mode)
     /m1/min (in ms)
     /m1/max (in ms)
 
-    /m2/freq 
+    /m2/freq (overloaded in summon mode)
     /m2/min (in ms)
     /m2/max (in ms)
 
 To address a particular pod:
 
-    /client<id>/gesture/summon/m1/freq : <val>
+    /client<id>/gesture/summon/m1/freq : overloaded
     /client<id>/gesture/summon/m1/min : <val>
     /client<id>/gesture/summon/m1/max : <val>
-    /client<id>/gesture/summon/m1/freq : <val>
+    /client<id>/gesture/summon/m1/freq : overloaded
     /client<id>/gesture/summon/m1/min : <val>
     /client<id>/gesture/summon/m1/max : <val>
 
@@ -37,22 +37,55 @@ To address a particular pod:
     /client<id>/hover/migrate/m1/min : <val>
     /client<id>/hover/migrate/m1/max : <val>
 
-example:
+Example:
 
     /client1/gesture/summon/m1/max : 0.4
     /client*/gesture/summon/m1/max : 5
 
-recommended defaults:
+Recommended defaults:
 
     /m*/min: 0.
     /m*/max: 8.
-    /m*/freq : ?
+    /m1/freq : 0.1
+    /m2/freq : 0.3
+
+==========================================================
+
+cardioid_spread
+
+/p1/freq
+/p2/freq
+
+==========================================================
+
+cardioid_phasewrap
+
+/freq
+/phase/offset/max/ms
 
 ==========================================================
 
-slip mode / frequencies
+Slip mode / frequencies
+
+    - used when user sends data in slip mode
+
+Param nodes:
+
+    n/a
+
+Namespace:
+
+    /scale/min (in hz)
+    /scale/max (in hz)
+
+To address a particular pod:
+
+    /client<id>/hover/slip/scale/min : <val>
+    /client<id>/hover/slip/scale/max : <val>
+
+Example:
 
+    /client1/hover/slip/scale/min : 25
+    /client1/hover/slip/scale/max : 240
 
 =================================================
-- what would be great is sending me open patches and not closed ones. Especially the patch of the main computer.
-This would be for connecting an exterior midi or osc controller like the ipad we had in berkley (volumes, preset & gestures change).
-- 
2.34.1