Help - Revision history

Ground state: add category

2012-07-19T19:36:23Z

add category

Amounra at 23:54, 17 March 2012

2012-03-17T23:54:31Z

Amounra: /* Inlets */

2012-03-14T07:15:06Z

‎Inlets

Amounra: /* Inlets */

2012-03-14T07:11:24Z

‎Inlets

Amounra: /* Inlets */

2012-03-14T07:10:26Z

‎Inlets

Amounra: /* Inlets */

2012-03-14T07:07:47Z

‎Inlets

Amounra: /* Inlets */

2012-03-14T07:06:40Z

‎Inlets

Amounra: /* Creating a mod instance from scratch */

2012-03-11T05:42:48Z

‎Creating a mod instance from scratch

Amounra: /* Inlets */

2012-03-11T05:39:38Z

‎Inlets

Amounra: /* Inlets */

2012-03-11T05:38:46Z

‎Inlets

← Older revision		Revision as of 19:36, 19 July 2012
Line 115:		Line 115:

	Once you've reloaded the fresh patch, it should automatically connect to a Client. You should not make changes to the client settings if you are editing the patch. I've tried to sandbox it so that things don't go wrong while in edit mode, but doing this requires that the Client number be locked, and this is far from fool-proof. Its best just not to mess with it ;)		Once you've reloaded the fresh patch, it should automatically connect to a Client. You should not make changes to the client settings if you are editing the patch. I've tried to sandbox it so that things don't go wrong while in edit mode, but doing this requires that the Client number be locked, and this is far from fool-proof. Its best just not to mess with it ;)
		+
		+	[[Category:Mods]]

@@ Line 1: / Line 1: @@
 The Monomodular framework has two things at its core that allow it to operate:
@@ Line 6: / Line 8: @@
 ===The mod.js Javascript Object===
 The mod.js is a javascript object that connects to the Live API Control Surface controls inside of the Monomodular script in order to communicate directly with the other controller scripts that it has access to.  The javascript itself lives inside of a bpatcher, with some other objects that are necessary for it to connect and disconnect when Live changes in and out of edit mode, as well as a menu object for assigning the Python Client class that it's connected to.  It should remain in this bpatcher to work properly, and the best way to use it in a new patch is to install it from Max's clippings.

@@ Line 39: / Line 39: @@
 '''batch''':  This sets a set of cells to the same value.  It requires a second argument:
-     '''grid''':  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
+     grid:  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
-     '''row''':  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
+     row:  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
-     '''column''':  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
+     column:  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
 '''mask''':  This allows masking of a cell without actually changing its Client's stored value.  For instance, if you've sent a "grid 0 0 1" call to the client, it has stored the top left cell's value as 1.  If you navigate to a different client from the controller, or change navigation positions, and then return to view that cell, it will be relit to a value of 1.  However, the "mask" function allows the user to send a new value to that cell without changing its stored value.  This is useful for overlays or running status indicators that are not meant to be stored values, but merely flash for an instant and then go away as soon as the condition changes.
 The "mask" function also requires a second argument:
-     "grid" will mask a single cell, for example, "mask grid 0 0 2" will light the top left cell with the value of 2.
+     grid will mask a single cell, for example, "mask grid 0 0 2" will light the top left cell with the value of 2.
      To turn off the mask, we would call "mask grid 0 0 -1".
      You an also mask columns or rows by calling "mask column x value" or "mask row y value".

@@ Line 39: / Line 39: @@
 '''batch''':  This sets a set of cells to the same value.  It requires a second argument:
-     ''''grid'''':  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
+     '''grid''':  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
-     ''''row'''':  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
+     '''row''':  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
-     ''''column'''':  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
+     '''column''':  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
 '''mask''':  This allows masking of a cell without actually changing its Client's stored value.  For instance, if you've sent a "grid 0 0 1" call to the client, it has stored the top left cell's value as 1.  If you navigate to a different client from the controller, or change navigation positions, and then return to view that cell, it will be relit to a value of 1.  However, the "mask" function allows the user to send a new value to that cell without changing its stored value.  This is useful for overlays or running status indicators that are not meant to be stored values, but merely flash for an instant and then go away as soon as the condition changes.

@@ Line 32: / Line 32: @@
 Additional commands available for input:
-""send_color_map"":  This allows a properly formatted color map to be sent to Monomodular, which contains specific color mappings for different kinds of supported controllers.  For instance, you can create two different color maps, one for a monochrome device, and another for an RGB device, so that things can be displayed in more sensible ways depending on the controller being used.  See below for more info on this.
+'''send_color_map''':  This allows a properly formatted color map to be sent to Monomodular, which contains specific color mappings for different kinds of supported controllers.  For instance, you can create two different color maps, one for a monochrome device, and another for an RGB device, so that things can be displayed in more sensible ways depending on the controller being used.  See below for more info on this.
-""set_report_offset"":  This function tells Monomodular to send the current offset value back to the mod anytime that it changes.
+'''set_report_offset''':  This function tells Monomodular to send the current offset value back to the mod anytime that it changes.
-""clear"":  This is functionally the same as calling "batch_grid_all 0", and will set all values of the grid (16x16) to 0.
+'''clear''':  This is functionally the same as calling "batch_grid_all 0", and will set all values of the grid (16x16) to 0.
-""batch"":  This sets a set of cells to the same value.  It requires a second argument:
+'''batch''':  This sets a set of cells to the same value.  It requires a second argument:
-     "grid":  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
+     ''''grid'''':  The statement "batch grid 2" will set all cells on the 16x16 grid to the value of 2.
-     "row":  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
+     ''''row'''':  The statement "batch row 0 1" will set an entire top row on the grid to the value of 1.
-     "column":  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
+     ''''column'''':  The statemnt "batch column 15 0" will turn off an entire right column of the grid.
-""mask"":  This allows masking of a cell without actually changing its Client's stored value.  For instance, if you've sent a "grid 0 0 1" call to the client, it has stored the top left cell's value as 1.  If you navigate to a different client from the controller, or change navigation positions, and then return to view that cell, it will be relit to a value of 1.  However, the "mask" function allows the user to send a new value to that cell without changing its stored value.  This is useful for overlays or running status indicators that are not meant to be stored values, but merely flash for an instant and then go away as soon as the condition changes.
+'''mask''':  This allows masking of a cell without actually changing its Client's stored value.  For instance, if you've sent a "grid 0 0 1" call to the client, it has stored the top left cell's value as 1.  If you navigate to a different client from the controller, or change navigation positions, and then return to view that cell, it will be relit to a value of 1.  However, the "mask" function allows the user to send a new value to that cell without changing its stored value.  This is useful for overlays or running status indicators that are not meant to be stored values, but merely flash for an instant and then go away as soon as the condition changes.
 The "mask" function also requires a second argument:
