Packages

m2x_erlang

0.0.1
1.3.1 1.3.0 1.2.0 1.1.0 1.0.0 0.0.1

Erlang client library for the AT&T M2X (http://m2x.att.com) API. AT&T M2X is a cloud-based fully managed time-series data storage service for network connected machine-to-machine (M2M) devices and the Internet of Things (IoT).

Current section

Files

Jump to
Readme
6 Versions
2 Dependencies
Dependants
Files
Activity
m2x_erlang src m2x_device.erl
Raw

src/m2x_device.erl 



-module(m2x_device).



%% API

-export([view/2                      ]).

-export([           update/3         ]).

-export([delete/2                    ]).

-export([log/2                       ]).

-export([location/2                  ]).

-export([           update_location/3]).

-export([streams/2                   ]).

-export([values/2,  values/3         ]).

-export([           post_updates/3   ]).

-export([triggers/2                  ]).

-export([           create_trigger/3 ]).



%% @doc Get details of an existing device.

%% https://m2x.att.com/developer/documentation/v2/device#View-Device-Details

view(Client, Device)                    -> Client({get, <<"/devices/", Device/binary>>}).



%% @doc Update an existing device's information.

%% https://m2x.att.com/developer/documentation/v2/device#Update-Device-Details

update(Client, Device, Params)          -> Client({put, <<"/devices/", Device/binary>>, Params}).



%% @doc Delete an existing device.

%% https://m2x.att.com/developer/documentation/v2/device#Delete-Device

delete(Client, Device)                  -> Client({delete, <<"/devices/", Device/binary>>}).



%% @doc Retrieve list of HTTP requests received lately by the specified device.

%% https://m2x.att.com/developer/documentation/v2/device#View-Request-Log

log(Client, Device)                     -> Client({get, <<"/devices/", Device/binary, "/log">>}).



%% @doc Get location details of an existing device.

%% https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location

location(Client, Device)                -> Client({get, <<"/devices/", Device/binary, "/location">>}).



%% @doc Update the current location of the specified device.

%% https://m2x.att.com/developer/documentation/v2/device#Update-Device-Location

update_location(Client, Device, Params) -> Client({put, <<"/devices/", Device/binary, "/location">>, Params}).



%% @doc Retrieve list of data streams associated with the specified device.

%% https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams

streams(Client, Device)                 -> Client({get, <<"/devices/", Device/binary, "/streams">>}).



%% @doc List values from all data streams associated with a specific device.

%% https://m2x.att.com/developer/documentation/v2/device#List-Values-from-all-Data-Streams-of-a-Device

values(Client, Device)                  -> Client({get, <<"/devices/", Device/binary, "/values">>}).

values(Client, Device, Params)          -> Client({get, <<"/devices/", Device/binary, "/values">>, Params}).



%% @doc Post values to multiple streams at once.

%% https://m2x.att.com/developer/documentation/v2/device#Post-Device-Updates-Multiple-Values-to-Multiple-Streams

post_updates(Client, Device, Params)    -> Client({post, <<"/devices/", Device/binary, "/updates">>, Params}).



%% @doc Retrieve list of triggers associated with the specified device.

%% https://m2x.att.com/developer/documentation/v2/device#List-Triggers

triggers(Client, Device)                -> Client({get, <<"/devices/", Device/binary, "/triggers">>}).



%% @doc Create a new trigger associated with the specified device.

%% https://m2x.att.com/developer/documentation/v2/device#Create-Trigger

create_trigger(Client, Device, Params)  -> Client({post, <<"/devices/", Device/binary, "/triggers">>, Params}).