forked from andrey/raspberry-pi-pico-docker-sdk
Compare commits
2 Commits
main
...
container-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2141978e8c | ||
|
|
41939b982a |
47
.github/workflows/sdk-ci.yml
vendored
47
.github/workflows/sdk-ci.yml
vendored
@@ -1,47 +0,0 @@
|
|||||||
name: Raspberry PI Pico Docker SDK CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
|
|
||||||
env:
|
|
||||||
TEST_TAG: pico_test_sdk
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
sdk_container:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Build SDK
|
|
||||||
uses: docker/build-push-action@v4
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
load: true
|
|
||||||
tags: ${{ env.TEST_TAG }}
|
|
||||||
- name: Test SDK
|
|
||||||
run: bash ./test_sdk.sh ${{ env.TEST_TAG }}
|
|
||||||
- name: Log into Docker Hub
|
|
||||||
uses: docker/login-action@v2
|
|
||||||
with:
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.DOCKER_HUB_TOKEN }}
|
|
||||||
- name: Extract SDK metadata
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v4
|
|
||||||
with:
|
|
||||||
images: lukstep/raspberry-pi-pico-sdk
|
|
||||||
- name: Push SDK image
|
|
||||||
if: github.event_name == 'release' && github.event.action == 'published'
|
|
||||||
uses: docker/build-push-action@v4
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
push: true
|
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
FROM alpine:3.17.0
|
FROM alpine:3.16.2
|
||||||
|
|
||||||
# Install toolchain
|
# Install toolchain
|
||||||
RUN apk update && \
|
RUN apk update && \
|
||||||
@@ -15,14 +15,14 @@ RUN apk update && \
|
|||||||
|
|
||||||
# Raspberry Pi Pico SDK
|
# Raspberry Pi Pico SDK
|
||||||
ARG SDK_PATH=/usr/share/pico_sdk
|
ARG SDK_PATH=/usr/share/pico_sdk
|
||||||
RUN git clone --depth 1 --branch 2.1.1 --single-branch https://github.com/raspberrypi/pico-sdk $SDK_PATH && \
|
RUN git clone https://github.com/raspberrypi/pico-sdk $SDK_PATH && \
|
||||||
cd $SDK_PATH && \
|
cd $SDK_PATH && \
|
||||||
git submodule update --init
|
git submodule update --init
|
||||||
|
|
||||||
ENV PICO_SDK_PATH=$SDK_PATH
|
ENV PICO_SDK_PATH=$SDK_PATH
|
||||||
|
|
||||||
# Picotool installation
|
# Picotool installation
|
||||||
RUN git clone --depth 1 --branch 2.1.1 --single-branch https://github.com/raspberrypi/picotool.git /home/picotool && \
|
RUN git clone -b master https://github.com/raspberrypi/picotool.git /home/picotool && \
|
||||||
cd /home/picotool && \
|
cd /home/picotool && \
|
||||||
mkdir build && \
|
mkdir build && \
|
||||||
cd build && \
|
cd build && \
|
||||||
|
|||||||
13
Jenkinsfile
vendored
13
Jenkinsfile
vendored
@@ -1,13 +0,0 @@
|
|||||||
node {
|
|
||||||
stage("Download SRC") {
|
|
||||||
checkout scm
|
|
||||||
}
|
|
||||||
|
|
||||||
stage("Docker build") {
|
|
||||||
docker.build("${env.DOCKER_PREFIX}/picosdk", ".")
|
|
||||||
}
|
|
||||||
|
|
||||||
stage("docker prune") {
|
|
||||||
sh 'docker system prune -f'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
21
LICENSE
21
LICENSE
@@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2022 lukstep
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
99
README.md
99
README.md
@@ -1,5 +1,3 @@
|
|||||||
[](https://github.com/lukstep/raspberry-pi-pico-docker-sdk/actions/workflows/sdk-ci.yml)
|
|
||||||
|
|
||||||
# Raspberry Pi Pico Docker SDK
|
# Raspberry Pi Pico Docker SDK
|
||||||
|
|
||||||
Lightweight Raspberry Pi Pico C++ SDK container.
|
Lightweight Raspberry Pi Pico C++ SDK container.
|
||||||
@@ -42,100 +40,3 @@ docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/d
|
|||||||
docker exec -it pico-sdk /bin/sh
|
docker exec -it pico-sdk /bin/sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Visual Studio Code as Rassberry Pi PICO projects IDE
|
|
||||||
|
|
||||||
You can use the SDK container with Visual Studio Code as Raspberry Pi Pico projects IDE.
|
|
||||||
|
|
||||||
### Attaching VSCode to SDK Docker container
|
|
||||||
|
|
||||||
Follow the instruction below to set up VSCode:
|
|
||||||
|
|
||||||
1. Install [Visual Studio Code](https://code.visualstudio.com) and next [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extensions.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
2. Open the terminal and go to the projects you want to open in VSCode.
|
|
||||||
|
|
||||||
3. Pull SDK image from Docker HUB and run SDK container via the following command. The container must be running while you attach to it via VSCode.
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev lukstep/raspberry-pi-pico-sdk:latest
|
|
||||||
|
|
||||||
docker exec -it pico-sdk /bin/sh
|
|
||||||
```
|
|
||||||
|
|
||||||
4. When the container is launched, go to VSCode, click the green button in the lower left corner of VSCode and select options: Attach to Running Container...
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
5. Select the SDK container.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
6. Then a new VSCode window will open. At the bottom window, you can see that it is attached to the SDK container.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
7. Now, there is needed to open project files. Your project is mounted to `/home/dev` in the container. Go to EXPLORE tab in VSCode and click Open Folder. In opened window write `/home/dev` and click the OK button.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
8. Now You can explore, develop and build your Raspberry Pi Pico project via Visual Studio Code!
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Pico SDK aware Intellisense
|
|
||||||
|
|
||||||
For an IntelliSense that will be aware of Raspberry Pi Pico SDK dependencies, we will use [Clangd](https://clangd.llvm.org). Clangd is a C/C++ language server provided by the LLVM project. To Setup Clang as Intellisense engine follow instruction below:
|
|
||||||
|
|
||||||
1. To begin with, you need to install the server itself (Clangd is not installed by default in the SDK container image), to do this in the terminal call the command:
|
|
||||||
|
|
||||||
```
|
|
||||||
apk add clang-extra-tools
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Next is needed to install the Visual Studio Code [Clangd extension](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd).
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
1. To set-up The Clangd extension, in the project root directory, create folder .vcode with file settings.json. To settings.json past configuration from the snippet below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"C_Cpp.intelliSenseEngine": "Disabled",
|
|
||||||
"clangd.path": "/usr/bin/clangd",
|
|
||||||
"clangd.checkUpdates": false,
|
|
||||||
"clangd.restartAfterCrash": true,
|
|
||||||
"clangd.detectExtensionConflicts": true,
|
|
||||||
"clangd.arguments": ["-log=verbose",
|
|
||||||
"-pretty",
|
|
||||||
"--background-index",
|
|
||||||
"--query-driver=/usr/bin/arm-none-eabi-gcc",
|
|
||||||
"--compile-commands-dir=/home/dev/build"]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
|
|
||||||
4. For clangd to work, it needs a `compile_commands.json` file. This file contains the compilation and dependency information of each file in the project. To create it you need to add to the CMake command, `-DCMAKE_EXPORT_COMPILE_COMMANDS=1`. So You need to build your project with the command:
|
|
||||||
|
|
||||||
```
|
|
||||||
mkdir build
|
|
||||||
|
|
||||||
cd build
|
|
||||||
|
|
||||||
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=1 ..
|
|
||||||
|
|
||||||
make
|
|
||||||
```
|
|
||||||
|
|
||||||
5. Now IntelliSense should work!. Now you should see a prompt when you start typing. If you hover your cursor over a function from the SDK you should see its documentation, You can go to the function definition by pressing F12.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,6 @@ include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake)
|
|||||||
|
|
||||||
project(sample C CXX ASM)
|
project(sample C CXX ASM)
|
||||||
|
|
||||||
set(CMAKE_C_COMPILER /usr/bin/arm-none-eabi-gcc CACHE PATH "" FORCE)
|
|
||||||
set(CMAKE_CXX_COMPILER /usr/bin/arm-none-eabi-g++ CACHE PATH "" FORCE)
|
|
||||||
|
|
||||||
set(CMAKE_C_STANDARD 11)
|
set(CMAKE_C_STANDARD 11)
|
||||||
set(CMAKE_CXX_STANDARD 17)
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,4 @@
|
|||||||
if [[ -z $1 ]]; then
|
docker build . --tag pico-sdk
|
||||||
echo "Please provide an SDK image you want to test"
|
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD}/test_poject,target=/home/dev pico-sdk
|
||||||
fi
|
|
||||||
|
|
||||||
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD}/test_poject,target=/home/dev $1
|
|
||||||
docker exec pico-sdk /bin/sh -c "cd /home/dev && mkdir build && cd build && cmake .. && make -j4"
|
docker exec pico-sdk /bin/sh -c "cd /home/dev && mkdir build && cd build && cmake .. && make -j4"
|
||||||
docker exec pico-sdk /bin/sh -c "picotool"
|
docker exec pico-sdk /bin/sh -c "picotool"
|
||||||
docker container kill pico-sdk
|
|
||||||
docker container rm pico-sdk
|
|
||||||
|
|||||||
Reference in New Issue
Block a user