Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
186 lines (114 sloc) 5.82 KB

Arduino commands

This section summarizes the Arduino commands available to be used with the biicode client program. You can see these tools if you execute:

$ bii -h arduino

       SYNOPSIS:
               $ bii COMMAND [options]
       For help about a command:
               $ bii COMMAND --help
       To change verbosity, use options --quiet --verbose

---------Arduino commands--------
  arduino:monitor  Open serial monitor
  arduino:settings Configure project settings for arduino
  arduino:test     Build only the tests declared into your biicode.conf '[tests]' section.
  arduino:upload   Upload a firmware in Arduino

Note: You need to have arduino :ref:`correctly set up <arduino_installation>`.

bii configure -t arduino: configure your project

If you have configured your project as a C/C++ project and you want to develop in arduino language, this command helps you! Enter it and configure your project like an arduino project. It invokes arduino cross compiler and you are ready to start with your arduino.

$ bii configure -t arduino

invoking cmake  -G "MinGW Makefiles" -Wno-dev ../cmake
-- The C compiler identification is GNU 4.3.2
-- The CXX compiler identification is GNU 4.3.2
-- Arduino SDK version 1.0.5: [YOUR_SDK_PATH]
-- Check for working C compiler: [YOUR_PATH]/avr-gcc.exe
-- Check for working C compiler: [YOUR_PATH]/avr-gcc.exe -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: [YOUR_PATH]/avr-g++.exe
-- Check for working CXX compiler: [YOUR_PATH]/avr-g++.exe -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: [YOUR_BII_WORKSPACE/YOUR_PROJECT]/build
Execute cmake --help to check all generators available. Here's how to configure :ref:`Eclipse for Arduino<bii_arduino_ide>`.

bii build: build your project

This command uses the cross compiler of Arduino (C compiler -> avr-gcc and CXX compiler -> avr-g++) to build and compile the project via the toolchain you configure it with bii configure -t arduino.

$ bii build

...

invoking cmake   -G "MinGW Makefiles" -Wno-dev ../cmake
-- The C compiler identification is GNU 4.3.2
-- The CXX compiler identification is GNU 4.3.2
-- Arduino SDK version 1.0.5: [YOUR_SDK_PATH]
-- Check for working C compiler: [YOUR_PATH]/avr-gcc.exe
-- Check for working C compiler: [YOUR_PATH]/avr-gcc.exe -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: [YOUR_PATH]/avr-g++.exe
-- Check for working CXX compiler: [YOUR_PATH]/avr-g++.exe -- works

...

[100%] Built target your_user_name_block_firmware

bii arduino:upload: send your code into the Arduino

When you want to deploy your code into the arduino, this command sends your previously built firmware to the arduino.

This command also builds your code in case it was not previously built.

$ bii arduino:upload

...

[100%] Built target [USER]_my_block_main

...

Writing | ################################################## | 100% 0.00s

avrdude.exe: 0 bytes of eeprom written

avrdude.exe: safemode: Fuses OK

avrdude.exe done.  Thank you.

[100%] Built target [USER]_my_block_main-upload

If you are using an Arduino Yun, you can upload your firmware by ssh with the parameter --ssh. To use it, specify the IP of your Arduino.

bii arduino:upload --ssh 192.168.0.1

Or don't especify anyone and use the default IP (192.168.240.1).

bii arduino:upload --ssh

bii arduino:settings: configure your Arduino settings

This command updates your settings with the info about your board and the IDE, if you want to use one.

$ bii arduino:settings
Enter SDK path (/../biicode_env/arduino-1.0.6): [ENTER]
Enter board (/o list supported options): mega2560
Using arduino port: COM13
:ref:`Set your own settings manually<bii_arduino_settings>`. When using non official arduino boards, add the board support to your IDE (if using one), and type the board on bii arduino:settings.

bii arduino:monitor: start a serial monitor

This command opens a serial monitor to read the serial port of your Arduino board.

$ bii arduino:monitor

bii configure --toolchain=arduino: enable, disable or change the Arduino cross compilation

Use this command to enable Arduino Cross Compilation.

$ bii configure --toolchain=arduino

If you need the default arduino-toolchain.cmake, execute bii arduino:settings first.

$ bii arduino:settings
...
$ bii configure --toolchain=arduino

If you want to disable it, use this command.

$ bii configure --toolchain=None

To use a custom tool-chain you need to place it in the bii folder of your project with the name <my_toolchain_name>-toolchain.cmake.

To use it, just pass it as argument of bii configure -t my_toolchain_name.

$ bii configure --toolchain=my_toolchain_name

If you use a custom toolchain, remember that you need to use the bii build to compile your projects.