Files
jerryscript/targets/mbedos5
Akos Kiss 6c3a6e7be3 Rename jerry-port.h to jerryscript-port.h (#1762)
All public headers should follow the pattern `jerryscript[-*].h`.
The `jerry-api.h` to `jerryscript.h` renaming has already happened
a while ago, now it's time for the port API header to follow.

This patch
* renames the public header file,
* updates all includes to use the new file name (in `jerry-main`,
  in all the targets, and in the docs), and
* keeps `jerry-port.h` as a deprecated forwarding header to leave
  some time for external users to follow up with this change.

As a related change, the header of the default port implementation
is also changed to `jerryscript-port-default.h`.

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
2017-04-22 10:53:12 +09:00
..

JerryScript with mbed OS 5

TL;DR? jump straight to quickstart

Introduction

This directory contains the necessary code to build JerryScript for devices capable of running mbed OS 5. It has been tested with the following boards so far:

Features

Peripheral Drivers

Peripheral Drivers are intended as a 1-to-1 mapping to mbed C++ APIs, with a few differences (due to differences between JavaScript and C++ like lack of operator overloading).

Dependencies

mbed CLI

mbed CLI is used as the build tool for mbed OS 5. You can find out how to install it in the official documentation.

arm-none-eabi-gcc

arm-none-eabi-gcc is the only currently tested compiler for jerryscript on mbed, and instructions for building can be found as part of the mbed-cli installation instructions above.

make

make is used to automate the process of fetching dependencies, and making sure that mbed-cli is called with the correct arguments.

(optional) jshint

jshint is used to statically check your JavaScript code, as part of the build process. This ensures that pins you are using in your code are available on your chosen target platform.

Python modules

There are multiple Python module dependencies which can be installed with the following command invoked from your jerryscript/targets/mbedos5/tools directory:

pip install -r requirements.txt

If you have no pip installed but your are on an apt-managed system (e.g., Ubuntu), issue the following command first:

apt-get -y install python-pip

(Otherwise, visit pip documentation for more information on how to install pip.)

Quick Start

Once you have all of your dependencies installed, you can build the project as follows:

git clone https://github.com/jerryscript-project/jerryscript
cd jerryscript/targets/mbedos5
make getlibs
# NRF52 Development Kit:
make BOARD=NRF52_DK
# FRDM K64F
make BOARD=K64F

The produced file (in .build/[BOARD]/GCC_ARM) can then be uploaded to your board, and will run when you press reset.

If you make a modification to main.js, you can simply rerun make, and it will remember your previous choice of board:

make