Skip to content

Development environment

Rob Oudendijk edited this page Aug 2, 2019 · 21 revisions

BgeigieCast development

Instructions how to set up your development environment to develop and compile the firmware to your bGeigieCast!

The repository has been set up so it works with the Arduino IDE, as well as the PlatformIO IDE.

Clone or download the repository

Clone the git repository, use the development branch for further development.

PlatformIO

PlatformIO is an open-source ecosystem for IoT development. Cross- platform IDE and unified debugger. Remote unit testing and firmware updates

Install

There are two ways to install PlatformIO: together with an IDE or through the command line.

PlatformIO IDE

For users that are less familiar with the command line or work on a Windows device, PlatformIO build their IDE on top of GitHub's Atom and Microsoft's Visual Studio Code – both free, open-source, and MIT licensed editors.

Download from the PlatformIO IDE Download Page

note: the PlatformIO IDEs also installs platformio command-line tools

Command line

For those that prefer to work in the command line, you can install PlatformIO with python through the package manager pip.

Open your terminal and execute the following command:

pip install platformio

Commands

The PlatformIO IDE has all commands builtin as easy to use features, but even with the IDE you can use the commandline to execute any command

Arduino IDE

TODO

Upload firmware

To upload new firmware, you can either use Over-The-Air updates (see user manual) or use an XBee adapter board.

Using OTA

See user manual.

Using XBee adapter board

Uploading new firmware can also be done using an XBee adapter like the one in the image below. This will allow you to connect the bGeigieCast to your pc through USB and upload new firmware with Arduino or PlatformIO

XBee adapter

(Image: XBee USB adapter board)

With PlatformIO

Using the PlatformIO IDE you can run the "upload" command.

Using command-line interface:

pio run --target upload --environment bGeigieCast

With Arduino

Press the upload button in the Arduino IDE

#VSCodium/VSCode

Install VSCOdium

Install VSCode

Add PlatformIO extension

Use Icon to test/upload the firmware or run PIO commands

Clone this wiki locally