From ad870c10354d344911c5103c336b9ba3e591b241 Mon Sep 17 00:00:00 2001 From: Nathan Kellenicki Date: Wed, 20 Mar 2019 09:38:36 -0700 Subject: [PATCH] Updated readme, removed circleci --- .circleci/config.yml | 54 ------------------------------------- README.md | 9 +++---- docs/BoostMoveHub.html | 2 +- docs/DuploTrainBase.html | 2 +- docs/Hub.html | 2 +- docs/LPF2Hub.html | 2 +- docs/PUPHub.html | 2 +- docs/PUPRemote.html | 2 +- docs/PoweredUP.html | 2 +- docs/WeDo2SmartHub.html | 2 +- docs/boostmovehub.js.html | 2 +- docs/classes.list.html | 2 +- docs/consts.js.html | 2 +- docs/duplotrainbase.js.html | 2 +- docs/global.html | 2 +- docs/hub.js.html | 2 +- docs/index.html | 8 +++--- docs/lpf2hub.js.html | 2 +- docs/poweredup-node.js.html | 2 +- docs/puphub.js.html | 2 +- docs/pupremote.js.html | 2 +- docs/quicksearch.html | 2 +- docs/wedo2smarthub.js.html | 2 +- 23 files changed, 28 insertions(+), 83 deletions(-) delete mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 24f6e1c..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,54 +0,0 @@ -version: 2 - -defaults: &defaults - working_directory: ~/repo - docker: - - image: circleci/node:8.11.4 - -jobs: - build: - <<: *defaults - steps: - - checkout - - restore_cache: - keys: - - v1-dependencies-{{ checksum "package.json" }} - - v1-dependencies- - - run: sudo apt-get install -y bluetooth bluez libbluetooth-dev libudev-dev - - run: npm install - - save_cache: - paths: - - node_modules - key: v1-dependencies-{{ checksum "package.json" }} - - run: npm run all - - persist_to_workspace: - root: ~/repo - paths: . - deploy: - <<: *defaults - steps: - - attach_workspace: - at: ~/repo - - run: - name: Authenticate with registry - command: echo "//registry.npmjs.org/:_authToken=$npm_TOKEN" > ~/repo/.npmrc - - run: - name: Publish package - command: npm publish - -workflows: - version: 2 - build-deploy: - jobs: - - build: - filters: - tags: - only: /^v.*/ - - deploy: - requires: - - build - filters: - tags: - only: /^v.*/ - branches: - ignore: /.*/ diff --git a/README.md b/README.md index a495bdd..513a534 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -[![CircleCI](https://circleci.com/gh/nathankellenicki/node-poweredup.svg?style=shield)](https://circleci.com/gh/nathankellenicki/node-poweredup) -[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/node-poweredup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -![NPM Version](https://img.shields.io/npm/v/node-poweredup.svg?style=flat) +[![Drone](https://drone.kellenicki.com/api/badges/nkellenicki/node-poweredup/status.svg)](https://drone.kellenicki.com/nkellenicki/node-poweredup) +[![NPM Version](https://www.npmjs.com/package/node-poweredup)](https://img.shields.io/npm/v/node-poweredup.svg?style=flat) -# **node-poweredup** - A Node.js module to interface with LEGO Powered UP components. +# **node-poweredup** - A Javascript module to interface with LEGO Powered UP components. ### Introduction @@ -16,7 +15,7 @@ Powered UP has a few improvements over Power Functions: 3. As Powered UP hubs and remotes pair with each other, the system allows for a near unlimited number of independently controlled models in the same room. Power Functions was limited to 8 due to the use of infra-red for communication. -### Installation +### Node.js Installation Node.js v8.0 required. diff --git a/docs/BoostMoveHub.html b/docs/BoostMoveHub.html index acbbfab..e0d51b7 100644 --- a/docs/BoostMoveHub.html +++ b/docs/BoostMoveHub.html @@ -5585,7 +5585,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/DuploTrainBase.html b/docs/DuploTrainBase.html index 788b317..26fcd86 100644 --- a/docs/DuploTrainBase.html +++ b/docs/DuploTrainBase.html @@ -4188,7 +4188,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/Hub.html b/docs/Hub.html index 60e4cb5..039db6d 100644 --- a/docs/Hub.html +++ b/docs/Hub.html @@ -2467,7 +2467,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html index a3b7cdc..3811828 100644 --- a/docs/LPF2Hub.html +++ b/docs/LPF2Hub.html @@ -4444,7 +4444,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/PUPHub.html b/docs/PUPHub.html index 04fb070..7d001f5 100644 --- a/docs/PUPHub.html +++ b/docs/PUPHub.html @@ -5157,7 +5157,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/PUPRemote.html b/docs/PUPRemote.html index 1d828c2..5927fc6 100644 --- a/docs/PUPRemote.html +++ b/docs/PUPRemote.html @@ -3409,7 +3409,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html index 6e25b6f..6cef506 100644 --- a/docs/PoweredUP.html +++ b/docs/PoweredUP.html @@ -1018,7 +1018,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/WeDo2SmartHub.html b/docs/WeDo2SmartHub.html index 8b4b380..c8004fc 100644 --- a/docs/WeDo2SmartHub.html +++ b/docs/WeDo2SmartHub.html @@ -5158,7 +5158,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/boostmovehub.js.html b/docs/boostmovehub.js.html index 0cc78ff..7030762 100644 --- a/docs/boostmovehub.js.html +++ b/docs/boostmovehub.js.html @@ -351,7 +351,7 @@ exports.BoostMoveHub = BoostMoveHub; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/classes.list.html b/docs/classes.list.html index 3c350f1..e8b9d03 100644 --- a/docs/classes.list.html +++ b/docs/classes.list.html @@ -6681,7 +6681,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/consts.js.html b/docs/consts.js.html index 627e1f4..e4046b0 100644 --- a/docs/consts.js.html +++ b/docs/consts.js.html @@ -300,7 +300,7 @@ var BLECharacteristic; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/duplotrainbase.js.html b/docs/duplotrainbase.js.html index abc2847..9d5fafa 100644 --- a/docs/duplotrainbase.js.html +++ b/docs/duplotrainbase.js.html @@ -300,7 +300,7 @@ exports.DuploTrainBase = DuploTrainBase; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/global.html b/docs/global.html index 3aa556a..a4e9131 100644 --- a/docs/global.html +++ b/docs/global.html @@ -3272,7 +3272,7 @@ Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/hub.js.html b/docs/hub.js.html index a7035a0..85aed2b 100644 --- a/docs/hub.js.html +++ b/docs/hub.js.html @@ -449,7 +449,7 @@ exports.Hub = Hub; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/index.html b/docs/index.html index d8d7484..42b50ee 100644 --- a/docs/index.html +++ b/docs/index.html @@ -100,8 +100,8 @@
-

CircleCI
Gitter
NPM Version

-

node-poweredup - A Node.js module to interface with LEGO Powered UP components.

Introduction

LEGO Powered UP is the successor to Power Functions, the system for adding electronics to LEGO models. Powered UP is a collection of ranges - starting with LEGO WeDo 2.0 released in 2016, LEGO Boost released in 2017, and LEGO Powered UP released in 2018. It also includes the 2018 Duplo App-Controlled Train sets.

+

Drone
NPM Version

+

node-poweredup - A Javascript module to interface with LEGO Powered UP components.

Introduction

LEGO Powered UP is the successor to Power Functions, the system for adding electronics to LEGO models. Powered UP is a collection of ranges - starting with LEGO WeDo 2.0 released in 2016, LEGO Boost released in 2017, and LEGO Powered UP released in 2018. It also includes the 2018 Duplo App-Controlled Train sets.

Powered UP has a few improvements over Power Functions:

  1. The use of Bluetooth Low Energy makes it easy to control from a computer, and even write code for.

    @@ -111,7 +111,7 @@

  2. As Powered UP hubs and remotes pair with each other, the system allows for a near unlimited number of independently controlled models in the same room. Power Functions was limited to 8 due to the use of infra-red for communication.

-

Installation

Node.js v8.0 required.

+

Node.js Installation

Node.js v8.0 required.

npm install node-poweredup --save

node-poweredup uses the Noble BLE library by Sandeep Mistry. On macOS everything should function out of the box. On Linux and Windows there are certain dependencies which may need installed first.

Note: node-poweredup has been tested on macOS 10.13 and Debian/Raspbian on the Raspberry Pi 3 Model B.

Compatibility

While most Powered UP components and Hubs are compatible with each other, there are exceptions. For example, there is limited backwards compatibility between newer components and the WeDo 2.0 Smart Hub. However WeDo 2.0 components are fully forwards compatible with newer Hubs.

@@ -320,7 +320,7 @@ console.log("Scanning for Hubs...");

More examples are Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/lpf2hub.js.html b/docs/lpf2hub.js.html index a911a94..58adad7 100644 --- a/docs/lpf2hub.js.html +++ b/docs/lpf2hub.js.html @@ -503,7 +503,7 @@ exports.LPF2Hub = LPF2Hub; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/poweredup-node.js.html b/docs/poweredup-node.js.html index 9f092ff..587df7b 100644 --- a/docs/poweredup-node.js.html +++ b/docs/poweredup-node.js.html @@ -268,7 +268,7 @@ exports.PoweredUP = PoweredUP; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/puphub.js.html b/docs/puphub.js.html index d607e32..67bd699 100644 --- a/docs/puphub.js.html +++ b/docs/puphub.js.html @@ -308,7 +308,7 @@ exports.PUPHub = PUPHub; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/pupremote.js.html b/docs/pupremote.js.html index 54b6563..7176c7f 100644 --- a/docs/pupremote.js.html +++ b/docs/pupremote.js.html @@ -238,7 +238,7 @@ exports.PUPRemote = PUPRemote; Documentation generated by JSDoc 3.5.5 - on Mon Mar 18th 2019 + on Wed Mar 20th 2019 using the DocStrap template. diff --git a/docs/quicksearch.html b/docs/quicksearch.html index 90ab2e5..e935d27 100644 --- a/docs/quicksearch.html +++ b/docs/quicksearch.html @@ -7,7 +7,7 @@