From a34c4223fb6e28d11a0967f53df2231f10bb4aa0 Mon Sep 17 00:00:00 2001 From: Nathan Kellenicki Date: Mon, 10 Feb 2020 11:22:15 -0800 Subject: [PATCH] Added announement to readme --- README.md | 4 +++ docs/index.html | 61 +++++++++++++++++++++++++++++++++++++++-- docs/quicksearch.html | 2 +- src/hubs/basehub.ts | 4 +-- src/nobleabstraction.ts | 2 +- 5 files changed, 66 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3bc745b..95ccc52 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ # **node-poweredup** - A Javascript module to interface with LEGO Powered Up components. +### Announcements + +*Important*: v6.0.0 is a complete re-architecting of this library. Improvements include proper device and mode support through an external Device object, correct handling of firmware features, and promise-based functionality for interfacing with device attachments. Although many new features were added, existing code will almost surely break upon upgrade. + ### 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 Education WeDo 2.0 released in 2016, LEGO Boost released in 2017, LEGO Powered Up released in 2018, LEGO Technic CONTROL+ released in 2019, and LEGO Education SPIKE Prime released in 2020. It also includes the 2018 Duplo App-Controlled Train sets. diff --git a/docs/index.html b/docs/index.html index 118bca2..3ff8633 100644 --- a/docs/index.html +++ b/docs/index.html @@ -96,15 +96,17 @@

Drone
NPM Version

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

+

Announcements

+

Important: v6.0.0 is a complete re-architecting of this library. Improvements include proper device and mode support through an external Device object, correct handling of firmware features, and promise-based functionality for interfacing with device attachments. Although many new features were added, existing code will almost surely break upon upgrade.

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, LEGO Powered Up released in 2018, and LEGO Technic CONTROL+ released in 2019. It also includes the 2018 Duplo App-Controlled Train sets.

+

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 Education WeDo 2.0 released in 2016, LEGO Boost released in 2017, LEGO Powered Up released in 2018, LEGO Technic CONTROL+ released in 2019, and LEGO Education SPIKE Prime released in 2020. It also includes the 2018 Duplo App-Controlled Train sets.

This library allows communication and control of Powered Up devices and peripherals via Javascript, both from Node.js and from the browser using Web Bluetooth.

Node.js Installation

-

Node.js v8.0 required.

+

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.

+

Note: node-poweredup has been tested on macOS 10.15 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.

@@ -211,6 +213,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Yes 42099
42100
SPIKE Prime Medium Motor45678Motor/SensorPartialYesYesYes45678
SPIKE Prime Large Motor45678Motor/SensorPartialYesYesYes45678
SPIKE Prime Color Sensor45678Motor/SensorPartialYesYesYes45678
SPIKE Prime Distance Sensor45678Motor/SensorPartialYesYesYes45678
SPIKE Prime Force Sensor45678Motor/SensorPartialYesYesYes45678

In addition, the Hubs themselves have certain built-in features which this library exposes.

@@ -273,6 +325,9 @@
  • When used with the Boost Move Hub, the Control+ Motors do not currently accept commands.

  • +
  • +

    The SPIKE Prime Hub does not use Bluetooth Low Energy, so is not supported via this library. It is recommended you use MicroPython and Bluetooth Classic to develop for this Hub.

    +
  • Documentation

    Full documentation is available here.

    diff --git a/docs/quicksearch.html b/docs/quicksearch.html index 95d7143..c893589 100644 --- a/docs/quicksearch.html +++ b/docs/quicksearch.html @@ -7,7 +7,7 @@