XML-based template language for devices and services

• US 20020029256A1
• Filed: 03/16/2001
• Published: 03/07/2002
• Est. Priority Date: 06/11/1999
• Status: Active Grant

• Current Assignee: Rovi Technologies Corporation (Adeia Inc.)
• Original Assignee: Microsoft Corporation
• Inventors: Leach, Paul J., Schlimmer, Jeffrey C., Ryan, Donald R., Gandhi, Amar S., Pather, Shyamalan, Ford, Peter S., Gu, Ye, Weisman, Daniel R., Rude, Christopher M., Zintel, William M., Cai, Ting, Knight, Holly N.
• Granted Patent: US 6,910,068 B2
• Time in Patent Office: Days
• US Class Current: 709/218
• CPC Class Codes: H04L 12/2803 Home automation networks
• CPC Class Codes: H04L 12/2805 Home Audio Video Interoperability [HAVI] networks
• CPC Class Codes: H04L 12/2807 Exchanging configuration information on appliance services in a home automation network arrangements for maintenance or administration involving network analysis for automatically determining the actual topology of a network H04L41/12; hardware or software tools for network management using graphical user interfaces H04L41/22; address allocation H04L61/50
• CPC Class Codes: H04L 12/2818 from a device located outside both the home and the home network access arrangements H04L12/2856; for remote control or remote monitoring of applications H04L67/025; arrangements for transmitting signals characterised by the use of a wireless eletrical link G08C17/00; telephonic communication systems adapted for combination with remote control systems H04M11/007
• CPC Class Codes: H04L 12/2856 Access arrangements, e.g. Internet access asynchronous transfer mode networks H04L12/5601; broadband local area networks H04L12/2801; optical access or distribution networks H04Q11/0067; access to open networks H04L12/5691; digital subscriber line end-user equipment and bit-level processing of data on a PSTN-based network H04M11/00; home network gateways H04L12/2834; wireless access networks H04W
• CPC Class Codes: H04L 12/2898 Subscriber equipments DSL modems H04M11/062; cable modems H04L12/2801
• CPC Class Codes: H04L 12/4633 Interconnection of networks using encapsulation techniques, e.g. tunneling
• CPC Class Codes: H04L 47/2408 for supporting different services, e.g. a differentiated services [DiffServ] type of service
• CPC Class Codes: H04L 61/30 Managing network names, e.g. use of aliases or nicknames name-to-address mapping H04L61/45
• CPC Class Codes: H04L 61/5014 using dynamic host configuration protocol [DHCP] or bootstrap protocol [BOOTP]
• CPC Class Codes: H04L 61/5092 by self-assignment, e.g. picking addresses at random and testing if they are already in use
• CPC Class Codes: H04L 67/00 Network arrangements or protocols for supporting network services or applications user-to-user messaging H04L51/00; network arrangements, protocols or services for supporting real-time applications in data packet communications networks H04L65/00
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]
• CPC Class Codes: H04L 67/025 for remote control or remote monitoring of applications
• CPC Class Codes: H04L 67/125 involving control of end-device applications over a network
• CPC Class Codes: H04L 67/14 Session management for real-time applications in data packet communications networks H04L65/1066
• CPC Class Codes: H04L 67/51 Discovery or management thereof, e.g. service location protocol [SLP] or web services
• CPC Class Codes: H04L 69/329 in the application layer [OSI layer 7]
• CPC Class Codes: H04L 9/40 Network security protocols

Abstract

A universal plug and play (UPnP) device makes itself known through a set of processes-discovery, description, control, eventing, and presentation. Following discovery of a UPnP device, an entity can learn more about the device and its capabilities by retrieving the device'"'"'s description. The description includes vendor-specific manufacturer information like the model name and number, serial number, manufacturer name, URLs to vendor-specific Web sites, etc. The description also includes a list of any embedded devices or services, as well as URLs for control, eventing, and presentation. The description is written by a vendor, and is usually based on a device template produced by a UPnP forum working committee. The template is derived from a template language that is used to define elements to describe the device and any services supported by the device. The template language is written using an XML-based syntax that organizes and structures the elements.

