Skip to content

Latest commit

 

History

History
214 lines (179 loc) · 6.86 KB

README.md

File metadata and controls

214 lines (179 loc) · 6.86 KB
Raw

Getting started

BoneScript is a node.js library for physical computing on embedded Linux, starting with support for BeagleBone.

Information on the language is available at http://nodejs.org.

To check the version and see BoneScript is in your path, try running:

node -pe "require('bonescript').getPlatform().bonescript"

Additional documentation is available at http://beagleboard.org/bonescript.

The concept is to use Arduino-like functions written in JavaScript to simplify learning how to do physical computing tasks under embedded Linux and to further provide support for rapidly creating GUIs for your embedded applications through the use of HTML5/JavaScript web pages.

Installation

BoneScript comes installed on your BeagleBone. To update to the latest revision or install it on another distribution, use 'npm':

TERM=none npm install -g bonescript

Angstrom prerequisites:

opkg update
opkg install python-misc python-modules

Debian and Ubuntu prerequisites:

sudo apt-get install -y build-essential g++ python-setuptools python2.7-dev
wget -c https://raw.github.com/RobertCNelson/tools/master/pkgs/dtc.sh
chmod +x dtc.sh
./dtc.sh

Some steps to consider:

cp bonescript/etc/default/node /etc/default/node
cp bonescript/etc/profile.d/node.sh /etc/profile.d/node.sh
cp bonescript/systemd/* /lib/systemd/system
systemctl enable bonescript.socket
systemctl enable bonescript-autorun.service

Launching applications persistently

To have your applications launch on startup, simply drop them into the /var/lib/cloud9/autorun folder. Moving them out of that folder will kill the processes. You are expected to only drop in already bug-free apps into this folder as there isn't a good way to perform debug on them.

Note on code state

There's still a lot of development going on, so be sure to check back on a frequent basis. Many of the fancier peripherals aren't yet supported except through performing file I/O.

Directory layout

  • autorun.js: Node.JS app to run apps dropped in the autorun folder
  • index.js: Main BoneScript source code
  • package.json: NPM.JS package descriptor
  • server.js: BoneScript web server to serve up remote procedure calls
  • dts: Devicetree templates
  • etc: Configuration files to be placed in target distro
  • src: Library source code
  • systemd: Configuration files for systemd to start services
  • test: To-be-automated test code

Template

For a Bonescript application, you must currently manually 'require' the bonescript library. Functions are then referenced through the object provided back from require.

I started out trying to provide Arduino-like setup/loop functions, but the idea really isn't a good match for JavaScript. Using JavaScript's native flow works best, but the familiar functions are enough to give you a boost in your physical computing productivity.

Here's an example:

var b = require('bonescript');

b.pinMode('P8_12', b.INPUT);
b.pinMode('P8_13', b.OUTPUT);

setInterval(copyInputToOutput, 100);

function copyInputToOutput() {
    b.digitalRead('P8_12', writeToOutput);
    function writeToOutput(x) {
        b.digitalWrite('P8_13', x.value);
    }
}

The 'P8_12' and 'P8_13' are pin names on the board and the above example would copy the input value at P8_12 to the output P8_13 every 100 ms.

API

When a callback is provided, the functions will behave asynchronously. Without a callback provided, the functions will synchronize and complete before returning.

System

  • getPlatform([callback]) -> platform
  • getEeproms([callback]) -> eeproms
  • echo(data, [callback]) -> data
  • readTextFile(filename, [callback]) -> data
  • writeTextFile(filename, data, [callback])
  • setDate(date, [callback])

Digital and Analog I/O

  • analogRead(pin, [callback]) -> value
  • analogWrite(pin, value, [freq], [callback])
  • attachInterrupt(pin, handler, mode, [callback])
  • detachInterrupt(pin, [callback])
  • digitalRead(pin, [calback]) -> value
  • digitalWrite(pin, value, [callback])
  • pinMode(pin, direction, [mux], [pullup], [slew], [callback])
  • getPinMode(pin, [callback]) -> pinMode
  • shiftOut(dataPin, clockPin, bitOrder, val, [callback])

Serial

Uses https://github.com/voodootikigod/node-serialport

  • serialOpen(port, options, [callback])
  • serialWrite(port, data, [callback])
  • serialParsers is serialport.parsers

I2C

Uses https://github.com/korevec/node-i2c

  • i2cOpen(port, address, options, [callback])
  • i2cScan(port, [callback])
  • i2cWriteByte(port, byte, [callback])
  • i2cWriteBytes(port, command, bytes, [callback])
  • i2cReadByte(port, [callback])
  • i2cReadBytes(port, command, length, [callback])
  • i2cStream(port, command, length, [callback])

Bits/Bytes, Math, Trigonometry and Random Numbers

  • lowByte(value)
  • highByte(value)
  • bitRead(value, bitnum)
  • bitWrite(value, bitnum, bitdata)
  • bitSet(value, bitnum)
  • bitClear(value, bitnum)
  • bit(bitnum)
  • min(x, y)
  • max(x, y)
  • abs(x)
  • constrain(x, a, b)
  • map(value, fromLow, fromHigh, toLow, toHigh)
  • pow(x, y)
  • sqrt(x)
  • sin(radians)
  • cos(radians)
  • tan(radians)
  • randomSeed(x)
  • random([min], max)

Note on performance

This code is totally unoptimized. The list of possible optimizations that run through my head is staggering. The good news is that I think it can all be done without impacting the API, primarily thanks to the introspection capabilities of JavaScript.

Eventually, this is planned to enable real-time usage, directly from JavaScript. The plan is to attact the ability to use this programming environment in real-time on several fronts:

  • Enabling multiple loops and analyzing them to determine if they can be off- loaded to a PRU. This will be the primary mechanism for providing real-time servicing of the IOs.
  • Providing higher-order services that utilize the standard peripherals for their intended use:
    • Serial drivers for I2C, SPI, UARTs, etc.
    • analogWrite for PWMs using hardware PWMs, timers, kernel GPIO drivers, etc.
  • Adding real-time patches to the kernel

The JavaScript language provides some features that I think are really cool for doing embedded programming and node.js does some things to help enable that. The primary one is that the I/O functions are all asynchronous. For embedded systems, this is especially useful for performing low-latency tasks that respond to events in the system. What makes JavaScript so much easier than other languages for doing this is that it keeps the full context around the handler, so you don't have to worry about it.

Plans

  • SPI support
  • PRU support
  • Handling array of pins in pinMode and getPinMode
  • Saving off created dtbo and writing configuration to cape EEPROM