Giter Club home page Giter Club logo

rocket-nuimo-node's Introduction

Rocket Nuimo

Release License Node Maintained

🚀 Rocket Nuimo, a Node.js client package for Senic's Numio Control BLE device.


Installation

To install rocket-nuimo for use within your project use yarn or npm

$ yarn add `rocket-nuimo`

macOS Mojave Installation

rocket-numio uses noble under the hood for communicating with to BLE devices. nobel running on Mojavé has issues currently and must be worked around.

Whether you are uses rocket-numio as a depedency, or running one of the example you will need to make overrides or adjustments when running on macOS.

Overridding Depedencies

In your project's package.json insert the following:

  "depedendencie": {
   "rocket-nuimo": "^0.4"
  },
  "resolutions": {
    "noble": "https://github.com/Timeular/noble-mac"
  }

Then run from the terminal

$ yarn install

Now when you run your respect yarn install or npm install it will the package suitable to running on macOS.


Getting Started

API documentation coming shortly. Check out examples for now.

Clone rocket-nuimo-node and run the examples to try things out. package.json contains many example scripts. Alternatively, for Visual Sudio Code users you have access to the pre-configured launch configurations to run the examples.

$ git clone https://github.com/pryomoax/rocket-nuimo-node.git
$ cd rocket-nuimo-node
$ yarn install

Run one of the following scripts

# Device discovery
$ yarn device-discovery

# Simple display of custom glyphs
$ yarn display

# Example of simple animation
$ yarn animation

# Selection events
$ yarn select-events

# Touch/Long Touch events
$ yarn touch-events

# Swipe (on device) and through the "fly" touchless gesture
$ yarn swipe-events

# Hover proximity events, through "fly" touchless gestures
$ yarn hover-events

# Dial rotate events
$ yarn rotate-events

Toubleshooting

There can be troubles connecting to a Nuimo when playing around with the device. To give you some leads in trouble shooting, try the following:

  • Click the center screen button to wake up Nuimo Control
  • Power cycle Nuimo Control
  • Reset bluetooth on your Mac
  • Check if there are any current issue with noble related to the OS/Node.js version you are using.

rocket-nuimo-node's People

Contributors

happycodelucky 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.