EmbeddedNim · daniel-j · Mar 6, 2023 · Mar 6, 2023 · Mar 6, 2023 · Mar 6, 2023
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,9 @@
-*
-!*.*
-!*/
-
-nimcache/
-nimblecache/
-htmldocs/
-
+/htmldocs/
+/piconim
+/build/
+/tests/test_mock
+/testproject*/
+/secret.nims
+/src/picostdlib/futharkgen
+/piconim
+/piconim.exe
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "src/picostdlib/vendor/pico-vfs"]
+	path = src/picostdlib/vendor/pico-vfs
+	url = https://github.com/daniel-j/pico-vfs.git
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,24 @@
-MIT License
+BSD-3-Clause License
 
 Copyright (c) 2021 Jason Beetham
+Copyright (c) 2022-2023 Daniel Jönsson
 
-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:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+   disclaimer.
 
-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.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+   disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -1,81 +1,129 @@
 # Raspberry Pi Pico SDK for Nim
 
-This library provides the library and build system necessary to write programs for RP2040 based devices (such as the Raspberry Pi Pico) in the [Nim](https://nim-lang.org/) programming language
+This library provides the library and build system necessary to write
+programs for RP2040-based devices (such as the Raspberry Pi Pico) in the
+[Nim](https://nim-lang.org/) programming language.
 
-The libary provides wrappers for the original [Raspberry Pi Pico
-SDK](https://github.com/raspberrypi/pico-sdk). The following features are
-currently implemented:
+The libary provides a complete wrapper for the [Raspberry Pi Pico
+SDK](https://github.com/raspberrypi/pico-sdk) v2.1.0. Here are some of the feature highlights:
 
-* Automatic project scaffolding using the `piconim` tool
-* Standard library features such as GPIO, time, ADC, PWM and many more
-* Rudimentary TinyUSB support: USB device, HID and CDC (serial port) classes
+* Project generator and building using the `piconim` tool
+* Setup, build and upload your project using Nimble, automatically runs CMake
+  (use piconim for advanced building)
+* Standard SDK library features such as GPIO, time, ADC, PWM and many more
+* Wrapper for Pico SDK functions but with Nim flavour, with strict types for safety
+* Wireless support for Pico W (Wifi, Bluetooth, HTTPS)
 
+Blink example (works on Pico W too!)
 
-## Table of Contents
+```nim
+import picostdlib
 
-[Setup](##Setup)
+DefaultLedPin.init()
+DefaultLedPin.setDir(Out)
 
-[Building](##Building)
-
-[Examples](examples)
+while true:
+  DefaultLedPin.put(High)
+  sleepMs(250)
+  DefaultLedPin.put(Low)
+  sleepMs(250)
+```
 
-[Contributing](##Contributing)
+See the [examples](examples) folder for more examples on how to use the SDK using Nim.
 
-[License](LICENSE)
 
 ## Setup
 
 **The following steps will install piconim and create a new project**
 
 1. First, you will need to have the Nim compiler installed. If you don't already
-have it, consider using [choosenim](https://github.com/dom96/choosenim)
+have it, consider using [choosenim](https://github.com/dom96/choosenim).
 
 2. Since this is just a wrapper for the original
 [pico-sdk](https://github.com/raspberrypi/pico-sdk), you will need to install the C
 library [dependencies](https://github.com/raspberrypi/pico-sdk#quick-start-your-own-project)
-(Step 1 in the quick start section)
+(Step 1 in the quick start section).
+
+3. Some parts of this library uses [Futhark](https://github.com/PMunch/futhark) to
+wrap some C libraries, which depends on libclang.
+See its installation guide [here](https://github.com/PMunch/futhark#installation).
 
-3. From the terminal, run `nimble install https://github.com/EmbeddedNim/picostdlib`.
+4. From the terminal, run `nimble install https://github.com/EmbeddedNim/picostdlib`.
 
-4. Run `piconim init <project-name>` to create a new project directory from a
+5. Run `piconim init <project-name>` to create a new project directory from a
 template. This will create a new folder, so make sure you are in the parent folder.
+When it asks for what project type, choose `>binary<` or `>hybrid<`. If you choose
+`>library<` there will be nothing to build.
 You can also provide the following options to the subcommand:
     - (--sdk, -s) -> specify the path to a locally installed `pico-sdk` repository,
-    ex.  `--sdk:/home/casey/pico-sdk`
+      ex.  `--sdk:/home/user/pico-sdk`.
+    - (--board, -b) -> specify the board type (`pico` or `pico_w` are accepted),
+      choosing pico_w includes a pico_w blink example
     - (--overwrite, -O) -> a flag to specify overwriting an exisiting directory
-    with the `<project-name>` already created. Be careful with this.
-    ex. `piconim myProject --overwrite` will replace a folder named `myProject`
+      with the `<project-name>` already created. Be careful with this.
+      ex. `piconim myProject --overwrite` will replace a folder named `myProject`
 
-## Building
+6. Change directory to the new project and run `nimble configure`. This will initialize
+the Pico SDK using CMake. If you provided a path to the SDK in the previous step, it will
+use that, otherwise it will download the SDK from GitHub, or if you have the Pico SDK installed
+already, it will use environment variable `PICO_SDK_PATH`.
 
-Now you can work on your project. When you are ready to build the `.uf2` file
-(which will be copied to the Raspberry Pi Pico), you can use the `build` subcommand:
+You are now ready to start developing and building your project.
 
-`piconim build <main-program>`
 
-Where `<main-program>` is the main module in your `src` folder. (ex. `piconim
-build myProject` if the main nim file is `myProject.nim`). You can also specify
-an output directory, otherwise it will be placed in `csource/build`
+## Building
 
-### `piconim setup`
+When you are ready to build the `.uf2` file (which will be copied to the Raspberry Pi Pico),
+you can use the `build` command of Nimble:
 
-If a piconim project is cloned fresh, or if `git clean` is ran, then the `csource/build`
-directory will need to be re-generated by CMake. This can be accomplished with the
-`piconim setup` command. The `setup` command takes an optional `--sdk` argument that works
-exactly like for the `init` command, described above.
+`nimble build`
 
-Examples:
+The generated `.uf2` file is placed in `build/<project>/<program>.uf2`
+
+Modify `CMakeLists.txt` to suit your project's needs.
+
+## Usage
 
 ```bash
-# Run these commands from the project root.
+# Initialize a new project
+piconim init [--sdk <sdk-path>] [--board <pico-board>] [--overwrite] <project-name>
+
+# Run the following commands from the project root.
+# If you don't specify a program name, it will use all
+# binaries specified in your Nimble file. You can specify multiple.
+
+# Run CMake configure, download Pico SDK from Github (if needed)
+nimble configure [program]
 
-# Re-run CMake, download Pico SDK from Github
-piconim setup
+# Builds C/C++ files with Nim, runs CMake build/make
+nimble build [program]
+
+# Run the CMake clean target, and cleans nimcache
+nimble fastclean [program]
+
+# Clean build directories, and cleans nimcache
+nimble distclean [program]
+
+# Runs clean and then builds.
+nimble buildclean [program]
+
+# Upload using picotool (installed separately)
+# Pass --build to run build task first. Add --clean to clean before building.
+nimble upload [program] [--build] [--clean]
+
+# Monitors the tty port using minicom (/dev/ttyACM0)
+nimble monitor
+
+# Runs CMake configure without Nimble.
+piconim configure [--project <project-name>] [--source <source-dir>] [--sdk <sdk-path>]
+  [--board <pico-board>]
+
+# Build a program without Nimble.
+piconim build [--project <project-name>] [--target <target>] [--compileOnly] [--upload] <program>
 
-# Re-run CMake, use existing SDK
-piconim setup --sdk:/home/casey/pico-sdk
 ```
 
+
 ## Contributing
 
 Please contribute.
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -0,0 +1,157 @@
+cmake_minimum_required(VERSION 3.13...3.27)
+
+# Set CMake build type. Debug, Release, MinSizeRel, RelWithDebInfo
+set(CMAKE_BUILD_TYPE Release)
+
+# Set standards
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
+
+# initialize pico-sdk from GIT
+# (note this can come from environment, CMake cache etc)
+#set(PICO_SDK_FETCH_FROM_GIT on)
+#set(PICO_SDK_PATH ENV{PICO_SDK_PATH}) # Set by piconim
+
+# Set board type here
+if(NOT DEFINED PICO_BOARD)
+  set(PICO_BOARD pico)
+endif()
+
+# Support C++ exceptions with Nim
+set(PICO_CXX_ENABLE_EXCEPTIONS 1)
+
+# Uncomment to disable picotool binary info
+# set(PICO_NO_BINARY_INFO 1)
+
+
+set(PICOSTDLIB_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../src")
+set(pico_generate_pio_header_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/generated")
+
+# note: this must happen before project()
+include(${PICOSTDLIB_DIR}/picostdlib/cmake/pico_sdk_import.cmake)
+
+project(examples C CXX ASM)
+
+
+include(FetchContent)
+
+FetchContent_Declare(mbedtls
+  GIT_REPOSITORY https://github.com/Mbed-TLS/mbedtls.git
+  GIT_TAG        v2.28.7
+)
+
+FetchContent_Declare(lwip
+  GIT_REPOSITORY https://git.savannah.gnu.org/git/lwip.git
+  GIT_TAG        STABLE-2_2_0_RELEASE
+)
+
+FetchContent_Declare(freertos_kernel
+  GIT_REPOSITORY https://github.com/FreeRTOS/FreeRTOS-Kernel.git
+  GIT_TAG        V11.0.1
+)
+
+# fetch and use alternative mbedtls version
+#FetchContent_MakeAvailable(mbedtls)
+#set(PICO_MBEDTLS_PATH ${mbedtls_SOURCE_DIR})
+
+# fetch and use alternative lwip version
+#FetchContent_MakeAvailable(lwip)
+#set(PICO_LWIP_PATH ${lwip_SOURCE_DIR})
+
+# fetch and initialize FreeRTOS-Kernel
+add_library(freertos_config INTERFACE)
+target_include_directories(freertos_config SYSTEM INTERFACE ${CMAKE_SOURCE_DIR}/../template/csource) # The config file directory
+set(FREERTOS_PORT GCC_RP2040 CACHE STRING "")
+# FetchContent_MakeAvailable(freertos_kernel)
+# include(${freertos_kernel_SOURCE_DIR}/portable/ThirdParty/GCC/RP2040/FreeRTOS_Kernel_import.cmake)
+
+
+# initialize the Raspberry Pi Pico SDK
+pico_sdk_init()
+
+include(${PICOSTDLIB_DIR}/picostdlib/cmake/picostdlib.cmake)
+
+function(add_example name)
+  set(target "${name}")
+
+  add_executable(${target})
+
+  picostdlib_target(${target} ${name})
+
+  # set_target_properties(${target} PROPERTIES LINKER_LANGUAGE CXX)
+
+  target_include_directories(${target} PRIVATE
+    ${CMAKE_SOURCE_DIR}
+    ${CMAKE_SOURCE_DIR}/../template/csource
+    # ${PICO_SDK_PATH}/lib/lwip/src/include/compat/posix
+  )
+
+  target_link_libraries(${target}
+    # Additional libraries
+  )
+
+  target_compile_definitions(${target} PRIVATE
+    # CYW43_HOST_NAME="PicoW"
+    PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS=2000
+  )
+
+  # enable usb output, disable uart output
+  pico_enable_stdio_usb(${target} 1)
+  pico_enable_stdio_uart(${target} 0)
+
+  # create map/bin/hex/uf2 file etc.
+  pico_add_extra_outputs(${target})
+
+  # add url via pico_set_program_url
+  # pico_set_program_url(${target} "")
+endfunction()
+
+
+if(PICO_CYW43_SUPPORTED)
+  # wireless examples
+  add_example(picow_blink)
+  add_example(picow_http_client)
+  add_example(picow_ntp_client)
+  add_example(picow_tcp_client)
+  add_example(picow_mqtt_client)
+  add_example(picow_tls_client)
+  add_example(picow_wifi_scan)
+else()
+  # does not support wl_gpio
+  add_example(hello_pio)
+  add_example(pwm_led_fade)
+endif()
+
+add_example(blink)
+add_example(hello_async)
+add_example(hello_adc)
+add_example(onboard_temperature)
+add_example(read_vsys)
+add_example(hello_resus)
+add_example(hello_stdio)
+add_example(hello_48mhz)
+add_example(hello_gpout)
+add_example(hello_dma)
+add_example(hello_filesystem_flash)
+add_example(hello_filesystem_sd)
+add_example(hello_littlefs)
+add_example(hello_7segment)
+add_example(hello_gpio_irq)
+add_example(hello_serial)
+add_example(hello_timestart)
+add_example(bus_scan)
+# add_example(joystickdisplay)
+# add_example(lightsensor)
+add_example(hello_multicore)
+add_example(hello_pwm)
+add_example(hello_reset)
+add_example(hello_rtc)
+add_example(rtc_alarm)
+add_example(unique_board_id)
+add_example(hello_sleep)
+add_example(hello_timer)
+# "tinyusb"
+add_example(hello_uart)
+add_example(hello_watchdog)
+# "ws2812_pio"
+# add_example(freertos_blink)