Skip to content

Commit

Permalink
Release Version 3.1.7
Browse files Browse the repository at this point in the history
Version 3.1.7 – 2024/02/16

Feature:
- Update for Wi-Fi coding style
- Add RFID examples
- Update SimpleHttpExample.ino
- Update MQTT examples
- Update UDP Calculation examples
- Update WiFiAPMode examples
- Remove unnecessary "shield" check for Wi-Fi examples
- Update Power Save TicklessMode example
- Update arduboy zip
- Fix BLE stack overflow when compiling with standard printf enabled
- Add BLEV7RC_CAR.ino
- Add DCT api examples
    - Add include files in compile flag
    - Add sub module of Preferences Credits to https://github.com/vshymanskyy/Preferences/tree/main
- Add example for the RGB LED on the BW16
    - Credits to https://github.com/designer2k2

API Updates:
- Add SPI API to support drawBitmap()
- Update SPI API to support external library tft_eSPI
- Add "Upload Speed" option for menu of IDE
- Update Wi-Fi ap and station concurrent mode
- Update Debugging mode feature
- Update for final evaluation kit for NORA-W30
- Update "board.txt" and "platform.txt"
- Update i2c API
- Update PMS3003.cpp and PMS3003.h
- Update wiring_analog.c
- Add SPI slave mode selection
- Update WiFi server default socket connection to non-blocking mode
- Add in destructors for Wi-Fi Classes
- Update send_data() in ard_socket.c
- Add printf suppport for c++ standard lib by default
- Update Wlan lib
    - Fix under promisc rssi sometimes is 0
- Update platform.txt
    - fix compile issue when username has space
- Update the pin_check related API
    - enhance the logic of checking
    - speed up the process

Misc:
- Update tool V1.1.1.1(MacOS only), V1.1.2 Support the lower version of MacOS
- Update IFTTT documentation to add in Line Notify features
- Update AmebaEink.zip
- Update Ameba_TensorFlowLite.zip
- Update AmebaD Arduino IDE Tools menu
- Add Example_Tools folder
- Update greetings.yml
- Update README
- Update tool V1.1.3 Support puya flash
- Add the source code of the Midbar (RTL8720DN Version)
- Update for BW16 pinmap
- Update for 1-10 mp image tool release
- Add package_realtek_amebad_early_index.json
- Update boards.txt
- Update supported board marcos
- Add CODE_OF_CONDUCT.md, LICENSE, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md and Issue Template
- Add workflows for label related
- Add workflows spell_check.yml
    - Enable "Check word spell"
    - Actions run every 'push' and 'pull_request'
  • Loading branch information
