jadonk · psiphi75 · May 1, 2014 · May 2, 2014 · May 2, 2014 · May 3, 2014
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1 @@
-.settings.xml
-.DS_Store
-bonescript.log
-*~
 node_modules
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,40 @@
+ChangeLog
+---------
+
+__Check https://github.com/theoctal/octalbonescript/releases for changelog.__
+
+### 0.4.9
+* This version and all pervious versions were bug fixes
+
+### 0.4.4
+* Bug fixes in analogWrite function. ```startAnalog(pin, callback)``` function added
+
+### 0.4.3
+* All the express, socket.io and cloud9 dependencies removed. The library now focuses only on providing better I/O functionality for BeagleBone rather than serving to cloud9 IDE
+* Removed usage of FFI and moved to 'shelljs' to compile universal device tree
+
+### 0.4.2
+* ```stopAnalog(pin, callback)``` function added to ust stop the analog output on given pin. Call ```analogWrite``` again on that pin to start analog output (see v0.4.4 for update)
+
+### 0.4.1
+* Better warning in pinMode
+
+### 0.4.0 (Major update. Introduces BC break)
+
+* Support for 3.2 kernel has been dropped
+* Individual pin based "hw_capemgr" is no longer supported. Universal cape manager handles all the tasks of pin muxing
+* Required nodejs version is now >= 0.10.24. Effecively, the octalbonescript won't install on Angstrom distribution
+* __BC Break__ ```pinMode``` function now takes only 3 arguments -> (pin, direction, callback). This function now asserts mode automatically and sets slew rate as fast. Additional direction variable ```INPUT_PULLDOWN``` is also added. 
+* __BC Break__ ```pinMode``` function is now fully async unlike original bonescript. Please use callback to know the status.
+* Support for WatchDog timer added. It can be accessed via ```startWatchdog()``` and ```stopWatchdog()``` functions
+
+### 0.3.1
+
+* Small bug fixes
+
+### 0.3.0
+
+* Universal and HDMI cape loaded as per compatibility
+* 2 new dts overlays bs_univ_template and bs_hdmi_template added
+* Changed name of bone.js to pinmap.js to better reflect its content
+* Pins P8_7, P8_8, P8_9 should now be used as P8_07, P8_08, P8_09
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2011 Jason Kridner <jdk@ti.com>
+Copyright (c) 2011 Jason Kridner <jdk@ti.com>, Aditya Patadia <aditya@patadia.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

diff --git a/README.md b/README.md
@@ -1,214 +1,67 @@
-Getting started
+OctalBoneScript
 ===============
-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.
+A more stable, continuously tested and better node.js library for scripting BeagleBone. This is alternative to [bonescript](https://github.com/jadonk/bonescript) library.
 
-To check the version and see BoneScript is in your path, try running:
-````sh
-node -pe "require('bonescript').getPlatform().bonescript"
-````
+__v1.0.0 introduces major BC breaks. Please refer to [releases](https://github.com/theoctal/octalbonescript/releases) to see the changes made in latest version.__
 
-Additional documentation is available at http://beagleboard.org/bonescript.
+Installation
+------------
+Recommended method to install OctalBoneScript is to add following line in your project ```package.json``` file.
 
-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.
+```sh
 
+npm install octalbonescript
 
-Installation
+```
+
+If you are running kernel 3.8 i.e. Debian 7.9 or below, you should use version 1.0.6 or earlier:
+
+```sh
+
+npm install octalbonescript@1.0.6
+
+```
+
+After adding this line, you should run ``` npm install ``` command from that project directory to install OBS. Another method is to directly ```cd``` to project directory and run ```npm install octalbonescript``` command.
+
+If you must install OBS globally, you must run following command as root.
+
+```sh
+
+npm install -g --unsafe-perm octalbonescript
+
+```
+
+Please note that OBS does not recommend Linux Angstrom. We strongly recommend that you upgrade your BeagleBone to Debian by following link given below:
+
+[http://beagleboard.org/getting-started#update](http://beagleboard.org/getting-started#update)
+
+Examples
+--------
+Latest code docs, examples and **migration guide** from original bonescript are available at following link:
+
+[https://github.com/theoctal/octalbonescript/wiki](https://github.com/theoctal/octalbonescript/wiki)
+
+Fork
+----
+This is a fork of [bonescript](https://github.com/jadonk/bonescript). Some APIs are changed in v1.0.0, and we have changed many things under the hood leading to a much better, more functional and faster version of the original library.
+
+This fork is created to make bonescript more feature rich, faster, fix bugs and make it work in
+simulator mode under Mac OSX and Linux.
+
+We encourage you to report issues rightaway if you face any. We will try our best to be of help.
+
+Contributors
 ------------
-BoneScript comes installed on your BeagleBone. To update
-to the latest revision or install it on another distribution, use 'npm':
-
-````sh
-TERM=none npm install -g bonescript
-````
-
-Angstrom prerequisites:
-````sh
-opkg update
-opkg install python-misc python-modules
-````
-
-Debian and Ubuntu prerequisites:
-* Credit to http://learn.adafruit.com/introduction-to-the-beaglebone-black-device-tree/compiling-an-overlay
-````sh
-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:
-````sh
-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:
-
-````javascript
-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
+This [fork](https://github.com/ruth0000/octalbonescript_capemgr4_1) of OBS was very helpful in making OBS compatible with 4.1 kernel.
+
+I also thank [psiphi75](https://github.com/psiphi75) who funded OBS transition to 4.1 kernel.
+
+Donate
 ------
-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
+I have kept OBS updated and working since May 2014 and I will continue to do so. This ongoing development takes lot of my personal time.
+
+If you use OBS in commercial projects, please consider donating some money as it supports ongoing development.
 
+Bitcoin address: **15v6b7AP7TVc8PASGxqddYPeNW1kA7ydFh**