Options
All
  • Public
  • Public/Protected
  • All
Menu

@powered-up/api

Package Version

A reactive library for controlling LEGO® Powered Up devices.

This package is part of PoweredUpJS.

Disclaimer: LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this software.

Getting started

Install @powered-up/api as a dependency:

# Install using Yarn
yarn add @powered-up/api
# Install using npm
npm install @powered-up/api

Installation problems under Node 10 on macOS 10.13.4

noble is used to establish the BLE connection, it requires xpc-connection on macOS, which currently cannot be installed without errors. Until the problem is officially fixed, the following must be added to your package.json file:

"resolutions": {
  "xpc-connection": "sandeepmistry/node-xpc-connection#pull/26/head"
}

Copyright (c) 2018-present, Clemens Akens. Released under the terms of the MIT License.

Index

Type aliases

CurrentSensorMode

CurrentSensorMode: "Milliamps"

EncodedMotorEndState

EncodedMotorEndState: "Braking" | "Drifting" | "Holding"

EncodedMotorMode

EncodedMotorMode: "Position" | "Power" | "Speed"

VoltageSensorMode

VoltageSensorMode: "Millivolts"

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc