From OpenHome
(Created page with "= ohWidget Driver Development = = Introduction = This document is for developers using the OpenHome SDK to integrate a Widget into an OpenHome system. Each Widget must have i...") |
|||
| Line 1: | Line 1: | ||
| - | |||
| - | |||
= Introduction = | = Introduction = | ||
| Line 9: | Line 7: | ||
Full versions of each file used in the development of the example driver are available in the Appendix. | Full versions of each file used in the development of the example driver are available in the Appendix. | ||
| - | = Prerequisites = | + | == Prerequisites == |
To begin development of your Widget driver you must be in possession of the following items: | To begin development of your Widget driver you must be in possession of the following items: | ||
| Line 32: | Line 30: | ||
This document focuses on the development of the Widget driver. Details about the communications protocol used are beyond the scope of this document. This document assumes you are familiar with your chosen protocol's code libraries and are able to use them in the driver code you write. | This document focuses on the development of the Widget driver. Details about the communications protocol used are beyond the scope of this document. This document assumes you are familiar with your chosen protocol's code libraries and are able to use them in the driver code you write. | ||
| + | |||
| + | {{Noteboxend}} | ||
| + | |||
| + | |||
| + | == Related Documents == | ||
| + | |||
| + | The following related OpenHome documentation may be of interest to you: | ||
| + | |||
| + | * [[OpenHome Technical Overview|OpenHome Technical Overview]] | ||
| + | * [[OpenHome Widget Service XML definition|OpenHome Widget Service XML definition]] | ||
| + | * [[OpenHome ohNet Device Stack|OpenHome ohNet Device Stack]] | ||
| + | * [[OpenHome Node Architecture|OpenHome Node Architecture]] | ||
| + | |||
| + | |||
| + | {{Notebox}} | ||
| + | '''Note''' | ||
| + | |||
| + | None of the related documents listed above is mandatory reading for Widget driver development. | ||
| + | |||
| + | {{Noteboxend}} | ||
Revision as of 15:07, 29 February 2012
Introduction
This document is for developers using the OpenHome SDK to integrate a Widget into an OpenHome system. Each Widget must have its own driver to allow it to communicate with the OpenHome Nodes.
To help you write your driver, this document provides high level descriptions of the core responsibilities of a Widget driver and gives a detailed walk-through using example code.
Full versions of each file used in the development of the example driver are available in the Appendix.
Prerequisites
To begin development of your Widget driver you must be in possession of the following items:
- your Widget Service XML that describes the properties on your Widget.
Note
This document does not contain advice on how to write Widget Service XML. Refer to the OpenHome Widget Service XML definition document for more details.
- the OpenHome SDK
- your chosen communication protocol's API
The protocol you choose for your Widgets must be the same protocol used on your choice of Node.
Note
This document focuses on the development of the Widget driver. Details about the communications protocol used are beyond the scope of this document. This document assumes you are familiar with your chosen protocol's code libraries and are able to use them in the driver code you write.
Related Documents
The following related OpenHome documentation may be of interest to you:
- OpenHome Technical Overview
- OpenHome Widget Service XML definition
- OpenHome ohNet Device Stack
- OpenHome Node Architecture
Note
None of the related documents listed above is mandatory reading for Widget driver development.