@@ Line 51: / Line 51: @@
      If you don't turn off the mask, it will revert to the stored value the next time the Python Client updates.
-""send_hotline"":  this is a new function in b993, and basically allows calling internal functionality of another connected mod.js by routing it through the Monomodular switchboard.  If it does not find a corresponding function in the target mod.js, it sends the arguments out of a uniquely named send in the target mod's patcher [r ---hotline].  As an example:
+'''send_hotline''':  this is a new function in b993, and basically allows calling internal functionality of another connected mod.js by routing it through the Monomodular switchboard.  If it does not find a corresponding function in the target mod.js, it sends the arguments out of a uniquely named send in the target mod's patcher [r ---hotline].  As an example:
      To call the 'clear' function in another connected mod (say, the one in mod slot three), we could send a command:
      "send_hotline 3 clear"
@@ Line 62: / Line 62: @@
 This is hardly useful yet for me, but I have devious plans for it in the future ;)
-""exclusive"":  this is an extension of the hotline() function, and has the same effect, except that it will send the arguments out of other mod connected patchers through a uniquely named receive object with the name of the first argument to the exclusive function.
+'''exclusive''':  this is an extension of the hotline() function, and has the same effect, except that it will send the arguments out of other mod connected patchers through a uniquely named receive object with the name of the first argument to the exclusive function.
      Sending the mod bpatcher the arguments "exclusive blah sammy 35" will cause the message "sammy 35" to be distributed to any
      connected mods and sent out a [r ---blah] object in those mods (if one exists).

← Older revision		Revision as of 07:06, 14 March 2012
Line 61:		Line 61:

	This is hardly useful yet for me, but I have devious plans for it in the future ;)		This is hardly useful yet for me, but I have devious plans for it in the future ;)
		+
		+	"exclusive": this is an extension of the hotline() function, and has the same effect, except that it will send the arguments out of other mod connected patchers through a uniquely named receive object with the name of the first argument to the exclusive function.
		+	Sending the mod bpatcher the arguments "exclusive blah sammy 35" will cause the message "sammy 35" to be distributed to any
		+	connected mods and sent out a [r ---blah] object in those mods (if one exists).

	====Outlets====		====Outlets====

← Older revision		Revision as of 05:42, 11 March 2012
Line 103:		Line 103:
	[[File:Clipping_pic.png]]		[[File:Clipping_pic.png]]

−	Once you've pasted the new instance of the mod object inside a patcher, you'll need to save it and ~~reopen~~ it in order for it to work right.	+
		+	Once you've pasted the new instance of the mod object inside a patcher, you'll need to save the patch, delete it from your Live set, and then reload it in order for it to work right.
		+
		+	Once you've reloaded the fresh patch, it should automatically connect to a Client. You should not make changes to the client settings if you are editing the patch. I've tried to sandbox it so that things don't go wrong while in edit mode, but doing this requires that the Client number be locked, and this is far from fool-proof. Its best just not to mess with it ;)

@@ Line 26: / Line 26: @@
 .  The last outlet accepts data that will be sent to a connected Code controller.  Whilst the Code is supported by Monomodular, its architecture is different and therefore required a different set of commands.  They will be detailed later in the section directly covering Code functions.
-There are quite a few other commands that can be sent to the mod object, however they are inlet-independent (i.e. you can send them in any inlet).  The convention of having different inlets for general data is merely a convenience, and any of the functions sent to them can be effected in the same manner by prefixing a set of arguments by their function name.  For example, sending the message "0 0 1" in the first inlet of the mod object will have the same effect as sending a message "grid 0 0 1" in any of the inlets:  both will light the top left button of their corresponding Client.
+There are quite a few other commands that can be sent to the mod object, however they are inlet-independent (i.e. you can send them in any inlet).  The convention of having different inlets for general data is merely a convenience, and any of the functions sent to them can be effected in the same manner by prefixing a set of arguments by their function name.
 Additional commands available for input:

@@ Line 44: / Line 44: @@
 The "mask" function also requires a second argument:
-     "grid" will mask a single cell, for example, "mask grid 0 0 2" will light the top left cell with the value of 2.  To turn off the mask, we would call "mask grid 0 0 -1".   You an also mask columns or rows by calling "mask column x value" or "mask row y value".  If you don't turn off the mask, it will revert to the stored value the next time the Python Client updates.
+     "grid" will mask a single cell, for example, "mask grid 0 0 2" will light the top left cell with the value of 2.
 "send_hotline":  this is a new function in b993, and basically allows calling internal functionality of another connected mod.js by routing it through the Monomodular switchboard.  If it does not find a corresponding function in the target mod.js, it sends the arguments out of a uniquely named send in the target mod's patcher [r ---hotline].  As an example: