KR101386652B1 - Control method for upnp devices in upnp home network using restful api - Google Patents

Abstract

A method in the present invention automatically generates a RESTful URI based on a UPnP command and obtains information from UPnP devices or controls UPnP devices using the same. A method for obtaining information of UPnP devices includes: a step of receiving a SOAP/HTTP packet; and a step of generating a RESTful URI which comprises http://[device IP address]/[serviceType]/[variableName] based on information included in the SOAP/HTTP packet. A method for controlling UPnP devices as a method for controlling UPnP devices through a RESTful API based on a UPnP command used in a UPnP home network includes: a step of receiving a SOAP/HTTP packet; and a step of generating a RESTful URI which comprises http://[device IP address]/[serviceType]/[actionName] based on the information included in the SOAP/HTTP packet. [Reference numerals] (AA) Start; (BB,GG) Yes; (CC,FF) No; (DD) Address: http://[device IP address]/[serviceType]/[variableName]; (EE) HTTP body: Ignore; (HH) Address: http://[device IP address]/[serviceType]/[actionName]; (II) HTTP body: list of [Name]-[Value] pairs including the following information; (JJ) hostName and PortNumber; (KK) actionName and its value; (LL) arguemntName and its value (when it is plural, repeat); (MM) End; (S210) SOAP/HTTP packet

Description

Control method for UPnP devices in UPnP home network using RESTful API}

The present invention relates to a method of controlling a UPnP device using a RESTful API in a UPnP home network, and more particularly, to a method of controlling a UPnP device using a RESTful API in a UPnP home network by automatically generating a RESTful URI. will be.

As the home multimedia appliances and PCs become more popular, the demand for a method of sharing multimedia is increasing day by day. Home appliances and IT companies have been developing and developing home network technologies for about 10 years to meet these demands. Among them, UPNP-Universal Plug and Play has been expanding its field with the support of leading companies such as Microsoft and is now the most promising home network technology. UPnP is an IP network-based home network technology that provides a framework for easily sharing multimedia on a home network with minimal user setup.

In addition, the development of web technology is planning an environment in which all information is defined using a language used on the web and controlled using a protocol used on the web. Called Web of Things or Web of Objects, this technique presents all information or state as a Uniform Resource Indicator (URI) used on the Web, and suggests how to obtain and control this information using the HTTP protocol. . The architecture used in this case is REsource State Transfer (REST or RESTful), which provides an architecture that enables the creation, acquisition, update, and deletion (Create, Request, Update, Delete-CRUD) of information through web technologies.

RESTful APIs control home appliances by applying the current web technologies. UPnP uses SOAP / HTTP as its equivalent function, which describes the SOAP protocol for control in XML syntax and sends it to the HTTP protocol once again.

It's hard to say which method is easier, but RESTful APIs are easier to construct packets than SOAP / HTTP (SOAP / HTTP requires XML, SOAP, HTTP, but RESTful requires HTTP only). As well as the configuration of the home appliance is expanding its scope of control.

However, UPnP technology is already distributed in most of the information in the electrical equipment, which is expected to be difficult to deploy RESTful technology because the compatibility with RESTful API is not guaranteed. In preparation for the control of SOAP / HTTP using UPnP, implementing a RESTful API separately increases the development burden on the enterprise in charge of development.

Therefore, a technology for securing compatibility between SOAP / HTTP and RESTful is inevitably required.

SUMMARY OF THE INVENTION The present invention has been made in the technical background as described above, and an object thereof is to provide a method for acquiring and controlling information through a RESTful API for a UPnP home network.

Another object of the present invention is to provide a control method of a UPnP device that can ensure compatibility between SOAP / HTTP and RESTful using UPnP.

In order to solve this problem, the present invention automatically generates a RESTful URI based on the UPnP command, and uses the same to acquire information from the UPnP device or control the UPnP device.

According to an aspect of the present invention, a method for obtaining information of a UPnP device includes: receiving a SOAP / HTTP packet through a RESTful API based on a UPnP command used in a UPnP home network; And generating a RESTful URI including http: // [device IP address] / [serviceType] / [variableName] based on the information included in the SOAP / HTTP packet, wherein the device IP address is the UPnP device. IP address, serviceType and variableName are UPnP service type and UPnP variable, respectively.

