# m2x-enhanced-trigger > AT&T M2X API client for node.js Latest version **1.0.0** (published 2017-05-31) · MIT license · 0 weekly downloads ## Install ```sh npm install m2x-enhanced-trigger pnpm add m2x-enhanced-trigger yarn add m2x-enhanced-trigger bun add m2x-enhanced-trigger ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2017-05-31 | | First published | 2017-05-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Author | Gabriel García | | Maintainers | ss7809 | | Keywords | at&t, m2x | ## Links - npm: https://www.npmjs.com/package/m2x-enhanced-trigger - Repository: https://github.com/attm2x/m2x-nodejs - Homepage: https://github.com/attm2x/m2x-nodejs#readme - Issues: https://github.com/attm2x/m2x-nodejs/issues - npm.io page: https://npm.io/package/m2x-enhanced-trigger ## Dependencies (1) - [request](https://npm.io/package/request.md) >=2.27.0 ## Recent versions - 1.0.0 (latest) — 2017-05-31 ## README # AT&T's M2X Node.js Client [AT&T M2X](http://m2x.att.com) 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). The [AT&T M2X API](https://m2x.att.com/developer/documentation/overview) provides all the needed operations and methods to connect your devices to AT&T's M2X service. This library aims to provide a simple wrapper to interact with the AT&T M2X API for [Node.js](http://nodejs.org/). Refer to the [Glossary of Terms](https://m2x.att.com/developer/documentation/glossary) to understand the nomenclature used throughout this documentation. Getting Started ========================== 1. Signup for an [M2X Account](https://m2x.att.com/signup). 2. Obtain your _Master Key_ from the Master Keys tab of your [Account Settings](https://m2x.att.com/account) screen. 2. Create your first [Device](https://m2x.att.com/devices) and copy its _Device ID_. 3. Review the [M2X API Documentation](https://m2x.att.com/developer/documentation/overview). ## Installation m2x-nodejs is available as an npm package (https://www.npmjs.com/package/m2x-enhanced-trigger). Install the latest version with: npm install m2x-enhanced-trigger ## Usage ## ### M2X Class ### The main object encapsulating all API functionality is the global variable ``M2X``. In order to create a M2X object you will need an API key, which can be either a Master Key or a key belonging to a specific device (in which case you will only be allowed to read/write to this device). The following is a short example on how to instantiate an M2X object: ```javascript var M2X = require("m2x-enhanced-trigger"); var m2x = new M2X(""); ``` The M2X object also provides a simple method for checking the API status (so if you are having connectivity issues, you can check whether the API is currently down): ```javascript m2x.status(function(status) { console.log(status); }); ``` An M2X object provides methods for communicating with the remote API. Methods are organized under the following modules: `collection`, `commands`, `devices`, `distributions`, `jobs` and `keys`. - [Collections](lib/collections.js) ```javascript m2x.collections.view("", function(response) { console.log(response.json); }); m2x.collections.list(function(response) { console.log(response.json); }); ``` - [Commands](lib/commands.js) ```javascript m2x.commands.view("", function(response) { console.log(response.json); }); m2x.commands.list(function(response) { console.log(response.json); }); ``` - [Devices](lib/devices.js) ```javascript m2x.devices.view("", function(response) { console.log(response.json); }); m2x.devices.list(function(response) { console.log(response.json); }); m2x.devices.listTriggers("",function(response) { console.log(response.json); }); m2x.devices.createTriggers("","",function(response) { console.log(response.json); }); m2x.devices.deleteTriggers("","",function(response) { console.log(response.json); }); ``` - [Distributions](lib/distributions.js) ```javascript m2x.distributions.view("", function(response) { console.log(response.json); }); m2x.distributions.list(function(response) { console.log(response.json); }); ``` - [Jobs](lib/jobs.js) ```javascript m2x.jobs.view("", function(response) { console.log(response.json); }); ``` - [Keys](lib/keys.js) ```javascript m2x.keys.view("", function(response) { console.log(response.json); }); m2x.keys.list(function(response) { console.log(response.json); }); ``` ### Time ### For devices that do not have a Real Time Clock, M2X provides a [set of endpoints that returns the server's time](https://m2x.att.com/developer/documentation/v2/time). ```javascript m2x.time(function(response) { console.log(response.json); }); m2x.timeSeconds(function(response) { console.log(response.raw); }); m2x.timeMillis(function(response) { console.log(response.raw); }); m2x.timeIso8601(function(response) { console.log(response.raw); }); ``` Refer to the documentation on each class for further usage instructions. ## Examples ## ```javascript // // This is a simple application that requests the list // of available devices for the provided API Key and then // prints the details for each of those devices // var API_KEY = "", M2X = require("m2x"), m2xClient = new M2X(API_KEY); m2xClient.devices.list(function(response) { if (response.isSuccess()) { response.json.devices.forEach(function(device) { console.log(device); }); } else { console.log(JSON.stringify(response.error())); } }); ``` ## Example usage ## You can find additional examples in the [`examples`](examples) directory. Instructions for each example can be found within the comments of the example file. All examples require the `m2x-nodejs` library. If you will be running the examples from within the `examples` directory, you will need to install the library dependencies within the root directory of the `m2x-nodejs` folder: ``` npm install ``` Or, if you move the example file(s) out of the `examples` directory you will need to modify the `m2x-nodejs` require line and install the `m2x-nodejs` library in the root directory where the example file is stored: Change require line as follows: ``` var M2X = require("m2x"); ``` Install `m2x-nodejs` package using npm in the root directory where you have stored the examples: ``` npm install m2x ``` Once you've selected an example to run, open the file and add your user specific information such as your `API Key`, `Device ID`, etc., and then run the example with the following command: ``` node example_filename.js ``` ## Versioning This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/). As a summary, given a version number `MAJOR.MINOR.PATCH`: 1. `MAJOR` will increment when backwards-incompatible changes are introduced to the client. 2. `MINOR` will increment when backwards-compatible functionality is added. 3. `PATCH` will increment with backwards-compatible bug fixes. Additional labels for pre-release and build metadata are available as extensions to the `MAJOR.MINOR.PATCH` format. **Note**: the client version does not necessarily reflect the version used in the AT&T M2X API. ## License ## This library is provided under the MIT license. See [LICENSE](LICENSE) for applicable terms. ## Acknowledgements ## This client is a direct port of Leandro Lopez' [AT&T M2X client for Ruby](https://github.com/attm2x/m2x-ruby) so all the credit should go to him. --- _Source: https://npm.io/package/m2x-enhanced-trigger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._