Giter Club home page Giter Club logo

visense-tools's Introduction

ViSense API tools

Build Status Documentation

Introduction

This set of tools can be used to facilitate the integration configuration/data API of a ViSense system. It comprises of the following parts:

  • Authentication module,
  • WebSocket connection manager class,
  • Configuration API ajax call adapter,
  • Convenience class for retrieving basic system information.

License

This software is licensed under the MIT license.

Version information

This library runs a major version number identical to the version number of the API it is compatible with. I.e. visense-tools v1.x and v2.x are to be used for ViSense v1.x and v2.x devices, respectively.

Command-line utilities

A set of command-line tools in the bin/ directory makes use of ViSense tools easy.

visense-authentication

Use visense-authentication to acquire/free a session token.

  Usage: visense-authentication [options]

  Options:

    -h, --help                     output usage information
    -V, --version                  output the version number
    --ip <ip>                      IP-address
    --port <port>                  Port number (default: 80)
    --command <signIn|signOut>     Authentication command to be executed.
    --username <username>          Username (mandatory for command signIn)
    --password <password>          Password (mandatory for command signIn)
    --sessionToken <sessionToken>  Session token (mandatory for command signOut)

For example:

 $ visense-authentication --ip '192.168.0.100' --command 'signIn' --username 'admin' --password 'MyPassword'

 5e23e335-3689-47e8-9b58-f547bc8e84b0
 $ visense-authentication --ip '192.168.0.100' --command 'signOut' --clientToken '5e23e335-3689-47e8-9b58-f547bc8e84b0'

visense-systeminfo

Use visense-systeminfo to list some basic information of a ViSense system.

  Usage: visense-systeminfo [options]

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    --ip <ip>              IP-address
    --port <port>          Port number (default: 80)
    --username <username>  Username
    --password <password>  Password

For example:

 $ visense-systeminfo --ip '192.168.0.100' --username 'admin' --password 'MyPassword'

 ViSense system information:
 ---------------------------
 ID                : 192.168.0.100
 Product name      : ViSense CrowdDynamics
 Service tag       : D34DB33F
 Connection status : Video connection established.

ToDo

  • Add example code for each utility class.
  • Add unit tests for the check-utils.
  • Add support for RFC-1123 host names in socket addresses.
  • Improve error handling and propagation.
  • Parsing of JSON formatted errors.
  • Move static socket-addres-related tests from class tests to check-utils tests.
  • Add generic library functions for WebSocket message / data parsing.
  • Change all string-type errors to native 'Error' types.

visense-tools's People

Contributors

vinotion avatar christopher-vinotion avatar

Stargazers

 avatar

Watchers

James Cloos 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.