Here, it is preferable to further include the step of requesting information to the UPnP device using the HTTP GET Method and the generated RESTful URI after the step of generating the RESTful URI.

According to another aspect of the present invention, a method of controlling a UPnP device includes a method of controlling a UPnP device through a RESTful API based on a UPnP command used in a UPnP home network, the method comprising: receiving a SOAP / HTTP packet; Generating a RESTful URI consisting of http: // [device IP address] / [serviceType] / [actionName] based on the information included in the SOAP / HTTP packet, wherein device IP address is the device's IP address. IP address, serviceType and actionName are UPnP service type and UPnP action, respectively.

The method may further include, after receiving the SOAP / HTTP packet, extracting a path control URL, a hostName and a PortNumber, an actionName and its value, an argumentName and its value from the SOAP / HTTP packet, and extracting the RESTful URI. After the generating step, it is preferable to further include transmitting a control command to the UPnP device using the HTTP POST method, the RESTful URI generated and the extracted hostName and PortNumber, actionName and its value, argumentName and its value. .

The extracted hostName, PortNumber, actionName and its value, argumentName and its value may be included in the HTTP Body, and the argumentName and its value may be two or more, respectively.

According to the present invention, as described above, according to the method of automatically generating a RESTful URI according to an embodiment of the present invention, the state of the UPnP device is checked through the RESTful API while ensuring the reusability of the existing UPnP technology and the joint use of the UPnP and the RESTful API. Can be controlled.

As a result, RESTful services can be supported within the home network, thereby removing the burden of redundant technology development of UPnP / REST.

1 is a block diagram illustrating an outline of a method of automatically generating a RESTful URI according to an embodiment of the present invention.
2 is a flowchart illustrating a method of automatically generating a RESTful URI according to an embodiment of the present invention.

Advantages and features of the present invention and methods for achieving them will be apparent with reference to the embodiments described below in detail with the accompanying drawings. The present invention may, however, be embodied in many different forms and should not be construed as being limited to the embodiments set forth herein. Rather, these embodiments are provided so that this disclosure will be thorough and complete, and will fully convey the scope of the invention to those skilled in the art. Is provided to fully convey the scope of the invention to those skilled in the art, and the invention is only defined by the scope of the claims. It is to be understood that the terminology used herein is for the purpose of describing particular embodiments only and is not intended to be limiting of the invention. In the present specification, the singular form includes plural forms unless otherwise specified in the specification. It is noted that the terms "comprises" and / or "comprising" used in the specification are intended to be inclusive in a manner similar to the components, steps, operations, and / Or additions.

Hereinafter, a UPnP control technology supporting a RESTful API according to an embodiment of the present invention will be described in detail with reference to the accompanying drawings.

First, the command and variable configuration of SOAP / HTTP and RESTful API will be explained.

SOAP / HTTP uses HTTP GET method for device information acquisition and HTTP POST method for device control and inserts SOAP message described in XML into body part of HTTP packet. The main variables of the SOAP message are the SOAP command name and the list of SOAP variable values.

In contrast, RESTful can use HTTP GET to obtain information, HTTP POST to generate additional information, HTTP PUT or HTTP POST to update information, and HTTP DELETE or POST to delete information. In this case, a variable name-a list of variable values is inserted in the HTTP body.

The SOAP / HTTP packet consists of:

================================================== ==================

POST path control URL HTTP / 1.0

HOST: hostname : portNumber

CONTENT-LENGTH: bytes in body

CONTENT-TYPE: text / xml; charset = "utf-8"

USER-AGENT: OS / version UPnP / 1.1 product / version

SOAPACTION: "urn: schemas - upnp - org : service : serviceType : v # actionName "

<? xml version = "1.0"?>

< s : Envelope

xmlns: s = "http://schemas.xmlsoap.org/soap/envelope/"

s : encodingStyle = "http://schemas.xmlsoap.org/soap/encoding/">

< s : Body>

< u : actionName xmlns: u = "urn: schemas-upnp-org : service : serviceType : v ">

< argumentName > in arg value </ argumentName >

<!- other in args and their values go here, if any- >

</ u : actionName >

</ s : Body>

</ s : Envelope>

================================================== ==================

Here, the important values are as follows.

path control URL

hostname: portNumber

actionName value

-arguementName value list

