RDM PID Definitions - Revision history

Peternewman: Fix some links

2015-11-03T00:54:33Z

Fix some links

← Older revision		Revision as of 00:54, 3 November 2015
Line 12:		Line 12:
	* When integer values are used, the values are stores as normal int values, not as ASCII.		* When integer values are used, the values are stores as normal int values, not as ASCII.

	The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [~~http~~://~~code.google~~.com/p/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.		The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [https://github.com/google/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.

	You can see the latest pid protobufs at <tt>[~~https~~:~~//github.com/OpenLightingProject/ola/blob/master/~~data/rdm/pids.proto pids.proto]</tt> and <tt>[~~https~~:~~//github.com/OpenLightingProject/ola/blob/master/~~data/rdm/manufacturer_pids.proto manufacturer_pids.proto]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.		You can see the latest pid protobufs at <tt>[[code:data/rdm/pids.proto\|pids.proto]]</tt> and <tt>[[code:data/rdm/manufacturer_pids.proto\|manufacturer_pids.proto]]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.

	== Adding New Parameters ==		== Adding New Parameters ==
Line 102:		Line 102:
	</pre>		</pre>

	Item names should be all lower case, with spaces replaced by _ . In OLA, item names are run through CustomCapitalizeLabel() before being displayed to the user. This replaces '_' with ' ' and capitalizes words. For more details see the code in [~~http~~:~~//code.google.com/p/open-lighting/source/browse/~~common/utils/StringUtils.cpp StringUtils.cpp].		Item names should be all lower case, with spaces replaced by _ . In OLA, item names are run through CustomCapitalizeLabel() before being displayed to the user. This replaces '_' with ' ' and capitalizes words. For more details see the code in [[code:common/utils/StringUtils.cpp\|StringUtils.cpp]].

	The valid item types are:		The valid item types are:
Line 116:		Line 116:
	* group, a group of items, see below for more details.		* group, a group of items, see below for more details.
	* ipv4, a 32 bit IP address		* ipv4, a 32 bit IP address
			* mac, a 48 bit MAC address
	* uid, a 48 bit UID.		* uid, a 48 bit UID.

Nomis52 at 03:11, 11 May 2015

2015-05-11T03:11:32Z

← Older revision		Revision as of 03:11, 11 May 2015
Line 14:		Line 14:
	The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [http://code.google.com/p/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.		The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [http://code.google.com/p/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.

	You can see the latest pid protobufs at <tt>[~~http~~://~~code.google~~.com/p/~~open-lighting~~/~~source~~/~~browse~~/data/rdm/pids.proto pids.proto]</tt> and <tt>[~~http~~://~~code.google~~.com/p/~~open-lighting~~/~~source~~/~~browse~~/data/rdm/manufacturer_pids.proto manufacturer_pids.proto]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.		You can see the latest pid protobufs at <tt>[https://github.com/OpenLightingProject/ola/blob/master/data/rdm/pids.proto pids.proto]</tt> and <tt>[https://github.com/OpenLightingProject/ola/blob/master/data/rdm/manufacturer_pids.proto manufacturer_pids.proto]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.

	== Adding New Parameters ==		== Adding New Parameters ==

Nomis52: /* Adding New Parameters */

2014-01-20T04:25:32Z

Adding New Parameters

← Older revision		Revision as of 04:25, 20 January 2014
Line 18:		Line 18:
	== Adding New Parameters ==		== Adding New Parameters ==

	Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from ~~http~~://~~code.google~~.com/~~p/open-lighting/source~~/~~checkout?repo=~~rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.		Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from https://github.com/OpenLightingProject/rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.

	You can use RDM Pid Builder to add your definitions:		You can use RDM Pid Builder to add your definitions:

RenZO: /* Adding New Parameters */ add rdm-pid-builder

2013-04-20T23:19:38Z

Adding New Parameters: add rdm-pid-builder

← Older revision		Revision as of 23:19, 20 April 2013
Line 20:		Line 20:
	Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from http://code.google.com/p/open-lighting/source/checkout?repo=rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.		Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from http://code.google.com/p/open-lighting/source/checkout?repo=rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.

	~~TODO~~: ~~link to and describe Laruent's site~~.		You can use RDM Pid Builder to add your definitions:
			http://imaginux.com/lighting/pids/addpids.php

			Or use the tool locally:
			https://github.com/RenZ0/rdm-pid-builder

	== Structure ==		== Structure ==

RenZO: /* Structure */ typo fix

2013-04-06T18:55:00Z

Structure: typo fix

← Older revision		Revision as of 18:55, 6 April 2013
Line 67:		Line 67:
	; name		; name
	: The name of the PID, should be in CAPS like the names in E1.20		: The name of the PID, should be in CAPS like the names in E1.20
	; ~~line~~		; link
	: A URL pointing to where this information was obtained, set to the empty string is there isn't one		: A URL pointing to where this information was obtained, set to the empty string is there isn't one
	; notes		; notes

Nomis52: /* Item Groups */

2013-04-06T16:02:12Z

Item Groups

← Older revision		Revision as of 16:02, 6 April 2013
Line 169:		Line 169:

	=== Item Groups ===		=== Item Groups ===


			TODO: fill this in

	== Examples ==		== Examples ==

Nomis52: /* SLOT_INFO */

2013-04-06T16:01:53Z

SLOT_INFO

← Older revision		Revision as of 16:01, 6 April 2013
Line 224:		Line 224:
	{'get_request': {'items': []},		{'get_request': {'items': []},
	'get_response': {'items': [		'get_response': {'items': [
	{'name': 'slots', 'type': 'group', 'items': [		{'name': 'slots',
			'type': 'group',
			'items': [
	{'name': 'slot_offset', 'type': 'uint16'},		{'name': 'slot_offset', 'type': 'uint16'},
	{'name': 'slot_type', 'type': 'uint8'},		{'name': 'slot_type', 'type': 'uint8'},

Nomis52: /* Optional Fields */

2013-04-06T16:01:23Z

Optional Fields

@@ Line 116: / Line 116: @@
 All multi-byte items are big endian.
-=== Optional Fields ===
+=== Optional Attributes ===
-These are only defined for certain types.
+These are only defined for certain item types.
-labels
+==== Labels ====
 === Item Groups ===

Nomis52: /* Structure */

2013-04-06T15:44:20Z

Structure

← Older revision		Revision as of 15:44, 6 April 2013
Line 24:		Line 24:
	== Structure ==		== Structure ==

	The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar and the concepts are ~~identical~~.		The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar and the concepts are the same for both representations.

	The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.		The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.

Nomis52: /* Structure */

2013-04-06T15:43:58Z

Structure

← Older revision		Revision as of 15:43, 6 April 2013
Line 24:		Line 24:
	== Structure ==		== Structure ==

	The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar.		The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar and the concepts are identical.

	The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.		The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.