Claims

1. A method comprising:

creating a device template using a template language written in XML syntax; and

defining, from the device template, a device description for a self-describing network device.

2. A method as recited in claim 1, wherein the template language is derived from XML schema.

3. A method as recited in claim 1, wherein the self-describing network device comprises a universal plug and play device.

4. A method as recited in claim 1, further comprising storing the device description on a computer-readable medium.

5. A method as recited in claim 1, further comprising:

creating a service template from a template language written in XML syntax; and

defining, from the service template, a service description for a service supported by the self-describing network device.

6. A method as recited in claim 1, further comprising automatically evaluating, via a computer software tool, whether the device description is well formed.

7. A method comprising:

creating a service template from a template language written in XML syntax; and

defining, from the service template, a service description for a service supported by a self-describing network device.

8. A method as recited in claim 7, wherein the template language is derived from XML schema.

9. A method as recited in claim 7, wherein the self-describing network device comprises a universal plug and play device.

10. A method as recited in claim 7, further comprising storing the service description on a computer-readable medium.

11. A method as recited in claim 7, further comprising automatically evaluating, via a computer software tool, whether the device description is well formed.

14. A method as recited in claim 13, wherein the storing comprises storing the description at the self-describing network device.

15. A method as recited in claim 13, wherein the self-describing network device comprises a universal plug and play device.

16. A method as recited in claim 13, wherein the set of elements includes at least one of:

a first element to identify one or more versions of the template language;

a second element to identify the self-describing network device; and

a third element to specify a base universal resource locator (URL).

17. A method as recited in claim 16, wherein the second element includes at least one of:

a first subelement to specify a type of self-describing network device;

a second subelement to identify a user;

a third subelement to identify a manufacturer;

a fourth subelement to specify a URL of a website for the manufacturer;

a fifth subelement to provide a word description of the self-describing network device for the user;

a sixth subelement to specify a model name of the self-describing network device;

a seventh subelement to specify a model number of the self-describing network device;

an eighth subelement to specify a URL of a website for the self-describing network device;

a ninth subelement to specify a URL of a website for a presentation hosted by the self-describing network device;

a tenth subelement to specify a serial number of the self-describing network device;

an eleventh subelement to specify a universal device name of the self-describing network device;

a twelfth subelement to specify a universal product code of the self-describing network device;

a thirteenth subelement to specify any icons associated with the self-describing network device;

a fourteenth subelement to identify any of one or more services supported by the self-describing network device; and

a fifteenth subelement to identify any of one or more devices embedded within the self-describing network device.

18. A method as recited in claim 13, further comprising storing a set of elements to describe at least one service supported by the self-describing network device.

19. A method as recited in claim 18, wherein the set of elements to describe the service includes at least one of:

a first element to identify any of one or more actions performed by the service; and

a second element to identify any of one or more state variables in the service.

20. A method as recited in claim 19, wherein the first element includes at least one subelement for each corresponding action, the subelement containing a name string to hold a name of the action and an argument list to hold parameters of the action.

21. A method as recited in claim 19, wherein the second element includes at least one of:

a first subelement to identify a name of a state variable;

a second subelement to specify a data type of the state variable;

a third subelement to specify a default value of the state variable;

a fourth subelement to enumerate legal string values; and

a fifth subelement to define bounds of legal numeric values.

22. A method as recited in claim 13, wherein the storing comprises storing the description at the self-describing network device, the method further comprising storing a set of elements to describe at least one service supported by the self-describing network device at a location remote from the self-describing network device.

24. A data structure stored as recited in claim 23, wherein the set of elements requires:

a first element to identify one or more versions of the template language; and

a second element to identify the self-describing network device.

25. A data structure stored as recited in claim 23, wherein the set of elements includes at least one of:

a first element to identify one or more versions of the template language;

a second element to identify the self-describing network device; and

a third element to specify a base universal resource locator (URL).

26. A data structure stored as recited in claim 25, wherein the second element includes at least one of:

a first subelement to specify a type of self-describing network device;