Accordingly, in the embodiment of the present invention, the UPnP device is controlled by supporting the RESTful API, and for this purpose, the RESTful URI is automatically configured based on the above-described information.

That is, in order to generate a RESTful URI including each major value, the automatically generated RESTful URI is composed of the following folder structure.

● Automatic configuration of informational URIs

Address: http: // [device IP address] / [serviceType] / [variableName]

HTTP Method Supported: GET

HTTP Body: Ignore

Here, device IP address is an IP address of the corresponding UPnP device, and serviceType and variableName are UPnP service type and UPnP variable, respectively.

● Automatic configuration of information control URIs

Address: http: // [device IP address] / [serviceType] / [actionName]

HTTP Method Supported: POST

HTTP Body: List of [name]-[value] pairs containing the following information:

  path control URL

  hostName and PortNumber

  -actionName and its value

  -arguemntName and its value (repeat multiple)

Similarly, the device IP address is the IP address of the UPnP device, and serviceType and actionName are the UPnP service type and the UPnP action, respectively.

For example, the method of reading ContainerUpdateID of ContentDirectoryService of UPnP MediaServer with IP address of 10.0.0.1 is automatically created as RESTful URI as follows.

GET http://10.0.0.1/ContentDirectoryService/ContainerUpdateID

For example, a method of transmitting a Browse command of a UPnP MediaServer having an IP address of 10.0.0.1 is automatically generated as a RESTful URI as follows.

POST http://10.0.0.1/ContentDirectoryService/Browse

At this time, since Body includes path control URL, hostName and PortNumber, actionName and its value, arguemntName and its value, it contains the following contents.

(PathConrolURL, 10.0.0.1 / controlURL), (10.0.0.1:3000), (actionName, Browse), (ObjectID, 0), (BrowseFlag, BrowseDirectChildren), (Filter, *), (StartingIndex, 0), (RequestedCount , 0), (SortCriteria, *)

2 is a flowchart illustrating a method of automatically generating a RESTful URI according to an embodiment of the present invention.

As shown in FIG. 2, when a SOAP / HTTP packet is received (S210), and the packet is related to a GET method for providing information (S220), the address is http: // [device IP address] / [serviceType] / [variableName] is automatically generated, and information can be obtained from the UPnP device by the HTTP GET method using the generated address (S230). In this case, HTTP body is ignored in case of RESTful URI.

If the packet is about a POST method for information control (S240), http: // [device IP address] / [serviceType] / [actionName] is automatically generated as an address, and the HTTP is generated using the generated address. The control method for the UPnP may be performed by the POST method (S250). At this time, the HTTP Body includes path control URL, hostName and PortNumber, actionName and its value, arguemntName and its value.

As described above, according to the method of automatically generating a RESTful URI according to an embodiment of the present invention, it is possible to check and control the state of a UPnP device through a RESTful API while ensuring reusability of the existing UPnP technology and joint use of UPnP and RESTful APIs. .

As a result, RESTful services can be supported within the home network, thereby removing the burden of redundant technology development of UPnP / REST.

While the invention has been described in terms of the preferred embodiments, it is to be understood that the invention is not limited to the disclosed embodiments, but, on the contrary, is intended to cover various modifications and equivalent arrangements included within the spirit and scope of the invention. Accordingly, the appended claims are intended to embrace all such modifications and variations as fall within the true spirit of the invention.

Claims (6)

delete delete As a method of controlling UPnP devices through RESTful API based on UPnP commands used in UPnP home network,
Receiving a SOAP / HTTP packet;
Generating a RESTful URI consisting of http: // [device IP address] / [serviceType] / [actionName] based on the information included in the SOAP / HTTP packet (device IP address: of the UPnP device); IP address, serviceType: UPnP service type, actionName: UPnP action)
After receiving the SOAP / HTTP packet,
Extracting a path control URL, a hostName and a PortNumber, an actionName and its value, an argumentName and its value from the SOAP / HTTP packet,
After generating the RESTful URI,
And transmitting a control command to the UPnP device using an HTTP POST method, the generated RESTful URI, the extracted hostName, PortNumber, actionName, and its value, argumentName, and its value. delete The method of claim 3,
The extracted hostName, PortNumber, actionName and its value, argumentName and its value are included in the HTTP Body control method of the UPnP device. The method according to claim 3 or 5,
And at least two argumentNames and their values.

Images