/ 
Device-Nest-0.01
River stage zero No dependents
/ Device::Nest

NAME

Device::Nest - Methods for wrapping the Nest API calls so that they are accessible via Perl

VERSION

Version 0.01

SYNOPSIS

This module provides a Perl interface to a Nest Thermostat via the following 
methods:
  - new
  - connect

Please note that in order to use this module you will require two parameters
($ClientID,$ClientSecret) as well as a Nest Thermostat installed in your house.

The module is written entirely in Perl and has been developped on Raspbian Linux.

SAMPLE CODE

  use Device::Neurio;

  $my_Nest = Device::Nest->new($ClientID,$ClientSecret);

  $my_Nest->connect();

  undef $my_Nest;

EXPORT

All by default.

SUBROUTINES/METHODS

new - the constructor for a Neurio object

Creates a new instance which will be able to fetch data from a unique Neurio 
sensor.

my $Nest = Device::Nest->new($key,$secret,$sensor_id);

  This method accepts the following parameters:
    - $key       : unique key for the account - Required 
    - $secret    : secret key for the account - Required
    - $sensor_id : sensor ID connected to the account - Required 

Returns a Neurio object if successful.
Returns 0 on failure

connect - open a secure connection to the Nest server

Opens a secure connection via HTTPS to the Nest server which provides
access to a set of API commands to access the thermostat data.

  $Nest->connect();

This method accepts no parameters

Returns 1 on success 
Returns 0 on failure

fetch_Temperature - Fetch the current temperature reported by Nest

Retrieves the current temperature reported by the Nest.

  $Nest->fetch_Temperature();

  This method accepts no parameters

Returns a Perl data structure on success:
Returns 0 on failure

AUTHOR

Kedar Warriner, kedar at cpan.org

BUGS

Please report any bugs or feature requests to C<bug-device-Nest at rt.cpan.org>
or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Device-Nest
I will be notified, and then you'll automatically be notified of progress on 
your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

 perldoc Device::Nest

You can also look for information at:

ACKNOWLEDGEMENTS

Many thanks to:
 The guys at Nest for creating the Nest Thermostat sensor and 
     developping the API.
 Everyone involved with CPAN.

LICENSE AND COPYRIGHT

Copyright 2014 Kedar Warriner <kedar at cpan.org>.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.