Code Monkey home page Code Monkey logo

mygekko-client-library's Introduction

NPM npm npm GitHub issues GitHub Workflow Status (with event) GitHub Workflow Status (with event) GitHub Workflow Status (with event)

Documentation

For more detailed documentation see docs

Installation

yarn add mygekko-client-library

Using the client library

This is a very simple example. This creates a remote client and retrieves the details of all blinds:

import { RemoteClient } from 'mygekko-client-library';

const client = new RemoteClient({
  username: '[email protected]',
  gekkoId: 'XXXX-XXXX-XXXX-XXXX',
  apiKey: 'damnSecure',
});

try {
  const blinds = client.blinds.getAll();
  console.log(blinds);
  await client.blinds.setPosition('item0', 75);
  const blindsTrends = client.blinds.getTrends(
    '2023-01-01T00:00:00+01:00',
    '2023-01-06T00:00:00+01:00',
    500
  );
  console.log(blindsTrends);
} catch (e) {
  console.log(e);
}

And this creates a local client and retrieves the details of all blinds:

import { LocalClient } from 'mygekko-client-library';

const client = new LocalClient({
  ip: '127.0.1',
  username: 'user',
  password: 'damnSecure',
});

try {
  const blinds = client.blinds.getAll();
  console.log(blinds);
  await client.blinds.setPosition('item0', 75);
  const blindsTrends = client.blinds.getTrends(
    '2023-01-01T00:00:00+01:00',
    '2023-01-06T00:00:00+01:00',
    500
  );
  console.log(blindsTrends);
} catch (e) {
  console.log(e);
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests.

mygekko-client-library's People

Contributors

pinpong avatar

Stargazers

 avatar  avatar

Watchers

 avatar

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.