BigClown development on Windows
- How to download IDE
- How to compile SDK
- How to upload firmware over USB
- How to debug core module
- How to generate API documentation
- How to install virtual COM port driver
- How to install Mosquitto MQTT broker
- How to start the gateway
Our software stack and SDK can be easily run also on Windows with our IDE. With few simple steps you can develop and test firmware, MQTT messages and more on Windows. This tutorial was tested on Windows 7 Professional x64.
How to download IDE
This installer will take care of installing the following:
- Visual Studio Code IDE
- GIT command line utility to automatically get the latest SDK
- ARM-GCC compiler for Windows
- USB CDC and USB DFU device drivers
- dfu-util for flashing firmware over USB
How to compile SDK
Run the BigClown IDE. There will be opened simple code skeleton with.
Now you can compile the code by pressing
Ctrl + Shift + B.
The downloaded GitHub firmware has a simple code which toggles the LED when you press the
B button on Core Module. You can also see the default example code on GitHub.
Please see the tutorials and add you application logic in
Congratulation for your first compiled firmware.
How to upload firmware over USB
After compiling the firmware. Press
Ctrl + P in the Visual Studio code. The cursor will jump to the top command line. Now write
task and it will display you all the make targets the Makefile contains. We are interested in the
dfu task. So execute command
This Device Firmware Update utility (
dfu-util) will allow you to upload compiled binary firmware just with USB.
Please follow this help how to setup USB driver and use DFU Util on Windows.
If you use command line then set the device to DFU mode and flash it by typing
How to debug core module
To debug the running code on Core Module you can use Ozone debugger with J-Link debug probe. It is also possible to use GDB/OpenOCD with other debug probes but this is not documented yet.
Download the Ozone debugger here. Ozone folder also needs to be set in PATH environment variable or you can simply edit Makefile and set absolute path to the Ozone.exe file.
You start debugging by typing
make ozone in the command line or
Ctrl+P and typing
task ozone in the Visual Studio Code.
How to generate API documentation
Our SDK is using Doxygen to automaticaly generate API documentation from C header files. This tool is not necessary to install. The generated API documentation is also on http://sdk.bigclown.com. Download the latest Doxygen here.
You generate the docs by
How to install virtual COM port driver
This step is not necessary when you used the BigClown IDE installer. Download and install the STM32 Virtual COM Port driver. You can also download latest driver directly from ST but you will need to register.
How to install Mosquitto MQTT broker
Mosquitto is not necessary for firmware development, but if you would like to send messages over USB to your computer or network you need to install and run it.
Mosquitto MQTT Broker is a MQTT server which is a central message hub in our system. Please download, install and run this broker. This broker needs to be running in the background all the time you use our Python Gateway.
To run the MQTT broker go to install directory and type
-v is for verbose, so you can see the messages.
How to start the gateway
Download and install Python 3 which is needed to run the Gateway. Gateway is a small python program which connects virtual USB serial port of Core Module and MQTT broker.
Connected core module appears as a USB serial device in your computer. The python gateway script interconnects the core module with MQTT broker. This section explains how to set up these pieces.
Clone https://github.com/bigclownlabs/bch-gateway repository.
git clone https://github.com/bigclownlabs/bch-gateway.git
Then run the script with the correct COM port set.
python bc-gateway.py -d COM2
You have sucessfully installed SDK with gateway. Now you can explore and make new interesting projects.