This repository contains source code and self contained build system for the given device.
I wanted to try out the OLED screen I got from china's manufacturer. The target hardware device used for it is NUCLEO-F756ZG board with the corresponding MCU.
-
./doc - contains all the documentation regarding the test board, screen and some videos.
-
./prog - contains the main.cpp of the project.
-
./ext - contains source code from web, like STM32CubeF7 code package.
-
./modules - contains code and drivers for the target MCU.
-
./out - by default is a folder where everything gets built.
One can also use a docker image that is preconfigured and ready to go.
To build the docker image from Dockerfile: (assuming we are inside the project's folder)
docker image build -t koto_doc .
To run the docker container:
docker run -it -v ${PWD}:/home/koto/Oled -v /home/${USER}/.ssh:/home/koto/.ssh -e UPATH=${PWD} --privileged koto_doc
[NOTE] ${PWD} forwards current folder path, can be replaced with other project path.
To compile and flash from within the docker container:
cd /home/koto/Oled/out/ && rm -rf * && cmake .. && make -j run
[NOTE] For the Flash Programmer to work, plug the board in before running the docker image.
To just compile the code, use:
cd ./Oled/out && cmake .. && make -j
To generate the code documentation with call-graphs, use: make doc
cd ./Oled/out && cmake .. && make -j doc
[NOTE] The software for the Flash Programmer from the target board is installed while building Docker image.