Merge pull request #13 from siliconwitchery/dev

SDK Release 1.0

.gitignore

@@ -2,4 +2,7 @@
 .DS_Store
 
 # VSCode files
-.vscode
+.vscode
+
+# Build folder
+.build

LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright 2021 Silicon Witchery AB
+Copyright 2022 Silicon Witchery AB
 
 Permission to use, copy, modify, and/or distribute this 
 software for any purpose with or without fee is hereby granted, 

s1.mk → Makefile

@@ -1,7 +1,7 @@
+#
 # Base SDK makefile.
-# ------------------
 #
-# Copyright 2021 Silicon Witchery AB
+# Copyright 2022 Silicon Witchery AB
 #
 # Permission to use, copy, modify, and/or distribute this software for any 
 # purpose with or without fee is hereby granted, provided that the above
@@ -15,7 +15,6 @@
 # OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 
 # PERFORMANCE OF THIS SOFTWARE.
 #
-# ------------------
 
 
 # You don't need to change anything here, but include this file in your own
@@ -26,7 +25,7 @@
 # As a minimum, you only need to set these variables from you Makefile.
 PROJECT_NAME ?= s1_sdk_standalone
 NRF_SDK_PATH ?= ${HOME}/nRF5_SDK
-S1_SDK_PATH ?= s1-sdk
+S1_SDK_PATH ?= .
 
 # Optionally, you can change the build directory.
 OUTPUT_DIRECTORY ?= .build
@@ -105,6 +104,12 @@ INC_FOLDERS += \
   $(NRF_SDK_PATH)/modules/nrfx/hal \
   $(NRF_SDK_PATH)/modules/nrfx/mdk \
 
+# If S1_TEST=1 is passed to the makefile, include the test main.c and config
+ifeq ($(S1_TEST), 1)
+  SRC_FILES += $(S1_SDK_PATH)/s1_tests/s1_tests.c
+  INC_FOLDERS += $(S1_SDK_PATH)/s1_tests
+endif
+
 # Libraries can also be added.
 LIB_FILES += \
 

README.md

@@ -34,7 +34,7 @@ Most of these tools are available from standard package managers, but you can bu
 
 We've designed this SDK so you can add it as a sub-module into your own git projects. The files here are therefore very lightweight and designed to be easy to use.
 
-- `s1.mk` - This is the core makefile that ensures that the nRF code can be built. You should call it with your own `Makefile` where you specify your applications files and any other settings you may want.
+- `Makefile` - This is the core makefile that ensures that the nRF code can be built. You should call it with your own `Makefile` where you specify your applications files and any other settings you may want.
 
 - `s1.c` - These are the core functions that run on the nRF chip. Access them via `s1.h`
 
@@ -44,6 +44,8 @@ We've designed this SDK so you can add it as a sub-module into your own git proj
 
 - `s1.pcf` - The FPGA pin configuration resides here. The names of the pins correspond to the pins of the FPGA, where `Dx` are the exposed pins, and the remaining pins are internal to the module.
 
+- `s1_tests` - This folder includes a test application which the SDK is tested against on every release. Run this application on your module to check it's correctly functional. Note that it sets many different voltages on the Vio and Vaux lines, which may damage external circuitry. It's best run on a bare Popout board without any additional devices connected. To build the test application, run `make S1_TEST=1 NRF_SDK_PATH=...` directly from the SDK folder.
+
 That's it! Again in order to use these files, it's better to look at an example project, and copy that layout for your own application.
 
 ## Precautions