a second subelement to identify a user;

a third subelement to identify a manufacturer;

a fourth subelement to specify a URL of a website for the manufacturer;

a fifth subelement to provide a word description of the self-describing network device for the user;

a sixth subelement to specify a model name of the self-describing network device;

a seventh subelement to specify a model number of the self-describing network device;

an eighth subelement to specify a URL of a website for the self-describing network device;

a ninth subelement to specify a URL of a website for a presentation hosted by the self-describing network device;

a tenth subelement to specify a serial number of the self-describing network device;

an eleventh subelement to specify a universal device name of the self-describing network device;

a twelfth subelement to specify a universal product code of the self-describing network device;

a thirteenth subelement to specify any icons associated with the self-describing network device;

a fourteenth subelement to identify any of one or more services supported by the self-describing network device; and

a fifteenth subelement to identify any of one or more devices embedded within the self-describing network device.

28. A data structure stored as recited in claim 27, wherein the set of elements includes at least one of:

a first element to identify any of one or more actions performed by the service; and

a second element to identify any of one or more state variables in the service.

29. A data structure stored as recited in claim 28, wherein the first element includes at least one subelement for each corresponding action, the subelement containing at least one of a name string to hold a name of the action, an argument list to hold parameters of the action, and a data type of the parameters.

30. A data structure stored as recited in claim 28, wherein the second element includes at least one of:

a first subelement to identify a name of a state variable;

a second subelement to specify a data type of the state variable;

a third subelement to specify a default value of the state variable;

a fourth subelement to enumerate legal string values; and

a fifth subelement to define bounds of legal numeric values.

12. A method comprising:

creating a device template for a self-describing network device, the device template being written in an XML-based language; and

instantiating the device template with vendor-specific information to form a device description of the self-describing network device.

13. A method of describing a universal plug and play device, comprising:

storing a description of the self-describing network device, the description comprising a set of elements to describe the self-describing network device and an XML-based syntax that structures the set of elements such that, when the data structure is read by a computing device, the computing device can learn about the self-describing network device; and

making the description available to the computing device.

23. A data structure stored on a computer-readable medium, the data structure being constructed according to an XML-based template language, the data structure comprising:

a set of elements to describe a self-describing network device; and

an XML-based syntax that organizes and structures the set of elements such that, when the data structure is read by a computing device, the computing device can learn about the self-describing network device.

27. A data structure stored on a computer-readable medium, the data structure being constructed according to an XML-based template language, the data structure comprising:

a set of elements to describe a service supported by a self-describing network device; and

an XML-based syntax that organizes and structures the set of elements such that, when the data structure is read by a computing device, the computing device can learn about the service supported by the self-describing network device.

31. One or more computer-readable media, comprising stored thereon:

a first set of elements to describe a self-describing network device, the first set of elements being written in an XML syntax;

a second set of elements to describe a service supported by the self-describing network device, the second set of elements being written in an XML syntax; and

a code segment that, when executed, returns the first set of elements and at least a reference to the second set of elements to an entity requesting a description of the self-describing network device.

32. One or more computer-readable media as recited in claim 31, wherein the first set of elements are stored on a computer-readable media located at the self-describing network device and the second set of elements are stored on a separate computer-readable medium located remotely from the self-describing network device, but accessible via a network.

33. One or more computer-readable media as recited in claim 31, wherein the first set of elements includes at least one of:

a first element to identify one or more versions of the template language;

a second element to identify the self-describing network device; and

a third element to specify a base universal resource locator (URL).

34. One or more computer-readable media as recited in claim 31, wherein the second element of the first set of elements includes at least one of:

a first subelement to specify a type of self-describing network device;

a second subelement to identify a user;

a third subelement to identify a manufacturer;

a fourth subelement to specify a URL of a website for the manufacturer;

a fifth subelement to provide a word description of the self-describing network device for the user;

a sixth subelement to specify a model name of the self-describing network device;

a seventh subelement to specify a model number of the self-describing network device;

an eighth subelement to specify a URL of a website for the self-describing network device;