M-ichae-l committed Feb 16, 2024
1 parent 07f83a8 commit 24ea02d
Show file tree
Hide file tree
Showing 255 changed files with 8,093 additions and 6,071 deletions.
154 changes: 154 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
name: Bug Report
description: Report any bugs or issues
labels: ["pending"]
body:
- type: markdown
attributes:
value: |
* Please check [Online Documentation](https://www.amebaiot.com/en/ameba-arduino-summary/)
* Please check [FAQ](https://forum.amebaiot.com/c/faq/48), [forum](https://forum.amebaiot.com/) and [GitHub Wiki](https://github.com/ambiot/ambd_arduino/wiki)
* Please check and search in [List of closed issues](https://github.com/ambiot/ambd_arduino/issues?q=is%3Aissue+is%3Aclosed)
* Please check and search in [List of existing issues](https://github.com/ambiot/ambd_arduino/issues?q=is%3Aopen+is%3Aissue)
* If still experiencing the issue, please provide as many details as possible below about your hardware, environment setup and software.
- type: input
id: br-boards
attributes:
label: Boards
description: What is the hardware/module using?
placeholder: eg. AMB01, AMB23, BW16 or AMB82-mini...
validations:
required: true
- type: textarea
id: br-ex-hw
attributes:
label: External Hardware
description: Any external hardware that Ameba board attached to?
placeholder: eg. third-party extension, plain module on breadboard, customized hardware... please attach a photo if necessary.
validations:
required: true
- type: textarea
id: br-addon-hw
attributes:
label: Hardware Configuration
description: Is anything else attached to the Hardware?
placeholder: eg. sensors, peripherals...
validations:
required: true
- type: dropdown
id: br-version
attributes:
label: Version
description: What version of ambpro2_arduino SDK? Please use the latest version if possible.
options:
- latest dev (checkout manually)
- latest master (checkout manually)
- v3.1.6
- v3.1.5
- v3.1.4
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.11
- v3.0.10
- v3.0.7
- v3.0.5
- other
validations:
required: true
- type: input
id: br-ide
attributes:
label: IDE Name
description: What is the IDE?
placeholder: eg. Arduino IDE 2.2.1
validations:
required: true
- type: input
id: br-os
attributes:
label: Operating System
description: On which OS does this issue occur?
placeholder: eg. macOS Monterey (version 12), Windows 11, ubuntu22...
validations:
required: true
- type: dropdown
id: br-auto-flash-mode
attributes:
label: Auto Flash Mode
description: Is auto flash mode enabled?
options:
- 'Disable'
- 'Enable'
validations:
required: true
- type: dropdown
id: br-erase-flash-mode
attributes:
label: Erase All Flash Memory (4MB)
description: Is erase flash enabled?
options:
- 'Disable'
- 'Erase only'
validations:
required: true
- type: dropdown
id: br-standard-lib
attributes:
label: Standard Lib
description: Is Standard Lib enabled?
options:
- 'Arduino_STD_PRINTF'
- 'Disable'
validations:
required: true
- type: dropdown
id: br-upload-speed
attributes:
label: Upload Speed
description: What is the Upload speed?
options:
- '1500000'
- '921600'
validations:
required: true
- type: textarea
id: br-description
attributes:
label: Description
description: Please describe the issue/bug here and expected behaviour
placeholder: eg. compile error/hard fault/connectiong issue/weird behaviour/missing parameter...
validations:
required: true
- type: textarea
id: br-sketch
attributes:
label: Sketch
description: Please provide sketch/code that can be used to reproduce the bug/issue
placeholder: eg. aruino example ino files...
render: cpp
validations:
required: true
- type: textarea
id: br-error
attributes:
label: Error/Debug Message
description: Please provide error/debug message.
placeholder: eg. error message from Arduino IDE...
render: plain
validations:
required: true
- type: textarea
id: br-remarks
attributes:
label: Reproduce remarks
description: Is there additional information that will help to reproduce?
placeholder: eg. disabled erase mode and there is no issues/tried under ubuntu18 did not work but macos and ubuntu22 works...
- type: checkboxes
id: br-confirmation
attributes:
label: I have checked online documentation, FAQ, GitHub Wiki and existing/closed issues.
description: Before opening a new issue, please check all resources above.
options:
- label: I confirm I have checked online documentation, FAQ, GitHub Wiki and existing/closed issues.
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature Request
description: Suggest an feature for this SDK
labels: ["pending", "enhancement"]
body:
- type: markdown
attributes:
value: |
* We welcome any feature requests! It is helpful if you can explain exactly why the feature would be useful.
* There are some outstanding feature requests in the [List of existing issues](https://github.com/ambiot/ambd_arduino/issues?q=is%3Aopen+is%3Aissue) and [List of closed issues](https://github.com/ambiot/ambd_arduino/issues?q=is%3Aissue+is%3Aclosed), feel free to add any comments.
* If you would like to contribute, please refer to the [Contributing guide](https://github.com/ambiot/ambd_arduino/blob/dev/CONTRIBUTING.md).
- type: input
id: fr-hw
attributes:
label: Hardware Environment
description: Please describe your suggested hardware setup/environment.
placeholder: eg. Support for AMB23, AMB82-mini with a power bank...
validations:
required: true
- type: input
id: fr-area
attributes:
label: Related technical area
description: Please briefly explain the technical area of Feature Request.
placeholder: eg. Boards, Peripherals, BT, Wifi, flash, add libraries, add sensors...
validations:
required: true
- type: textarea
id: fr-issue-related
attributes:
label: Is the feature request related to an un-fixed issue?
description: Please provide more information/link of the issue.
placeholder: eg. This feature request is realted to *#issue_number*...
validations:
required: true
- type: textarea
id: fr-ideal-solution
attributes:
label: Describe the ideal solution/reault/output.
description: Please provide a clear and concise description of what you want to happen.
placeholder: eg. With this request implemented, sensor xxx will be fully supported...
validations:
required: true
- type: textarea
id: fr-remarks
attributes:
label: Additional remarks
description: Please add any additional context, diagram or screenshots...
placeholder: eg. The feature should work with xxx sensor/The feature should work with or without wifi...
- type: checkboxes
id: fr-confirmation
attributes:
label: I have checked existing/closed list of issues and the Contributing Guide.
description: Before opening a new Feature request, please check all resources above.
options:
- label: I confirm I have checked existing/closed list of issues and the Contributing Guide.
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: AmebaIoT Forum
url: https://forum.amebaiot.com/
about: Official Forum for technical support
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
*By completing this PR sufficiently, please help us to review and improve the quality of this PR and Release Notes*

### Checklist
1. [ ] Please provide specific title that describe the change (*eg. Update Readme.md*)
2. [ ] Please provide related links (*eg. This Pull Request is a fix of #issue_number*)
3. [ ] Please **update the license/declaration** if applicable (*eg. Usage of other projects/apis/libs code*)
4. [ ] Please check [Contributing guide](https://github.com/ambiot/ambd_arduino/blob/dev/CONTRIBUTING.md)
5. [ ] Please **confirm option to "Allow edits and access to secrets by maintainers"** when opening a Pull Request

*This entire section above can be deleted if all items are checked.*

-----------
## Description of Change
Please describe your proposed Pull Request and it's impact. \
*eg.*
- Feature:
- API Updates:
- Misc:

## Tests and Environments
Please describe on what Hardware, SDK, IDE, OS that tested this Pull Request and how if necessary. \
*eg.*
- AMB21
- ambd_arduino V3.1.7
- Arduino IDE 2.3.0
- Windows 10

## Remark related links
Please provide links to related issue, PRs etc. \
*eg.*
- Closes #issue_number
16 changes: 16 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Greetings

on: [pull_request_target, issues]

jobs:
greeting:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: "Hello, hope this message finds you well. Congrats to your first Issue! We will review it as soon as possiable. Feel free to have a look at https://www.amebaiot.com/en/ameba-arduino-summary/ for more information"
pr-message: "Hello, hope this message finds you well. Congrats to your Pull Request! Thank you for the work. Your contributions have been outstanding"
18 changes: 18 additions & 0 deletions .github/workflows/label_issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Label issues
on:
issues:
types:
- reopened
- opened
jobs:
label_issues:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- run: gh issue edit "$NUMBER" --add-label "$LABELS"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
NUMBER: ${{ github.event.issue.number }}
LABELS: pending
27 changes: 27 additions & 0 deletions .github/workflows/spell_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This workflow runs spell_check test for Ameba Arduino SDK

name: Check word spell
on: [push, pull_request]
# workflow_dispatch:
jobs:
spell-check:
name: Run spell-check check
runs-on: ubuntu-latest
strategy:
matrix:
path:
- 'Arduino_package/hardware/cores'
- 'Arduino_package/hardware/libraries'
steps:
- name: Checkout repository # and submodules
uses: actions/checkout@v4
# with:
# submodules: recursive
- name: Run spell-check for multi-floders
# uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v2
with:
skip: Arduino_package/hardware/libraries/SoftwareSerial/src/Adafruit_GPS.cpp,Arduino_package/hardware/libraries/SoftwareSerial/src/Adafruit_GPS.h,Arduino_package/hardware/libraries/SoftwareSerial/src/SoftwareSerial.cpp,Arduino_package/hardware/libraries/SoftwareSerial/src/SoftwareSerial.h
ignore_words_list: ameba
# ignore_words_file: Ameba_misc/Spell_Check_Ignore/.codespellignore
path: ${{ matrix.path }}
34 changes: 34 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
#
# You can adjust the behavior by modifying this file.
# For more information, see:
# https://github.com/actions/stale
name: 'Close stale issues and PRs'

on:
schedule:
- cron: '0 12 * * *'

jobs:
close-issues:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write

steps:
- uses: actions/stale@v9
with:
days-before-issue-stale: 14
# days-before-issue-close: 7
days-before-issue-close: -1
days-before-pr-stale: 14
days-before-pr-close: -1
stale-issue-label: 'no-issue-activity'
exempt-issue-labels: 'no-issue-activity,wontfix'
stale-pr-label: 'no-pr-activity'
exempt-pr-labels: 'no-pr-activity,wontfix'
stale-issue-message: "This issue is stale because it has been open for 14 days with no activity."
# close-issue-message: "This issue was closed because it has been inactive for 7 days since being marked as stale."
stale-pr-message: 'This pull request is stale because there is no activity for 14 days'
repo-token: ${{ secrets.GITHUB_TOKEN }}
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "Arduino_package/hardware/libraries/Preferences"]
path = Arduino_package/hardware/libraries/Preferences
url = https://github.com/vshymanskyy/Preferences
Binary file added Ameba_misc/Ameba_Icon/ico-out.o
Binary file not shown.
42 changes: 42 additions & 0 deletions Ameba_misc/Example_Tools/UDP_Calculate/Readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
This is the guide of MacOS, Linux or Windows OS user to compile the tool of the 3 UDP calculate examples.

Pre-request
For Windows OS user,
Please download and install CYGWIN from http://www.cygwin.com/
While installing chose "g++" at the selection

Compile the tools
Open the terminal(cygwin terminal for Windows user), then apply the following commands.

### g++.exe SendDelay.cpp -lws2_32 -o SendDelay_win.exe
### strip SendDelay_win.exe
g++.exe SendDelay.cpp ../../Ameba_Icon/ico-out.o -o SendDelay_win.exe
g++ SendDelay.cpp -o SendDelay_linux
g++ SendDelay.cpp -o SendDelay_mac

### g++.exe ReceiveDelay.cpp -lws2_32 -o ReceiveDelay_win.exe
### strip ReceiveDelay_win.exe
g++.exe ReceiveDelay.cpp ../../Ameba_Icon/ico-out.o -o ReceiveDelay_win.exe
g++ ReceiveDelay.cpp -o ReceiveDelay_linux
g++ ReceiveDelay.cpp -o ReceiveDelay_mac

### g++.exe ReceiveTimeout.cpp -lws2_32 -o ReceiveTimeout_win.exe
### strip ReceiveTimeout_win.exe
g++.exe ReceiveTimeout.cpp ../../Ameba_Icon/ico-out.o -o ReceiveTimeout_win.exe
g++ ReceiveTimeout.cpp -o ReceiveTimeout_linux
g++ ReceiveTimeout.cpp -o ReceiveTimeout_mac

Use the tools
Open the terminal(cygwin terminal for Windows user), then apply the following commands.

./ReceiveTimeout_win.exe <client IP address>
./ReceiveDelay_win.exe <client IP address>
./SendDelay_win.exe

./ReceiveDelay_linux <client IP address>
./ReceiveTimeout_linux <client IP address>
./SendDelay_linux

./ReceiveDelay_mac <client IP address>
./ReceiveTimeout_mac <client IP address>
./SendDelay_mac
Loading

0 comments on commit 24ea02d

Please sign in to comment.