| commit | a67b3f5814ab6ccf0dd08a14cb00dd8ae9ee532f | [log] [tgz] |
|---|---|---|
| author | Paul Sokolovsky <paul.sokolovsky@linaro.org> | Mon Feb 27 21:58:57 2017 +0300 |
| committer | Paul Sokolovsky <paul.sokolovsky@linaro.org> | Mon Feb 27 21:58:57 2017 +0300 |
| tree | e15c3efa85ade78cd497e76d16a51831ea017370 | |
| parent | 76c46637b3a7ecb92be2e1c57da1c43d598704ae [diff] |
[dgram] Clarify description of an address which should be used in bind(). Also, tested wildcard addresses to work for bind, so included in the docs too. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
The JavaScript* Runtime for the Zephyr™ OS project (ZJS for short) provides an IoT web runtime environment with JavaScript APIs for the Zephyr operating system, based on the JerryScript engine. It is intended for systems with little memory where Node.js with V8 is too big.
This code requires a local copy of JerryScript and Zephyr OS source. We will upstream patches to those projects as appropriate, but this repo is for everything else.
This section will walk you through building and running your first ZJS application on Arduino 101*.
Windows and OSX users: These instructions are for Ubuntu 16.04. Be sure to also consult Zephyr Project's Getting Started documentation for Windows or OSX.
First, install these packages that you will need beyond those installed by default with Ubuntu:
$ sudo apt-get update $ sudo apt-get install cmake dfu-util git screen sysvbanner uglifyjs
Note: sysvbanner is just used to identify tests as they run in the trlite test build script, so it could be left out.
Next, clone this git repo:
$ git clone http://github.com/01org/zephyr.js.git
If you want to use a stable release version, the latest is 0.2:
$ git checkout v0.2
If you do nothing and remain on master, you will be looking at the very latest changes which may have regressions or instability. You can read the version file in the root of the source tree to see what version you're on. If you're on the master development branch it will just say 'devel'.
Download the [latest Zephyr SDK] (https://www.zephyrproject.org/downloads/tools), then:
$ chmod +x /path/to/zephyr-sdk-<VERSION>-i686-setup.run $ sudo /path/to/zephyr-sdk-<VERSION>-i686-setup.run
Follow the prompts, but the defaults should be fine.
Add the following two lines to your ~/.bashrc. If you installed your Zephyr SDK elsewhere, adjust as needed.
export ZEPHYR_GCC_VARIANT=zephyr export ZEPHYR_SDK_INSTALL_DIR=/opt/zephyr-sdk
Then source the .bashrc :
$ source ~/.bashrc
Add your user to the plugdev group with this command:
$ sudo usermod -a -G plugdev USERNAME
Copy these two files into your /etc/udev/rules.d directory (/etc/udev.rules for Ubuntu 14.04):
Then run this command:
$ sudo udevadm control --reload-rules
This should cause your /dev/tty* entries to have the plugdev group, which will let you use them without root privileges. Otherwise, you will have to run some of the following commands with sudo.
Whenever you open a new terminal to work with this repo, you need to set up environment variables.
First, the ZJS variables:
$ cd zephyr.js $ source zjs-env.sh
Next, this command will check out additional git repos into the deps/ subdirectory, if you haven't done so before:
$ make update
(If this is the first time you've run this, will see an error.)
As the previous command will complain, you need to set up some Zephyr OS environment variables, too. Here's the right way to do that:
$ source deps/zephyr/zephyr-env.sh
Now you're ready to build the x86 and ARC images. The x86 image includes the JerryScript engine and the ZJS runtime support, along with your JavaScript application, and the ARC support image acts as a helper library that channels some of the data needed from the ARC processor to the x86 processor.
Note, you'll need to build both the x86 and ARC images with the same JS file so the required sub-modules are enabled on both images.
You can build both with a single command:
$ make JS=samples/TrafficLight.js
The JS= argument lets you provide the path to your application. The TrafficLight sample is a good first choice because you don't need to wire up any additional hardware. It just blinks onboard LEDs on your Arduino 101. Also, for many of the samples you will want to hook up the serial console (see below), but for this one it's not really needed.
Then connect the Arduino 101 to your host with a USB A/B cable. Press the Master Reset button on the Arduino 101 and after a few seconds type:
$ make dfu
This will flash both the images to the device using the dfu-util program.
If you get a permission error, make sure you followed the 'Join the plugdev group' instructions above for this user. You shouldn't need to run this command with sudo.
After this flashing completes successfully, reboot the device with the Master Reset button to start the application. After a few seconds the onboard LEDs should start cycling.
You have built and run your first ZJS application!
If you want to make changes to the application, or run a different .js sample, you just need to repeat the steps the desired JavaScript filename.
Without the serial console set up, you won't be able to see error messages and other output from your ZJS application. To hook up the serial console, you need a USB to TTL Serial Cable, such as the TTL-232R-3V3. On that particular cable, you wire the black wire to ground on the Arduino 101 board, the orange wire to GPIO pin 0 (RX), and the yellow wire to GPIO pin 1 (TX). The other three are unused.
When you plug this in, the device should show up as something such as /dev/ttyUSB0. You can then use the screen command to connect to the device with a command such as this:
$ watch screen /dev/ttyUSB0 115200
The watch utility will restart screen when you disconnect and reconnect your Arduino 101, so you shouldn't miss anything. You can leave a dedicated terminal running to watch the output.
In screen, you can scroll back the output with Ctrl-A, Esc, followed by PgUp/PgDn. Then Esc again to get back to the latest output (out of "Copy Mode").
You can use the commands make debug and make gdb in two separate terminals to connect to the device with a debugger. Then you can set breakpoints such as b main and run to start debugging as usual with gdb.
See below for a few more tips, such as increasing the space available for your application on the Arduino 101, or how to use ZJS with the FRDM-K64F.
If you want to contribute code to the ZJS project, first you need to fork the project. The next step is to send a pull request (PR) for review to the ZJS repository. The PR will be reviewed by the project team members. You need at least two plus-ones (+1) , "Look Good To Me (LGTM)" or other positive signals for the project members. Once you have gained the required signals the project maintainers will merge the PR.
zjs-env.sh - Source this file to set environment variables and path to be able to use tools from scripts/ anywhere.prj.conf - The main configuration file for a Zephyr application; overrides settings from a defconfig file in the Zephyr tree. In the ZJS builds, we assemble the prj.conf file at build time from other fragments.prj.mdef - Another configuration file for a Zephyr application; we use it to configure the heap size available to the ZJS API.arc/ - Contains sensor subsystem code for ARC side of the Arduino 101.deps/ - Contains dependency repos and scripts for working with them.docs/ - Documentation in Markdown format (use API.md as index).outdir/ - Directory generated by build, can be safely removed.samples/ - Sample JavaScript files that can be built with make JS=.scripts/ - Subdirectory containing tools useful during development.src/ - JS API bindings for JerryScript written directly on top of Zephyr.tests/ - JavaScript unit tests (incomplete).Arduino 101 comes with a 144K X86 partition, but we're able to use more space by telling Zephyr there is more space and then splicing the images we flash to the device. You can control this with the ROM= flag to make. So if you want to allocated 256KB for x86, use ROM=256.
You can also just build without it until you see a message like this:
lfiamcu/5.2.1/real-ld: region `ROM' overflowed by 53728 bytes
That implies you need an extra 53K of space, so you could try passing ROM=200. If it's the ARC image that needs more space, you should decrease the ROM you're passing instead.
NOTE: Earlier, we would physically repartition the device and install a new bootloader that knew about it. This is no longer necessary, so if you have such a device you should restore it to factory condition with the 256-to-144 flashpack.
You can also influence the amount of RAM allocated to the X86 side with a new RAM= argument. Here the default is 55 but it can theoretically go as high as 79 if ARC was disabled; realistically up to maybe 75 or so depending on how few modules you require in the ARC build.
The RAM and ROM sizes being used are now displayed at the top of the make output when you do build for Arduino 101.
The ZJS project uses a top-level Makefile to control the building of code from he project itself as well as the JerryScript and Zephyr projects it depends on.
To see the available make commands, type:
$ make help
On Arduino 101, there are two embedded microcontrollers, an X86 and an ARC one. If you only need the x86 side, you can disable ARC with CONFIG_ARC_INIT=n in the Zephyr prj.conf. Otherwise, you need a working image running on it.
$ make JS=samples/HelloWorld.js
This will build both an X86 and an ARC image, resulting in outdir/arduino_101/zephyr.bin and arc/outdir/arduino_101_sss/zephyr.bin as the final output. Then adjusted versions are created with a .dfu suffix. To flash them to your device with dfu-util, first press the Master Reset button on your Arduino 101, and about three seconds later type:
$ make dfu
There is a window of about five seconds where the DFU server is available, starting a second or two after the device resets.
Now both images on your device have been updated. Press the Master Reset button one more time to boot your new images.
The other samples may require some hardware to be set up and connected; read the top of each JS file, but then simply pass in the path to the JS file to make as with HelloWorld.js above.
To save space it is recommended to use a minifier. In convert.sh, the script used to encode your JS into a source file, we use uglifyjs. If you didn't install this earlier, you can do so with the command:
sudo apt-get install node-uglify
See the [Zephyr Project Wiki] (https://wiki.zephyrproject.org/view/NXP_FRDM-K64F) for general information about running Zephyr OS on the FRDM-K64F.
The instructions below assume Ubuntu 14.04 on the host PC.
Connect a micro-USB cable from the device to your PC.
If you hit the Reset switch and wait about five seconds, you should be able to start up a serial console. Either:
$ screen /dev/ttyACM0 115200
or
$ minicom -D /dev/ttyACM0
(I typically had to try either command several times before it would work.) The benefit of minicom is it will keep running even if you unplug the cable and then plug it back in later.
Check your dmesg output or watch your /dev directory to know what device it shows up as.
Then, follow [these instructions] (https://developer.mbed.org/handbook/Firmware-FRDM-K64F) to update your firmware.
Next, you can try to build ZJS for the platform:
$ make BOARD=frdm_k64f JS=samples/HelloWorld.js $ cp outdir/frdm_k64f/zephyr.bin /media/<USERNAME>/MBED/
After you copy the new .bin file to that directory, the device will reboot, blink an LED quickly as it writes the image, and then you should see the device reconnect as a USB storage device to your PC. Then you can press the Reset button to run the Zephyr image. You should see "Hello, ZJS world!" output on the serial console in less than a second.
If something doesn't work, you may want to establish that you're able to upload the K64F [hello world application] (https://developer.mbed.org/platforms/FRDM-K64F/#flash-a-project-binary).
Then, you could try the Zephyr OS hello_world sample to narrow down the problem:
$ cd deps/zephyr/samples/hello_world/nanokernel $ make pristine && make BOARD=frdm_k64f $ cp outdir/frdm_k64f/zephyr.bin /media/<USERNAME>/MBED/
Using the same procedure as above, once you hit Reset you should see "Hello World!" within a second on your serial console.
Zephyr is a trademark of the Linux Foundation. *Other names and brands may be claimed as the property of others.
In addition to Zephyr there is a "linux" target which does not use Zephyr at all and instead uses the host OS. This can be build on Linux or Mac OSX using the command:
make linux
The executable will be outputted to outdir/linux/<variant>/jslinux. Where <variant> is either debug or release. This is specified the same as the Zephyr target by passing in VARIANT= when running make. The default is release.
What makes the linux target convenient is that a JS script does not have to be bundled with the final executable. By default samples/HelloWorld.js will be bundled but you can always just pass in a script on the command line when running jslinux e.g.:
./outdir/linux/release/jslinux samples/Timers.js
If a script is passed in on the command line it will take the priority over any script bundled with the executable (using JS=).
By default jslinux will run forever (as Zephyr does) but if this is not desired, there are two flags which can be used to cause jslinux to exit under certain conditions. The first is the --autoexit flag. If this flag is used, jslinux will continually check to see if there are any pending events, like timers, callbacks or service functions. If there have no been any events processed on the last and most current loop cycle it will exit. The second flag (-t) will cause jslinux to exit after a specified timeout in milliseconds. This flag can be used like:
./jslinux -t <ms>
The --autoexit and -t <ms> flags can be used together, which will cause jslinux to exit on whichever condition is met first.
It should be noted that the Linux target has only very partial support to hardware compared to Zephyr. This target runs the core code, but most modules do not run on it, specifically the hardware modules (AIO, I2C, GPIO etc.). There are some modules which can be used though like Events, Promises, Performance and OCF. This list may grow if other modules are ported to the Linux target.
There is only partial support for modules on Linux compared to Zephyr. Any hardware specific module (I2C, UART, GPIO, ADC etc.) is not supported on Linux. Trying to run a Zephyr specific module on Linux will result in the JavaScript not running successfully. Below is a complete table of modules and target support.
| Module | Linux | Zephyr |
|---|---|---|
| ADC | - [ ] | - [x] |
| PWM | - [ ] | - [x] |
| GPIO | - [ ] | - [x] |
| I2C | - [ ] | - [x] |
| BLE | - [ ] | - [x] |
| UART | - [ ] | - [x] |
| Sensor | - [ ] | - [x] |
| Buffer | - [x] | - [x] |
| Console | - [x] | - [x] |
| Event | - [x] | - [x] |
| OCF | - [x] | - [x] |
| Performance | - [x] | - [x] |
| Timers | - [x] | - [x] |
There is a dedicated document for building and running OCF over BLE on the Arduino 101.