Developing a DCE Device - Revision history

GolgoJ4 at 05:54, 20 December 2017

2017-12-20T05:54:32Z

←Older revision		Revision as of 05:54, 20 December 2017
Line 2:		Line 2:
	[[Category: Programmer's Guide]]		[[Category: Programmer's Guide]]
	Document Relevance:		Document Relevance:
	*LinuxMCE 810		*LinuxMCE versions: 810, 1004, 1204, 1404, 1604
	*LinuxMCE 1004
	== Introduction ==		== Introduction ==

Marie.o: /* Source Tree */

2016-01-27T22:28:02Z

Source Tree

←Older revision		Revision as of 22:28, 27 January 2016
Line 21:		Line 21:

	=== Source Tree ===		=== Source Tree ===
	~~Check out~~ the LinuxMCE source ~~tree~~		Clone the latest LinuxMCE source
	# ~~svn co http~~://~~svn~~.linuxmce.org/~~svn~~/~~trunk/src~~ .		# git clone https://git.linuxmce.org/linuxmce/linuxmce.git

	=== Environment Preparation ===		=== Environment Preparation ===

Marie.o: Current development should happen in trunk

2015-07-29T14:55:04Z

Current development should happen in trunk

←Older revision		Revision as of 14:55, 29 July 2015
Line 22:		Line 22:
	=== Source Tree ===		=== Source Tree ===
	Check out the LinuxMCE source tree		Check out the LinuxMCE source tree
	# svn co http://svn.linuxmce.org/svn/~~branches/LinuxMCE-1004~~/src .		# svn co http://svn.linuxmce.org/svn/trunk/src .

	=== Environment Preparation ===		=== Environment Preparation ===

Marie.o: Referencing the build and runtime packages instead of individual packages.

2015-07-29T14:54:32Z

Referencing the build and runtime packages instead of individual packages.

←Older revision		Revision as of 14:54, 29 July 2015
Line 17:		Line 17:
	Developing for any part of the system requires a specific environment setup, including an up to date source code tree and some required programs to be installed. It is assumed that this guide will be followed on an existing LinuxMCE Core installation. All commands following a # sign are to be run as a privileged user, either by prepending 'sudo' or after obtaining a root shell ("sudo -s", "sudo -r", or "sudo su" are all acceptable means of doing this).		Developing for any part of the system requires a specific environment setup, including an up to date source code tree and some required programs to be installed. It is assumed that this guide will be followed on an existing LinuxMCE Core installation. All commands following a # sign are to be run as a privileged user, either by prepending 'sudo' or after obtaining a root shell ("sudo -s", "sudo -r", or "sudo su" are all acceptable means of doing this).
	=== Required Packages ===		=== Required Packages ===
	Install ~~pluto-dcegen, pluto-sql2cpp, and a few other~~ build dependencies		Install build dependencies
	# apt-get install pluto-dcegen pluto-sql2cpp subversion build-essential ~~libmysqld-dev~~		apt-get install lmce-devel-dependencies lmce-runtime-dependencies pluto-dcegen pluto-sql2cpp subversion build-essential

	*In my case on 810 replace libmysqld-dev with libmysqlclient15-dev -L3mce

	=== Source Tree ===		=== Source Tree ===

Marie.o: To make a project, we run make not ./make

2015-07-18T13:18:32Z

To make a project, we run make not ./make

←Older revision		Revision as of 13:18, 18 July 2015
Line 99:		Line 99:

	At this point the device code is complete and will create a fully functioning device binary when compiled. DCEGen created a new directory in src for the device and placed all the code within that directory, so to compile it, simply cd into that directory and invoke the "make" command:<br>		At this point the device code is complete and will create a fully functioning device binary when compiled. DCEGen created a new directory in src for the device and placed all the code within that directory, so to compile it, simply cd into that directory and invoke the "make" command:<br>
	# cd ../Intelligent_Light_Switch		cd ../Intelligent_Light_Switch
	~~# ./~~make		make
	Due to a bug in DCEGen, there will be an error during compilation about post_make.sh, however it is not fatal. If the error bothers you, you can simply make the file executable:<br>		Due to a bug in DCEGen, there will be an error during compilation about post_make.sh, however it is not fatal. If the error bothers you, you can simply make the file executable:<br>
	# chmod 755 post_make.sh		chmod 755 post_make.sh
	You should now have a binary of the device in the current dir: Intelligent_Light_Switch		You should now have a binary of the device in the current dir: Intelligent_Light_Switch

Marie.o: /* Running DCEGen */

2015-07-18T13:10:24Z

Running DCEGen

←Older revision		Revision as of 13:10, 18 July 2015
Line 78:		Line 78:
	DCEGen is a program that uses the device template information to create a skeleton of c++ code that will comprise the basics of the device. It creates the necessary header files, source files and makefiles in order for the device's code to compile. Included in this are functions for the device data, commands, and events defined in the template. Under normal circumstances, you would do an initial sqlCVS checkin at this point in order to get a permanent Device Template number, but since this is a demonstration only this will not be performed.<br>		DCEGen is a program that uses the device template information to create a skeleton of c++ code that will comprise the basics of the device. It creates the necessary header files, source files and makefiles in order for the device's code to compile. Included in this are functions for the device data, commands, and events defined in the template. Under normal circumstances, you would do an initial sqlCVS checkin at this point in order to get a permanent Device Template number, but since this is a demonstration only this will not be performed.<br>
	Run DCEGen to create the source code skeleton:		Run DCEGen to create the source code skeleton:
	# cd src/DCEGen		cd src/DCEGen
	# /usr/pluto/bin/DCEGen -d 2181		/usr/pluto/bin/DCEGen -d 2181
	# # add -h localhost when your router database is running locally		# add -h localhost when your router database is running locally
	It is important to be in src/DCEGen of the svn tree when running this command! Also make sure to use the correct device template number for your template in place of 2181. DCEGen can also be run again later if you change the device template options; it will leave your customizations alone and only update the device template specified options. DCEGen adds very verbose comments that makes the code very easy to read and modify.		It is important to be in src/DCEGen of the svn tree when running this command! Also make sure to use the correct device template number for your template in place of 2181. DCEGen can also be run again later if you change the device template options; it will leave your customizations alone and only update the device template specified options. DCEGen adds very verbose comments that makes the code very easy to read and modify.

