msensorium v0.1.0

#sensorium Sensorium is an api library for makeblock mainboards. It includes mcore, orion, auriga and megapi.

You can use it in browser, node enviroment.

Install

npm install

Generate library

Generate sensorium.js width npm. The target file is /browser.

gulp browserify

Usage

browser

inclue the file /browser/sensorium.js in your project.

<script src="sensorium.js"></script>
<script>
    var mcore = new Mcore();

    // set motor move.
    mcore.setDcMotor(10, 255);

    // get ultrasonic sensor's value
    mcore.getSensorValue('ultrasonic', {"port": 3}, function(val) { console.log(val);});
</script>

cli test tool

Use blessed for comandline tool. Connect your device to computer with usb, such as mbot.

open the terminal and run cli tool

node cli.js

then input your method in the code area

mcore.setDcMotor(9, 200);

mcore.setLed(0, 255, 0, 0);
mcore.turnOffLed(0);

mcore.setTone("C4", 250);

setInterval(function(done) { mcore.getSensorValue('ultrasonic', {"port": 3}, function(val) { });done(); }, 500)

setInterval(function() { mcore.getSensorValue('linefollower', {"port": 2}, function(val) { }); }, 500)

dobule click key ESC to close the cli tool.

Unit Test

Use mocha for unit test.In the project root folder, type the command.

$ npm install mocha -g

# 会自动搜寻 `test/` 目录下的 js 文件进行测试
$ mocha

# 测试某个文件
$ mocha test/auriga_test.js

# 测试某个文件中的某个用例
$ mocha test/auriga_test.js -g "板载温度传感器"

Api documention (temp)

Use jsdoc for documention generation.

npm run doc

open docs/api/index.html in browser.

Api list

Mcore

Write:

mcore.setDcMotor(9, 200);

mcore.setLed(0, 255, 0, 0);
mcore.turnOffLed(0);

mcore.setTone("C4", 250);

Read:

mcore.getSensorValue('ultrasonic', {"port": 3}, function(val) {
  console.log(val);
});

- ultrasonic
- lineFollower

package publish

首次发布需要注册npm的账号，并在bash中添加用户信息

npm adduser
Username: <your npm username>
Password: <your npm password>
Email: <your npm email>

Logged in as <your username> on https://registry.npmjs.org/.

之后发布只需修改 package.json 的 version，并执行 npm publish 即可。