# cirrent-sdk

> Cirrent SDK

Latest version **1.1.3** (published 2015-09-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install cirrent-sdk
pnpm add cirrent-sdk
yarn add cirrent-sdk
bun add cirrent-sdk
```

## 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.1.3 |
| Published | 2015-09-24 |
| First published | 2015-06-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Roshan Paiva |
| Maintainers | roshan_cirrent |
| Keywords | cirrent, iot |

## Links

- npm: https://www.npmjs.com/package/cirrent-sdk
- Repository: https://github.com/Cirrent/cirrent-sdk
- Issues: https://github.com/Cirrent/cirrent-sdk/issues
- npm.io page: https://npm.io/package/cirrent-sdk

## Dependencies (4)

- [async](https://npm.io/package/async.md) ^1.3.0
- [lodash](https://npm.io/package/lodash.md) ^3.9.3
- [winston](https://npm.io/package/winston.md) ^1.0.1
- [swagger-client](https://npm.io/package/swagger-client.md) 2.1.6-M2

## Recent versions

- 1.1.3 (latest) — 2015-09-24
- 1.1.2 — 2015-08-18
- 1.1.1 — 2015-08-18
- 1.1.0 — 2015-08-18
- 1.0.9 — 2015-08-18
- 1.0.8 — 2015-08-17
- 1.0.7 — 2015-07-07
- 1.0.6 — 2015-07-07
- 1.0.5 — 2015-06-23
- 1.0.4 — 2015-06-20
- 1.0.3 — 2015-06-19
- 1.0.2 — 2015-06-19
- 1.0.1 — 2015-06-19
- 1.0.0 — 2015-06-19

## README

# Cirrent SDK

## Installation

```sh
npm install cirrent-sdk
```

## Usage
To write an app using the SDK

  * Register for a developer account and get your API_KEY and API_SECRET at [Cirrent Developer Portal](https://cirrent.co).
  * Add dependency 'cirrent-sdk' in your package.json file.
  * Require 'cirrent-sdk' in your file

    ```js
    var cirrent = require('cirrent-sdk');
    ```
  * Configure the API you use with parameters (API_KEY, API_SECRET).

    ```js
    cirrent.configureSys({
      'API_KEY': '<API_KEY>',
      'API_SECRET': '<API_SECRET'
    });
    ```


  * Start calling methods. Example: Get devices
    ```js
    cirrent.sys.getDevices(function (error, devices) {
        if (error) {
            throw error;
        } else {
            console.log("Get Devices Response", devices);
        }
    });
    ```

## Running Samples
Samples are located in the samples directory.

To run:
```sh
node samples/sample_get_devices.js
```

---
_Source: https://npm.io/package/cirrent-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._