Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/MatthijsKamstra/hx-node-bbc-microbit

Control a BBC micro:bit from Node.js using BLE and Haxe
https://github.com/MatthijsKamstra/hx-node-bbc-microbit

bbc-microbit haxe microbit nodejs

Last synced: 3 months ago
JSON representation

Control a BBC micro:bit from Node.js using BLE and Haxe

Lists

README 

        



- [Micro:bit](#hx-node-bbc-microbit)

- [Haxe](#haxe)

- [Installation](#installation-haxenpm)

- [Haxelib](#haxelib)

- [Visual Studio Code](#visual-studio-code)

- [Haxe niceties](#haxe-niceties)

- [Difference](#difference)

- [Examples](#examples)



# hx-node-bbc-microbit



Control a [BBC micro:bit](http://microbit.org/) from [Node.js](https://nodejs.org/) using [BLE](https://en.wikipedia.org/wiki/Bluetooth_low_energy) and [Haxe](http://haxe.org/)



These are the Haxe node.js externs from  and follows the [api](https://github.com/sandeepmistry/node-bbc-microbit/blob/master/API.md)



![](icon.jpg)



> The Micro Bit (also referred to as BBC Micro Bit, stylised as micro:bit) is an ARM-based embedded system designed by the BBC for use in computer education in the UK.

>

> The board is 4 cm × 5 cm and has an ARM Cortex-M0 processor, accelerometer and magnetometer sensors, Bluetooth and USB connectivity, a display consisting of 25 LEDs, two programmable buttons, and can be powered by either USB or an external battery pack.[2] The device inputs and outputs are through five ring connectors that are part of the 23-pin edge connector.

>

> [wikipedia](https://en.wikipedia.org/wiki/Micro_Bit)



![](img/microbit.png)



## Haxe?



Read more about [Haxe](README_HAXE.MD)



## Installation Haxe/NPM



#### 1. [follow instructions to install `bbc-microbit`](https://github.com/sandeepmistry/node-bbc-microbit#prerequisites)

> Make sure to follow the instructions for `noble` too.



#### 2. install dependencies with npm

```

npm install

```



#### 3. install haxelib



```

haxelib git bbc-microbit https://github.com/MatthijsKamstra/hx-node-bbc-microbit

```



## Haxelib



use this repo locally



```

haxelib dev bbc-microbit path/to/folder/src

```



or this git repo



```

haxelib git bbc-microbit https://github.com/MatthijsKamstra/hx-node-bbc-microbit

```



don't forget to add it to your build file



```

-lib bbc-microbit

```



## Visual Studio Code



I would suggest to us Visual Studio Code, it's a very nice editor and lets you set breakpoints in your `js` file



![](img/vscode.png)



But [other code-editors](http://matthijskamstra.github.io/haxejs/haxe/choosing-a-code-editor.html) may work as well!



## Haxe niceties



create a (LED)pattern from an array



```haxe

var X = [

	1, 0, 0, 0, 1,

	0, 1, 0, 1, 0,

	0, 0, 1, 0, 0,

	0, 1, 0, 1, 0,

	1, 0, 0, 0, 1,

];

var buffer = new Buffer(new Pattern().createLedMatrixBuffer(X));



// follow example "LedPatternHx"

// or use a default Pattern

var buffer = new Buffer(new Pattern().createLedMatrixBuffer(Pattern.HEART));



```



Use string to listen to or `EventName`



```haxe

import BBCMicrobit;



// strings will work

microbit.on('buttonAChange', function(value) {

	console.log('\ton -> button A change');

});



// prevent spelling mistakes with EventName

microbit.on(EventName.BUTTON_A_CHANGE, function(value) {

	console.log('\ton -> button A change');

});

```



Use the fixed values for AccelerometerPeriod `Period`



```haxe

import BBCMicrobit;



// numbers will work

microbit.writeAccelerometerPeriod(160, function(err) {

	console.log('\taccelerometer period set');

});



// prevent using wrong value use Period

microbit.writeAccelerometerPeriod(Period.NR_160, function(err) {

	console.log('\taccelerometer period set');

});

```



## Difference



- UART doesn't work: [check api](https://github.com/sandeepmistry/node-bbc-microbit/blob/master/API.md#uart)

- Light sensor doesn't work: it works with a trick [read more](https://lancaster-university.github.io/microbit-docs/extras/light-sensing/) but with this node.js code unable to access.

- The code is not written on the micro:bit, remove power (switch off) and the code is gone

- EventListeners examples doesn't work: the code is not uploaded to NPM yet (but if you want to use it read [this](#fix-eventlistener))



## Fix EventListener



After installing the dependencies via `npm install`.   

You need to update the `node_modules/bbc-microbit` folder with two files:



- [bbc-microbit.js](https://raw.githubusercontent.com/sandeepmistry/node-bbc-microbit/master/lib/bbc-microbit.js)

- [event-service.js](https://github.com/sandeepmistry/node-bbc-microbit/blob/master/lib/event-service.js)



And that will make that work.



I have created an issue "[microbit.subscribeEvents](https://github.com/sandeepmistry/node-bbc-microbit/issues/14)" but it's not fixed yet.



## Examples



most examples from  are "redone" in Haxe



- [AccelerometerListener.hx](/src/examples/AccelerometerListener.hx)

- [ButtonListener.hx](/src/examples/ButtonListener.hx)

- [Compass.hx](/src/examples/Compass.hx)

- [Discoverer.hx](/src/examples/Discoverer.hx)

- [EventListener.hx](/src/examples/EventListener.hx) // doesn't work out of the box (check [this](#fix-eventlistener))

- [LedPattern.hx](/src/examples/LedPattern.hx)

- [LedPatternHx.hx](/src/examples/LedPatternHx.hx)

- [LedPatternTest.hx](/src/examples/LedPatternTest.hx)

- [LedText.hx](/src/examples/LedText.hx)

- [MagnetometerBearingListener.hx](/src/examples/MagnetometerBearingListener.hx)

- [MagnetometerListener.hx](/src/examples/MagnetometerListener.hx)

- [PinBlink.hx](/src/examples/PinBlink.hx)

- [PinListener.hx](/src/examples/PinListener.hx)

- [TemperatureListener.hx](/src/examples/TemperatureListener.hx)



## Blink



![](img/pins.png)



## Source



- 

- 

- 

- 

-