nkellenicki/node-poweredup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated readme, removed circleci
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Nathan Kellenicki 2019-03-20 09:38:36 -07:00
parent 2f7f58ba02
commit ad870c1035
23 changed files with 28 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
.circleci/config.yml
View File

@ -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: /.*/

9
README.md
View File

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

2
docs/BoostMoveHub.html
View File

@ -5585,7 +5585,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/DuploTrainBase.html
View File

@ -4188,7 +4188,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/Hub.html
View File

@ -2467,7 +2467,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/LPF2Hub.html
View File

@ -4444,7 +4444,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/PUPHub.html
View File

@ -5157,7 +5157,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/PUPRemote.html
View File

@ -3409,7 +3409,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/PoweredUP.html
View File

@ -1018,7 +1018,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/WeDo2SmartHub.html
View File

@ -5158,7 +5158,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/boostmovehub.js.html
View File

@ -351,7 +351,7 @@ exports.BoostMoveHub = BoostMoveHub;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/classes.list.html
View File

@ -6681,7 +6681,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/consts.js.html
View File

@ -300,7 +300,7 @@ var BLECharacteristic;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/duplotrainbase.js.html
View File

@ -300,7 +300,7 @@ exports.DuploTrainBase = DuploTrainBase;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/global.html
View File

@ -3272,7 +3272,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/hub.js.html
View File

@ -449,7 +449,7 @@ exports.Hub = Hub;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

8
docs/index.html
View File

@ -100,8 +100,8 @@
<section class="readme-section">
<article><p><a href="https://circleci.com/gh/nathankellenicki/node-poweredup"><img src="https://circleci.com/gh/nathankellenicki/node-poweredup.svg?style=shield" alt="CircleCI"></a><br><a href="https://gitter.im/node-poweredup?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a><br><img src="https://img.shields.io/npm/v/node-poweredup.svg?style=flat" alt="NPM Version"></p>
<h1><strong>node-poweredup</strong> - A Node.js module to interface with LEGO Powered UP components.</h1><h3>Introduction</h3><p>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.</p>
<article><p><a href="https://drone.kellenicki.com/nkellenicki/node-poweredup"><img src="https://drone.kellenicki.com/api/badges/nkellenicki/node-poweredup/status.svg" alt="Drone"></a><br><a href="https://img.shields.io/npm/v/node-poweredup.svg?style=flat"><img src="https://www.npmjs.com/package/node-poweredup" alt="NPM Version"></a></p>
<h1><strong>node-poweredup</strong> - A Javascript module to interface with LEGO Powered UP components.</h1><h3>Introduction</h3><p>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.</p>
<p>Powered UP has a few improvements over Power Functions:</p>
<ol>
<li><p>The use of Bluetooth Low Energy makes it easy to control from a computer, and even write code for.</p>
@ -111,7 +111,7 @@
<li><p>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.</p>
</li>
</ol>
<h3>Installation</h3><p>Node.js v8.0 required.</p>
<h3>Node.js Installation</h3><p>Node.js v8.0 required.</p>
<pre class="prettyprint source lang-javascript"><code>npm install node-poweredup --save</code></pre><p>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 <a href="https://github.com/noble/noble#prerequisites">certain dependencies which may need installed first</a>.</p>
<p>Note: node-poweredup has been tested on macOS 10.13 and Debian/Raspbian on the Raspberry Pi 3 Model B.</p>
<h3>Compatibility</h3><p>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.</p>
@ -320,7 +320,7 @@ console.log(&quot;Scanning for Hubs...&quot;);</code></pre><p>More examples are
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/lpf2hub.js.html
View File

@ -503,7 +503,7 @@ exports.LPF2Hub = LPF2Hub;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/poweredup-node.js.html
View File

@ -268,7 +268,7 @@ exports.PoweredUP = PoweredUP;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/puphub.js.html
View File

@ -308,7 +308,7 @@ exports.PUPHub = PUPHub;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/pupremote.js.html
View File

@ -238,7 +238,7 @@ exports.PUPRemote = PUPRemote;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>

2
docs/quicksearch.html
View File

File diff suppressed because one or more lines are too long

2
docs/wedo2smarthub.js.html
View File

@ -540,7 +540,7 @@ exports.WeDo2SmartHub = WeDo2SmartHub;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Mon Mar 18th 2019
on Wed Mar 20th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>