a ninth subelement to specify a URL of a website for a presentation hosted by the self-describing network device;

a tenth subelement to specify a serial number of the self-describing network device;

an eleventh subelement to specify a universal device name of the self-describing network device;

a twelfth subelement to specify a universal product code of the self-describing network device;

a thirteenth subelement to specify any icons associated with the self-describing network device;

a fourteenth subelement to identify any of one or more services supported by the self-describing network device; and

a fifteenth subelement to identify any of one or more devices embedded within the self-describing network device.

35. One or more computer-readable media as recited in claim 31, wherein the second set of elements includes at least one of:

a first element to identify any of one or more actions performed by the service; and

a second element to identify any of one or more state variables in the service.

36. One or more computer-readable media as recited in claim 35, wherein the first element of the second set of elements includes at least one subelement for each corresponding action, the subelement containing a name string to hold a name of the action and an argument list to hold parameters of the action.

37. One or more computer-readable media as recited in claim 35, wherein the second element of the second set of elements includes at least one of:

a first subelement to identify a name of a state variable;

a second subelement to specify a data type of the state variable;

a third subelement to specify a default value of the state variable;

a fourth subelement to enumerate legal string values; and

a fifth subelement to define bounds of legal numeric values.

38. One or more computer-readable media as recited in claim 31, wherein the code segment is configured to respond to an HTTP GET request by returning the description in a body of an HTTP response.

40. A self-describing network device as recited in claim 39, wherein the description data comprises a first set of elements a first set of elements to describe the self-describing network device and a second set of elements to describe a service supported by the self-describing network device.

41. A self-describing network device as recited in claim 39, wherein the set of elements comprises at least one of:

a first element to identify one or more versions of the template language;

a second element to identify the self-describing network device; and

a third element to specify a base universal resource locator (URL).

42. A self-describing network device as recited in claim 41, wherein the second element includes at least one of:

a first subelement to specify a type of self-describing network device;

a second subelement to identify a user;

a third subelement to identify a manufacturer;

a fourth subelement to specify a URL of a website for the manufacturer;

a fifth subelement to provide a word description of the self-describing network device for the user;

a sixth subelement to specify a model name of the self-describing network device;

a seventh subelement to specify a model number of the self-describing network device;

an eighth subelement to specify a URL of a website for the self-describing network device;

a ninth subelement to specify a URL of a website for a presentation hosted by the self-describing network device;

a tenth subelement to specify a serial number of the self-describing network device;

an eleventh subelement to specify a universal device name of the self-describing network device;

a twelfth subelement to specify a universal product code of the self-describing network device;

a thirteenth subelement to specify any icons associated with the self-describing network device;

a fourteenth subelement to identify any of one or more services supported by the self-describing network device; and

a fifteenth subelement to identify any of one or more devices embedded within the self-describing network device.

43. A self-describing network device as recited in claim 39, wherein the set of elements includes at least one of:

a first element to identify any of one or more actions performed by a service supported by the self-describing network device; and

a second element to identify any of one or more state variables in the service.

44. A self-describing network device as recited in claim 43, wherein the first element includes at least one subelement for each corresponding action, the subelement containing a name string to hold a name of the action and an argument list to hold parameters of the action.

45. A self-describing network device as recited in claim 43, wherein the second element includes at least one of:

a first subelement to identify a name of a state variable;

a second subelement to specify a data type of the state variable;

a third subelement to specify a default value of the state variable;

a fourth subelement to enumerate legal string values; and

a fifth subelement to define bounds of legal numeric values.

39. A self-describing network device comprising:

a memory;

a description of the self-describing network device stored in the memory, the description comprising a set of elements written in an XML syntax to describe the self-describing network device; and

a processor coupled to the memory to submit the description to a remote entity on a network.

46. A self-describing network device comprising:

storage means for storing a description of the self-describing network device, the description comprising a set of elements to describe the self-describing network device and an XML-based syntax that structures the set of elements such that, when the data structure is read by another computing device, the computing device can learn about the self-describing network device; and

responsive means for making the description available to another computing device.