Methods and apparatus for using smart environment devices via application program interfaces

• US 9,456,297 B2
• Filed: 05/26/2015
• Issued: 09/27/2016
• Est. Priority Date: 06/23/2014
• Status: Active Grant

• Current Assignee: Google LLC (Alphabet Inc.)
• Original Assignee: Google Inc. (Alphabet Inc.)
• Inventors: Pi-Sunyer, Carles
• Primary Examiner(s): Holder, Bradley
• Assistant Examiner(s): JACKSON, JENISE E
• Application Number:
  US14/722,026
• Publication Number:
  US 20150372999A1
• Time in Patent Office: 490 Days
• Field of Search: 726/4
• US Class Current: 1/1
• CPC Class Codes: F24F 11/30 for purposes related to the operation of the system, e.g. for safety or monitoring
• CPC Class Codes: F24F 11/46 Improving electric energy efficiency or saving
• CPC Class Codes: F24F 11/48 prior to normal operation, e.g. pre-heating or pre-cooling
• CPC Class Codes: F24F 11/523 for displaying temperature data
• CPC Class Codes: F24F 11/58 using Internet communication
• CPC Class Codes: F24F 11/61 using timers
• CPC Class Codes: F24F 11/62 characterised by the type of control or by internal processing, e.g. using fuzzy logic, adaptive control or estimation of values
• CPC Class Codes: F24F 11/65 for selecting an operating mode
• CPC Class Codes: F24F 2120/00 Control inputs relating to users or occupants
• CPC Class Codes: G05B 13/04 involving the use of models or simulators
• CPC Class Codes: G05B 15/02 electric
• CPC Class Codes: G05B 17/02 electric
• CPC Class Codes: G05B 2219/2642 Domotique, domestic, home control, automation, smart house
• CPC Class Codes: G05D 23/1904 variable in time
• CPC Class Codes: G05D 23/1917 using digital means
• CPC Class Codes: G06F 9/54 Interprogram communication
• CPC Class Codes: G06F 9/541 via adapters, e.g. between incompatible applications
• CPC Class Codes: G06F 9/546 Message passing systems or structures, e.g. queues
• CPC Class Codes: G08B 17/10 Actuation by presence of smoke or gases , e.g. automatic alarm devices for analysing flowing fluid materials by the use of optical means
• CPC Class Codes: H04L 12/2803 Home automation networks
• CPC Class Codes: H04L 12/2816 : Controlling appliance services of a home automation network by calling their functionalities arrangements in telecontrol or telemetry systems for selectively calling a substation from a main station; in which substation desired apparatus is selected for applying a control signal thereto or for obtaining measured values therefrom H04Q9/00
• 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/282 : based on user interaction within the home receiver circuitry for displaying additional information being controlled by a remote control apparatus H04N21/42204
• CPC Class Codes: H04L 12/2823 : Reporting information sensed by appliance or service execution status of appliance services in a home automation network device-related reporting H04L43/065; arrangements in telecontrol or telemetry systems for selectively calling a substation from a main station, in which substation desired apparatus is selected for applying a control signal thereto or for obtaining measured values therefrom H04Q9/00
• CPC Class Codes: H04L 12/2829 : involving user profiles according to which the execution of a home appliance functionality is automatically triggered
• CPC Class Codes: H04L 2012/2841 : Wireless
• CPC Class Codes: H04L 2012/285 : Generic home appliances, e.g. refrigerators
• CPC Class Codes: H04L 63/08 : for authentication of entities cryptographic mechanisms or cryptographic arrangements for entity authentication H04L9/32
• 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/01 : Protocols
• CPC Class Codes: H04L 67/1097 : for distributed storage of data in networks, e.g. transport arrangements for network file system [NFS], storage area networks [SAN] or network attached storage [NAS]
• CPC Class Codes: H04L 67/12 : specially adapted for proprietary or special-purpose networking environments, e.g. medical networks, sensor networks, networks in vehicles or remote metering networks
• CPC Class Codes: H04L 67/30 : Profiles
• CPC Class Codes: H04L 67/535 : Tracking the activity of the user network monitoring arrangements H04L43/00; recording of computer activity G06F11/34
• CPC Class Codes: H04M 1/72415 : for remote control of appliances
• CPC Class Codes: H04W 4/021 : Services related to particular areas, e.g. point of interest [POI] services, venue services or geofences
• CPC Class Codes: H04W 4/60 : Subscription-based services using application servers or record carriers, e.g. SIM application toolkits
• CPC Class Codes: H04W 4/80 : Services using short range communication, e.g. near-field communication [NFC], radio-frequency identification [RFID] or low energy communication
• CPC Class Codes: H05B 47/105 : in response to determined parameters
• CPC Class Codes: H05B 47/19 : via wireless transmission
• CPC Class Codes: Y02B 20/40 : Control techniques providing energy savings, e.g. smart controller or presence detection