Marie.o: /* Running sql2cpp */

2015-07-18T13:10:10Z

Running sql2cpp

←Older revision		Revision as of 13:10, 18 July 2015
Line 85:		Line 85:
	=== Running sql2cpp ===		=== Running sql2cpp ===
	All database tables, rows, and columns are represented as c++ constants, and must be regenerated any time device template options change. sql2cpp performs this operation.<br>		All database tables, rows, and columns are represented as c++ constants, and must be regenerated any time device template options change. sql2cpp performs this operation.<br>
	# cd ../sql2cpp		cd ../sql2cpp
	# /usr/pluto/bin/sql2cpp		/usr/pluto/bin/sql2cpp#
			# add -h localhost when your router database is running locally

	As with DCEGen, it is important to be in src/sql2cpp of the svn tree when executing it, and it is safe to execute this again at any time.		As with DCEGen, it is important to be in src/sql2cpp of the svn tree when executing it, and it is safe to execute this again at any time.

Marie.o: /* Running DCEGen */

2015-07-18T13:09:45Z

Running DCEGen

←Older revision		Revision as of 13:09, 18 July 2015
Line 79:		Line 79:
	Run DCEGen to create the source code skeleton:		Run DCEGen to create the source code skeleton:
	# cd src/DCEGen		# cd src/DCEGen
	# /usr/pluto/bin/DCEGen -d 2181		# /usr/pluto/bin/DCEGen -d 2181
			# # add -h localhost when your router database is running locally
	It is important to be in src/DCEGen of the svn tree when running this command! Also make sure to use the correct device template number for your template in place of 2181. DCEGen can also be run again later if you change the device template options; it will leave your customizations alone and only update the device template specified options. DCEGen adds very verbose comments that makes the code very easy to read and modify.		It is important to be in src/DCEGen of the svn tree when running this command! Also make sure to use the correct device template number for your template in place of 2181. DCEGen can also be run again later if you change the device template options; it will leave your customizations alone and only update the device template specified options. DCEGen adds very verbose comments that makes the code very easy to read and modify.

Phenigma: Undo revision 34921 by Esperanto (talk)

2014-04-17T18:19:25Z

Undo revision 34921 by Esperanto (talk)

←Older revision		Revision as of 18:19, 17 April 2014
Line 17:		Line 17:
	Developing for any part of the system requires a specific environment setup, including an up to date source code tree and some required programs to be installed. It is assumed that this guide will be followed on an existing LinuxMCE Core installation. All commands following a # sign are to be run as a privileged user, either by prepending 'sudo' or after obtaining a root shell ("sudo -s", "sudo -r", or "sudo su" are all acceptable means of doing this).		Developing for any part of the system requires a specific environment setup, including an up to date source code tree and some required programs to be installed. It is assumed that this guide will be followed on an existing LinuxMCE Core installation. All commands following a # sign are to be run as a privileged user, either by prepending 'sudo' or after obtaining a root shell ("sudo -s", "sudo -r", or "sudo su" are all acceptable means of doing this).
	=== Required Packages ===		=== Required Packages ===
	Install pluto-dcegen, ~~[http://svn.linuxmce.org/svn/trunk/src/sql2cpp/~~ pluto-sql2cpp ], and a few other build dependencies		Install pluto-dcegen, pluto-sql2cpp, and a few other build dependencies
	# apt-get install pluto-dcegen subversion build-essential libmysqld-dev		# apt-get install pluto-dcegen pluto-sql2cpp subversion build-essential libmysqld-dev

	*In my case on 810 replace libmysqld-dev with libmysqlclient15-dev -L3mce		*In my case on 810 replace libmysqld-dev with libmysqlclient15-dev -L3mce

Phenigma: Undo revision 34922 by Esperanto (talk)

2014-04-17T18:18:59Z

Undo revision 34922 by Esperanto (talk)

←Older revision		Revision as of 18:18, 17 April 2014
Line 18:		Line 18:
	=== Required Packages ===		=== Required Packages ===
	Install pluto-dcegen, [http://svn.linuxmce.org/svn/trunk/src/sql2cpp/ pluto-sql2cpp ], and a few other build dependencies		Install pluto-dcegen, [http://svn.linuxmce.org/svn/trunk/src/sql2cpp/ pluto-sql2cpp ], and a few other build dependencies
	# apt-get install pluto-dcegen subversion build-essential libmysqld~~-dev libattr1~~-dev		# apt-get install pluto-dcegen subversion build-essential libmysqld-dev

	*In my case on 810 replace libmysqld-dev with libmysqlclient15-dev -L3mce		*In my case on 810 replace libmysqld-dev with libmysqlclient15-dev -L3mce