Code Monkey home page Code Monkey logo

nodejs-sector-alarm's Introduction

Sector Alarm API

A Sector Alarm SDK written in TypeScript with test coverage using Tape. This is intended for use in Smart Home applications.

Requirements

node >= 10.0

Installation

npm i -S nodejs-sector-alarm

API

Usage

import { SectorApi } from "nodejs-sector-alarm";

// Setup the API client
const api = new SectorApi(email, password);
// Fetch a list of panels/alarms associated with the login credentials
const panelId = await api.getPanelList()[0].PanelId;
const panelCode = 1234;
// Disarm the alarm
await api.changeAlarmState(panelId, "Disarm", panelCode);

Debug logging

This library uses debug. Enable all logs by:

DEBUG=sectoralarm:*

or limit the logs to a certain log level by specifying {debug, info, warn, error} e.g:

DEBUG=sectoralarm:warn,sectoralarm:error

Disclaimer

This library is NOT an official integration from Sector Alarm. This library is neither endorsed nor supported by Sector Alarm. This implementation is based on reverse engineering REST calls used by the Sector Alarm iOS app, and may thus intermittently stop working if the underlying Sector API is updated.

Any utilization, consumption and application of this library is done at the user's own discretion. This library, its maintainers and Sector Alarm cannot guarantee the alarm's integrity if this library or any applications of this library are compromised.

nodejs-sector-alarm's People

Contributors

dependabot[bot] avatar jorgengrimnes avatar jorgenkg avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar

nodejs-sector-alarm's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource Name Replacement PR?
npm standard-version Available

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): replace dependency standard-version with commit-and-tag-version 9.5.0
  • chore(deps): update dependency koa to v2.15.3 (koa, @types/koa)
  • fix(deps): update dependency debug to v4.3.5
  • chore(deps): update dependency eslint to v8.57.0
  • chore(deps): update dependency typedoc to v0.26.5
  • chore(deps): update dependency why-is-node-running to v2.3.0
  • chore(deps): update dependency @types/node to v20
  • chore(deps): update dependency eslint to v9
  • chore(deps): update dependency husky to v9
  • chore(deps): update dependency koa-route to v4
  • chore(deps): update dependency why-is-node-running to v3
  • chore(deps): update js-devtools/npm-publish action to v3
  • fix(deps): update dependency got to v14
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/build-master.yml
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
  • JS-DevTools/npm-publish v1
.github/workflows/pr.yml
  • actions/checkout v3
  • actions/setup-node v3
npm
package.json
  • debug ^4.3.3
  • got ^11.8.2
  • @commitlint/config-conventional 16.2.4
  • @sinonjs/fake-timers 9.1.2
  • @types/debug 4.1.12
  • @types/got 9.6.12
  • @types/koa 2.14.0
  • @types/koa-bodyparser 4.3.12
  • @types/koa-route 3.2.8
  • @types/node 17.0.45
  • @types/sinonjs__fake-timers 8.1.5
  • @types/tape 4.13.4
  • @typescript-eslint/eslint-plugin 5.62.0
  • @typescript-eslint/parser 5.62.0
  • changelog-parser 2.8.1
  • commitlint 16.3.0
  • eslint 8.56.0
  • eslint-plugin-sort-imports-es6-autofix 0.6.0
  • husky 7.0.4
  • koa 2.15.0
  • koa-bodyparser 4.4.1
  • koa-route 3.2.0
  • patch-package 6.5.1
  • standard-version 9.5.0
  • tape 5.6.3
  • typedoc 0.25.7
  • typescript 4.8.4
  • why-is-node-running 2.2.2
  • node >=10.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.