Abstract

In one embodiments, a method for authorizing access for an application programming interface (API) client or API client device to data of one or more data models of one or more smart devices includes retrieving a number of access tokens from an authorization server, and providing, via a single connection, the number of access tokens in a request made by the API client or the API client device to the API, wherein the number of access tokens are used to verify access rights of the API client or the API client device to read data for a number of users associated with the one or more data models of the one or more smart devices.

Claims

1. A method, comprising:

retrieving, via a hardware processor of an application programming interface client (API client) or an application programming interface client device (API client device) communicatively coupled to an application programming interface (API), a plurality of access tokens associated with the API client or the API client device from an authorization server;

sending, via the API client or the API client device, a first data model access request to the API communicatively coupled to the API client or the API client device via a single connection, wherein the first data model access request comprises the plurality of access tokens, and the plurality of access tokens are used to verify access rights of the API client or the API client device to access resource data for a plurality of users of the API client or the API client device from one or more data models, the resource data related to one or more smart devices; and

retrieving, via the API client or the API client device, the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens, wherein the retrieved resource data comprises all data values in all structure objects that include at least references to devices in the structure and in all device objects that include at least temperature setpoints of a thermostat and alarm states of a smoke alarm, a carbon monoxide alarm, or both in the structure of the one or more data models that are associated with a respective access token of the plurality of access tokens.

2. The method of claim 1, comprising opening the single connection between the API client or the API client device and a server hosting the API communicatively coupled to the API client or the API client device when the API client or the API client device makes the first data model access request, wherein:

the first data model access request is a representational state transfer (REST) streaming call;

the API client comprises a remote API integration point associated with a vendor of the API client device; and

the API client device comprises an electronic device that accesses the API communicatively coupled to the API client or the API client device via the remote API integration point.

3. The method of claim 1, comprising including a list of the plurality of access tokens in a query string when sending data model access requests to the API communicatively coupled to the API client or the API client device.

4. The method of claim 1, comprising mapping the plurality of access tokens to corresponding users of the one or more smart devices when the API communicatively coupled to the API client or the API client device returns response data to the API client or the API client device.

5. The method of claim 1, wherein retrieving the plurality of access tokens comprises accumulating the plurality of access tokens over a period of time.

6. The method of claim 1, comprising for each of the plurality of access tokens, retrieving the access token comprises:

providing an authorization code to the authorization server;

wherein the authorization server validates the authorization code and associates the access token with the API client or API client device prior to returning the access token.

7. The method of claim 1, comprising:

closing the single connection, via the API client or the API client device, when data for users associated with additional access tokens is desired; and

sending a second data model access request including the additional access tokens with the plurality of access to the API communicatively coupled to the API client or the API client device to establish a new single connection.

8. The method of claim 1, for each of the plurality of access tokens, retrieving the access token comprises:

providing an authorization code lo ihe authorization server to obtain the access token;

wherein the authorization code is provided lo the API client or the API client device when a user of the one or more smart devices grants access rights for the API client or the API client device via a resource access permission page that prompts the user to grant the access rights to data elements of the one or more data models to the API client or the API client device to enable data model access requests from the API client or the API client device to be processed by a device service in accordance with the access rights.

9. The method of claim 8, wherein:

the access rights are presented in conjunction with one or more justifications for

the access rights on the resource access permission page; and

the one or more justifications indicate what actions the API client or the API client device performs with the data elements and how the actions benefit the user of the one or more smart devices.

10. A method, comprising:

retrieving, via an application programming interface client (API client) or an application programming interface client device (API client device) communicatively coupled to an application programming interface (API), a plurality of access tokens associated with the API client or the API client device from an authorization server by providing one or more authorization codes to the authorization server, wherein the one or more authorization codes are received by the API client or the API client device when a user of one or more smart devices grants access rights for the API client or the API client device via a resource access permission page that prompts the user to grant the access rights to resource data of one or more data models to the API client or the API client device to enable data model access requests from the API client or the API client device to be processed by a device service in accordance with the access rights;

sending a first data model access request to the API communicatively coupled to the API client or the API client device via a single connection, wherein the first data model access request comprises the plurality of access tokens and the plurality of access tokens are used to verify the access rights of the API client or the API client device to access the resource data for a plurality of users of the API client or the API client device from the one or more data models, the resource data related to the one or more smart devices; and

retrieving the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens.

11. The method of claim 10, comprising opening the single connection between the API client or the API client device and a server hosting the API communicatively

coupled to the API client or the API client device when the API client or the API client device makes the first data model access request, wherein:

the first data model access request is a representational state transfer (REST) streaming call;

the API client comprises a remote API integration point associated with a vendor of the API client device; and

the API client device comprises an electronic device that accesses the API communicatively coupled to the API client or the API client device via the remote API integration point.

12. The method of claim 10, wherein, for each of the plurality of access tokens, retrieving the access token comprises:

providing an authorization code to the authorization server;

wherein the authorization server validates the authorization code and associates the access token with the API client or API client device prior to returning the access token.

13. A system, comprising:

a computer hardware processor of an application programming interface client (API client) or an application programming interface client device (API client device)

communicatively coupled to an application programming interface (API), wherein the computer hardware processor is configured to;

retrieve a plurality of access tokens associated with the API client or the API client device from an authorization server by providing one or more authorization codes to the authorization server, wherein the one or more authorization codes are received by the API client or the API client device when a user of one or more smart devices grants access rights for the API client or the API client device via a resource access permission page that prompts the user to grant the access rights to resource data of one or more data models to the API client or the API client device to enable data model access requests from the API client or the API client device to be processed by a device service in accordance with the access rights;

send a first data model access request to the API communicatively coupled to the API client or the API client device via a single connection, wherein the first data model access request comprises the plurality of access tokens and the plurality of access tokens are used to verify the access rights of the API client or the API client device to access the resource data for a plurality of users of the API client or the API client device from the one or more data models, the resource data related to the one or more smart devices; and

retrieve the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens.

14. The system of claim 13, wherein the computer processor is configured to map the plurality of access tokens to corresponding users of the one or more smart devices when the API communicatively coupled to the API client or the API client device returns response data.

15. The system of claim 13, wherein the computer processor is configured to maintain the single connection for a period of time and send additional single data model access requests including the plurality of access tokens during the period of time.

16. A system, comprising:

a computer hardware processor of an application programming interface client (API client) or an application programming interface client device (API client device) communicatively coupled to an application programming interface (API) communicatively coupled to the API client or the API client device, wherein the computer hardware processor is configured to;

retrieve, via the API client or the API client device, a plurality of access tokens associated with the API client or the API client device from an authorization server;

send a first data model access request to the API communicatively coupled to the API client or the API client device via a single connection, wherein the first data model access request comprises the plurality of access tokens, and the plurality of access tokens are used to verify access rights of the API client or the API client device to access resource data for a plurality of users of the API client or the API client device from one or more data models, the resource data related to one or more smart devices; and

retrieve the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens, wherein the retrieved resource data comprises all data values in all structure objects that include at least references to devices in the structure and in all device objects that include at least temperature setpoints of a thermostat and alarm states of a smoke alarm, a carbon monoxide alarm, or both in the structure of the one or more data models that are associated with a respective access token of the plurality of access tokens.

