g4s
TypeScript icon, indicating that this package has built-in type declarations

0.4.0 • Public • Published

G4S Node.js API

Latest Version License

An EXPERIMENTAL node.js package for using the G4S API. It is still under development, so a lot of features may not be supported yet.

DISCLAIMER: This package is NOT affiliated with G4S SECURITY SERVICES A/S or it's affiliates. It is a open source package being developed for fun.

Installation

First - this package is not 100% stable. Please DO NOT use it if you cannot afford to face breaking changes in the future.

# if you prefer npm
npm install --save g4s

# if you prefer yarn
yarn add g4s

Usage

First, instantiate the G4S class as follows:

const G4S = require('g4s');

const g4s = new G4S('email', 'password');

// Do whatever you want on the g4s instance, like arm the alarm:
g4s.armPanel()
  .then(() => {
    console.log('Alarm armed');
  })
  .catch(console.error.bind(console));

Motivation

The motivation behind this project was to engage with the G4S to create a homebridge plugin, so that I could manage my alarm straight in the Home app on my Apple Devices instead of using the G4S app.

Related Work

Package Sidebar

Install

npm i g4s

Weekly Downloads

0

Version

0.4.0

License

MIT

Unpacked Size

43.4 kB

Total Files

76

Last publish

Collaborators

  • hyber1z0r