OhWidget Driver Development - Revision history

Openhome: /* Glossary */

2012-03-01T15:28:30Z

Glossary

← Older revision		Revision as of 15:28, 1 March 2012
Line 1,178:		Line 1,178:
	ohApp - An application that runs on ohOS.		ohApp - An application that runs on ohOS.

-	[[ohNet\|ohNet] - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.	+	[[ohNet\|ohNet]] - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.

	[[ohOs\|ohOs]] - The OpenHome Operating System. Core software for OpenHome systems that runs on Nodes.		[[ohOs\|ohOs]] - The OpenHome Operating System. Core software for OpenHome systems that runs on Nodes.

2012-03-01T15:28:15Z

Glossary

← Older revision		Revision as of 15:28, 1 March 2012
Line 1,178:		Line 1,178:
	ohApp - An application that runs on ohOS.		ohApp - An application that runs on ohOS.

-	ohNet - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.	+	[[ohNet\|ohNet] - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.

-	~~ohOS~~ - The OpenHome Operating System. Core software for OpenHome systems that runs on Nodes.	+	[[ohOs\|ohOs]] - The OpenHome Operating System. Core software for OpenHome systems that runs on Nodes.

	UPnP - Universal Plug and Play. The network protocols set out by the UPnP Forum to allow networked devices to seamlessly establish connections and services.		UPnP - Universal Plug and Play. The network protocols set out by the UPnP Forum to allow networked devices to seamlessly establish connections and services.

2012-03-01T15:27:21Z

Registering the callbacks

← Older revision		Revision as of 15:27, 1 March 2012
Line 683:		Line 683:

	[[File:Warning.png]] aSimpleUpnpWidget,		[[File:Warning.png]] aSimpleUpnpWidget,
		+

	=== Registering the callbacks ===		=== Registering the callbacks ===

2012-03-01T15:26:36Z

Registering the callbacks

← Older revision		Revision as of 15:26, 1 March 2012
Line 688:		Line 688:
	Finally, we ask the Widget's protocol interface to listen for calls to the handler methods we defined earlier in DiscoveredWidget. We do this by registering those methods as callbacks for the Protocol Module		Finally, we ask the Widget's protocol interface to listen for calls to the handler methods we defined earlier in DiscoveredWidget. We do this by registering those methods as callbacks for the Protocol Module
	to listen for:		to listen for:
-

	[[File:Warning.png]] aSimpleUpnpWidget.Listen(		[[File:Warning.png]] aSimpleUpnpWidget.Listen(

2012-03-01T15:21:40Z

Implementing the driver

← Older revision		Revision as of 15:21, 1 March 2012
Line 346:		Line 346:

	[[File:DriverNodeArchitecture-DriverHighlight.png\|800px\|thumb\|center\|Figure 4: The driver architecture highlighting the implemented driver's place.]]		[[File:DriverNodeArchitecture-DriverHighlight.png\|800px\|thumb\|center\|Figure 4: The driver architecture highlighting the implemented driver's place.]]
		+

	The code for your Widget driver must provide an implementation of the IWidgetRegistryInterface,		The code for your Widget driver must provide an implementation of the IWidgetRegistryInterface,

2012-03-01T15:21:18Z

Implementing the provider

← Older revision		Revision as of 15:21, 1 March 2012
Line 275:		Line 275:

	A driver must update a specified property to a new value when instructed to do so by the Node.		A driver must update a specified property to a new value when instructed to do so by the Node.
-

	=== Writing the code ===		=== Writing the code ===

2012-03-01T15:21:01Z

Implementing the provider

← Older revision		Revision as of 15:21, 1 March 2012
Line 264:		Line 264:

	[[File:DriverNodeArchitecture-ProviderHighlight.png\|800px\|thumb\|center\|Figure 4 The driver architecture highlighting the Provider's place]]		[[File:DriverNodeArchitecture-ProviderHighlight.png\|800px\|thumb\|center\|Figure 4 The driver architecture highlighting the Provider's place]]
		+

	You use your auto-generated abstract provider by writing an implementation of it in the driver file. Responsibilities met by implementing your auto-generated provider are:		You use your auto-generated abstract provider by writing an implementation of it in the driver file. Responsibilities met by implementing your auto-generated provider are:
Line 342:		Line 343:

	We have now finished implementing the provider. The next step is to implement the driver.		We have now finished implementing the provider. The next step is to implement the driver.
-

	== Implementing the driver ==		== Implementing the driver ==

2012-03-01T15:20:44Z

Starting the driver

← Older revision		Revision as of 15:20, 1 March 2012
Line 203:		Line 203:

	[[File:DriverNodeArchitecture-BoxHighlight.png\|800px\|thumb\|center\|Figure 3 The driver architecture highlighting the Widget driver and its component parts.]]		[[File:DriverNodeArchitecture-BoxHighlight.png\|800px\|thumb\|center\|Figure 3 The driver architecture highlighting the Widget driver and its component parts.]]
		+

	When you have generated the abstract provider you can put it to use in the Widget driver. A Widget driver		When you have generated the abstract provider you can put it to use in the Widget driver. A Widget driver

2012-03-01T15:20:21Z

Writing the code

← Older revision		Revision as of 15:20, 1 March 2012
Line 676:		Line 676:

	Each new Widget is represented by a DiscoveredWidget object. Create the new DiscoveredWidget and pass in the required parameters we created earlier:		Each new Widget is represented by a DiscoveredWidget object. Create the new DiscoveredWidget and pass in the required parameters we created earlier:
-

	DiscoveredWidget discoveredWidget =		DiscoveredWidget discoveredWidget =
Line 683:		Line 682:

	[[File:Warning.png]] aSimpleUpnpWidget,		[[File:Warning.png]] aSimpleUpnpWidget,
-

	=== Registering the callbacks ===		=== Registering the callbacks ===

2012-03-01T15:19:59Z

Writing the SimpleUPnP Widget discovery method

← Older revision		Revision as of 15:19, 1 March 2012
Line 655:		Line 655:

	'''R2 Reacting to a discovered Widget on the network'''		'''R2 Reacting to a discovered Widget on the network'''
-

	A driver must create a new IWidgetRegistryEntry object to represent the Widget and use it to listen to changes in the physical Widget's state.		A driver must create a new IWidgetRegistryEntry object to represent the Widget and use it to listen to changes in the physical Widget's state.