17. The system of claim 16, wherein the computer hardware processor is configured to retrieve the plurality of access tokens by accumulating the plurality of access tokens over a period of time.

18. The system of claim 16, wherein the computer hardware processor is configured to map the plurality of access tokens to corresponding users of the one or more smart devices when the computer processor retrieves the resource data.

19. A system, comprising:

a computer hardware processor of an application programming interface client (API client) or an application programming interface client device (API client device) communicatively coupled to an application programming interface (API), wherein the computer hardware processor is configured to;

retrieve a plurality of access tokens associated with the API client or the API client device from an authorization server by providing one or more authorization codes to the authorization server, wherein the authorization server validates the one or more authorization codes and associates each of the plurality of access tokens with the API client or the API client device;

send a first data model access request to the API via a single connection, wherein the first data model access request comprises the plurality of access, and the plurality of access tokens are used to verify access rights of the API client or the API client device to access resource data for a plurality of users of the API client or API client device from the one or more data models, the resource data related to the one or more smart devices; and

retrieve the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens.

20. The system of claim 19, where the first data model access request includes a list of the plurality of access tokens in a query string.

21. The system of claim 19, wherein the computer hardware processor is configured to open the single connection between the API client or the API client device and a server hosting the API communicatively coupled to the API client or the API client device when the API client or the API client device makes the first data model access request, wherein:

the first data model access request is a representational state transfer (REST) streaming call;

the API client comprises a remote API integration point associated with a vendor of the API client device; and

the API client device comprises an electronic device that accesses the API communicatively coupled to the API client or the API client device via the remote API integration point.

22. One or more tangible, non-transitory computer-readable media storing computer instructions that, when executed by a hardware processor of an application programming interface client (API client) or an application programming interface client device (API client device) communicatively coupled to an application programming interface (API), that when executed are configured to:

retrieve a plurality of access tokens associated with the API client device from an authorization server by providing one or more authorization codes to the authorization server, wherein the authorization server validates the one or more authorization codes and associates each of the plurality of access tokens with the API client or the API client device;

send a first data model access request to the API communicatively coupled to the API client or the API client device via a single connection, wherein the first data model access request comprises the plurality of access, and the plurality of access tokens are used to verify access rights of the API client or the API client device to access resource data for a plurality of users of the API client or the API client device from the one or more data models, the resource data related to one or more smart devices; and

retrieve the resource data for the plurality of users after the access rights are verified according to the plurality of access tokens.

23. The computer-readable media of claim 22, wherein the computer instructions are configured to open the single connection with a server hosting the API communicatively coupled to the API client or the API client device when the first data model access request is sent, wherein:

the API client comprises a remote API integration point associated with a vendor of the API client device; and

the API client device comprises an electronic device that accesses the API communicatively coupled to the API client or the API client device via the remote API integration point.

24. The computer-readable media of claim 22, wherein the computer instructions are configured to receive a response to the first data model access request, wherein the response comprises all data values in all structure objects that include at least references to devices in a building and in all device objects that include at least temperature setpoints of thermostats and alarm states of smoke and carbon monoxide alarms in the structure of the one or more data models that are associated with the respective access token of the plurality of access tokens.

25. The computer-readable media of claim 22, wherein the computer instructions are configured to provide a query string when sending the first data model access request to the API communicatively coupled to the API client or the API client device, wherein the query string includes a list of the plurality of access tokens.

26. The computer-readable media of claim 22, wherein the computer instructions are configured to:

receive a response from the API communicatively coupled to the API client or the API client device, wherein the response includes a data object comprising requested resource data and a metadata data object that includes an access token; and

correlate the access token to a user associated with the requested data.

27. The computer-readable media of claim 22, wherein the computer instructions are configured to not establish the single connection when more than a threshold number of access tokens are included in the first data model access request sent to the API communicatively coupled to the API client or the API client device.

28. The computer-read able media of claim 22, wherein the computer instructions are configured to maintain the single connection over a period of time, and to intermediately send one more subsequent data model access requests including the plurality of access tokens during the period of time.