diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6b73a28..13b8f2d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,26 +2,49 @@ name: CI on: push: - branches: [ '**' ] + branches: ["**"] pull_request: - branches: [ '**' ] + branches: ["**"] jobs: build-application-windows: runs-on: windows-2019 steps: - - uses: actions/checkout@v2 - - uses: microsoft/setup-msbuild@v1.0.2 - - uses: NuGet/setup-nuget@v1.0.5 - - name: Restore Packages - run: nuget restore Programs/Serial_003/Miriam_Serial/Miriam.sln - - name: build - run: msbuild Programs/Serial_003/Miriam_Serial/Miriam.sln /p:Configuration=Release /p:Platform="Any CPU" - - name: Upload artifact - uses: actions/upload-artifact@v2 - with: - name: miriam-application-windows - path: D:\a\Miriam\Miriam\Programs\Serial_003\Miriam_Serial\MiriamTests\bin\Release\Miriam_Serial.exe + - uses: actions/checkout@v2 + - name: Prepare copy of Arduino source to distribute with Windows EXE 0 + run: mkdir artifact + - name: Prepare copy of Arduino source to distribute with Windows EXE 1 + run: mkdir artifact\miriam-arduino-firmware-source + - name: Prepare copy of Arduino source to distribute with Windows EXE 2 + run: mkdir artifact\miriam-arduino-firmware-source\Serial_003 + - name: Prepare copy of Arduino source to distribute with Windows EXE 3 + run: copy .\Programs\Serial_003\Serial_003.ino .\artifact\miriam-arduino-firmware-source\Serial_003\ + - name: Prepare copy of Arduino source to distribute with Windows EXE 3.1 + run: copy .\Programs\Serial_003\MyStatusLed.h .\artifact\miriam-arduino-firmware-source\Serial_003\ + - name: Prepare copy of Arduino source to distribute with Windows EXE 3.2 + run: copy .\Programs\Serial_003\MyStatusLed.cpp .\artifact\miriam-arduino-firmware-source\Serial_003\ + - name: Prepare copy of Arduino source to distribute with Windows EXE 4 + run: copy .\Programs\README-arduino-firmware.md .\artifact\miriam-arduino-firmware-source\README.md + - name: Make Arduino library + uses: papeloto/action-zip@v1 + with: + files: Programs\PID_v1 + dest: artifact\miriam-arduino-firmware-source\PID_v1.zip + - uses: microsoft/setup-msbuild@v1.0.2 + - uses: NuGet/setup-nuget@v1.0.5 + - name: Restore Packages + run: nuget restore Programs/Serial_003/Miriam_Serial/Miriam.sln + - name: build + run: msbuild Programs/Serial_003/Miriam_Serial/Miriam.sln /p:Configuration=Release /p:Platform="Any CPU" + - name: copy Miriam executable + run: copy D:\a\Miriam\Miriam\Programs\Serial_003\Miriam_Serial\MiriamTests\bin\Release\Miriam_Serial.exe artifact\Miriam_Serial.exe + - name: Upload artifact + uses: actions/upload-artifact@v2 + with: + name: miriam + path: | + artifact/miriam-arduino-firmware-source + artifact/Miriam_Serial.exe build-firmware: # Based on https://legion2.github.io/2020/03/27/from-arduino-builder-to-arduino-cli.html diff --git a/.gitignore b/.gitignore index 0db5b7e..f8bd18f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ Programs/Serial_003/.cells.tsv Programs/Serial_003/Miriam_Serial/MiriamTests/bin Programs/Serial_003/Miriam_Serial/MiriamTests/obj Programs/Serial_003/Miriam_Serial/TestResults +miriam-arduino-firmware-source diff --git a/Programs/README-arduino-firmware.md b/Programs/README-arduino-firmware.md new file mode 100644 index 0000000..05b2263 --- /dev/null +++ b/Programs/README-arduino-firmware.md @@ -0,0 +1,21 @@ +# Arduino firmware for Miriam + +This requires the [Arduino software](https://www.arduino.cc/en/Guide/Windows). + +* `Serial_003` - this contains the source code ("sketch") for the Arduino + firmware in the file `Serial_003.ino`. +* `PID_v1.zip` - this is a library for Arduino. + +## Installing + +1. The `PID_v1` library should be installed in the Arduino IDE [according to these +instructions](https://www.arduino.cc/en/guide/libraries). + +2. In the Arduino IDE, go to "Tools > Board" then select `Arduino Mega or Mega + 2560`. + +3. In the Arduino IDE, select the port to the Arduino device. Go to "Tools > + Port" then select the correct port, which depends on your computer. + +4. Then the sketch can then be uploaded using the IDE. [Here is a tutorial about + getting started with Arduino](https://www.arduino.cc/en/main/howto). diff --git a/Programs/README.md b/Programs/README.md index 398406c..5e7a7f8 100644 --- a/Programs/README.md +++ b/Programs/README.md @@ -16,10 +16,3 @@ You should have received a copy of the GNU General Public License along with thi Firmware is written with [Arduino IDE](https://www.arduino.cc/en/main/software) and the software with Visual Studio 2015 open community using C#. * Serial_003 is meant for communication between computer and Miriam via USB cable and string messages - -The following programs were removed (see original https://github.com/miroculus/Miriam/tree/master/Programs): - -* Wifi_003 is for interaction between controller and Miriam over the same wifi network -* Wifi_004 webservice controls Miriam - -