Skip to content

Commit 5941ad9

Browse files
author
cdr
committed
fixed compilaion issues, added actions, fixed mouse example
1 parent 5dadfc8 commit 5941ad9

File tree

6 files changed

+244
-8
lines changed

6 files changed

+244
-8
lines changed

‎.github/workflows/check-arduino.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Run Arduino Lint
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- name: Arduino Lint
22+
uses: arduino/arduino-lint-action@v1
23+
with:
24+
compliance: specification
25+
library-manager: submit
26+
# Always use this setting for official repositories. Remove for 3rd party projects.
27+
official: true
28+
project-type: library

‎.github/workflows/render-documentation.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Render Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- ".github/workflows/render-documentation.ya?ml"
9+
- "examples/**"
10+
- "src/**"
11+
pull_request:
12+
branches:
13+
- main
14+
paths:
15+
- ".github/workflows/render-documentation.ya?ml"
16+
- "examples/**"
17+
- "src/**"
18+
workflow_dispatch:
19+
20+
jobs:
21+
render-docs:
22+
permissions:
23+
contents: write
24+
uses: sebromero/render-docs-github-action/.github/workflows/render-docs.yml@main
25+
with:
26+
source-path: './src'
27+
target-path: './docs/api.md'
28+
fail-on-warnings: true

‎.github/workflows/spell-check.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Source: https://github.com/per1234/.github/blob/main/workflow-templates/spell-check.md
2+
name: Spell Check
3+
4+
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
5+
on:
6+
push:
7+
pull_request:
8+
schedule:
9+
# Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
10+
- cron: "0 8 * * TUE"
11+
workflow_dispatch:
12+
repository_dispatch:
13+
14+
jobs:
15+
spellcheck:
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: read
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
24+
- name: Spell check
25+
uses: codespell-project/actions-codespell@v2

‎.github/workflows/sync-labels.yml‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md
2+
name: Sync Labels
3+
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
5+
on:
6+
push:
7+
paths:
8+
- ".github/workflows/sync-labels.ya?ml"
9+
- ".github/label-configuration-files/*.ya?ml"
10+
pull_request:
11+
paths:
12+
- ".github/workflows/sync-labels.ya?ml"
13+
- ".github/label-configuration-files/*.ya?ml"
14+
schedule:
15+
# Run daily at 8 AM UTC to sync with changes to shared label configurations.
16+
- cron: "0 8 * * *"
17+
workflow_dispatch:
18+
repository_dispatch:
19+
20+
env:
21+
CONFIGURATIONS_FOLDER: .github/label-configuration-files
22+
CONFIGURATIONS_ARTIFACT: label-configuration-files
23+
24+
jobs:
25+
check:
26+
runs-on: ubuntu-latest
27+
permissions:
28+
contents: read
29+
30+
steps:
31+
- name: Checkout repository
32+
uses: actions/checkout@v4
33+
34+
- name: Download JSON schema for labels configuration file
35+
id: download-schema
36+
uses: carlosperate/download-file-action@v2
37+
with:
38+
file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json
39+
location: ${{ runner.temp }}/label-configuration-schema
40+
41+
- name: Install JSON schema validator
42+
run: |
43+
sudo npm install \
44+
--global \
45+
ajv-cli \
46+
ajv-formats
47+
48+
- name: Validate local labels configuration
49+
run: |
50+
# See: https://github.com/ajv-validator/ajv-cli#readme
51+
ajv validate \
52+
--all-errors \
53+
-c ajv-formats \
54+
-s "${{ steps.download-schema.outputs.file-path }}" \
55+
-d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}"
56+
57+
download:
58+
needs: check
59+
runs-on: ubuntu-latest
60+
permissions: {}
61+
62+
strategy:
63+
matrix:
64+
filename:
65+
# Filenames of the shared configurations to apply to the repository in addition to the local configuration.
66+
# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels
67+
- universal.yml
68+
69+
steps:
70+
- name: Download
71+
uses: carlosperate/download-file-action@v2
72+
with:
73+
file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }}
74+
75+
- name: Pass configuration files to next job via workflow artifact
76+
uses: actions/upload-artifact@v4
77+
with:
78+
path: |
79+
*.yaml
80+
*.yml
81+
if-no-files-found: error
82+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
83+
84+
sync:
85+
needs: download
86+
runs-on: ubuntu-latest
87+
permissions:
88+
contents: read
89+
issues: write
90+
91+
steps:
92+
- name: Set environment variables
93+
run: |
94+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
95+
echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV"
96+
97+
- name: Determine whether to dry run
98+
id: dry-run
99+
if: >
100+
github.event_name == 'pull_request' ||
101+
(
102+
(
103+
github.event_name == 'push' ||
104+
github.event_name == 'workflow_dispatch'
105+
) &&
106+
github.ref != format('refs/heads/{0}', github.event.repository.default_branch)
107+
)
108+
run: |
109+
# Use of this flag in the github-label-sync command will cause it to only check the validity of the
110+
# configuration.
111+
echo "flag=--dry-run" >> $GITHUB_OUTPUT
112+
113+
- name: Checkout repository
114+
uses: actions/checkout@v4
115+
116+
- name: Download configuration files artifact
117+
uses: actions/download-artifact@v4
118+
with:
119+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
120+
path: ${{ env.CONFIGURATIONS_FOLDER }}
121+
122+
- name: Remove unneeded artifact
123+
uses: geekyeggo/delete-artifact@v5
124+
with:
125+
name: ${{ env.CONFIGURATIONS_ARTIFACT }}
126+
127+
- name: Merge label configuration files
128+
run: |
129+
# Merge all configuration files
130+
shopt -s extglob
131+
cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}"
132+
133+
- name: Install github-label-sync
134+
run: sudo npm install --global github-label-sync
135+
136+
- name: Sync labels
137+
env:
138+
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
139+
run: |
140+
# See: https://github.com/Financial-Times/github-label-sync
141+
github-label-sync \
142+
--labels "${{ env.MERGED_CONFIGURATION_PATH }}" \
143+
${{ steps.dry-run.outputs.flag }} \
144+
${{ github.repository }}

‎examples/Mouse/Mouse.ino‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,18 @@
44
// Create a global mouse instance.
55
USBHIDMouse ms;
66

7+
HIDMouseEvent mouseEvent;
8+
bool eventReceived = false;
9+
710
// User-defined connection callback.
811
void onMouseConnected() {
912
Serial.println("Mouse connected (callback).");
1013
}
1114

1215
// User-defined mouse event callback.
1316
void onMouseEvent(const HIDMouseEvent &event) {
14-
Serial.print("Mouse event (callback) - Buttons: ");
15-
Serial.print(event.buttons);
16-
Serial.print(", x: ");
17-
Serial.print(event.x);
18-
Serial.print(", y: ");
19-
Serial.print(event.y);
20-
Serial.print(", wheel: ");
21-
Serial.println(event.wheel);
17+
eventReceived = true;
18+
mouseEvent = event;
2219
}
2320

2421
void setup() {
@@ -32,5 +29,17 @@ void setup() {
3229

3330
void loop() {
3431
ms.poll();
32+
33+
if(eventReceived){
34+
Serial.print("Mouse event (callback) - Buttons: ");
35+
Serial.print(mouseEvent.buttons);
36+
Serial.print(", x: ");
37+
Serial.print(mouseEvent.xMovement);
38+
Serial.print(", y: ");
39+
Serial.print(mouseEvent.yMovement);
40+
Serial.print(", wheel: ");
41+
Serial.println(mouseEvent.wheelMovement);
42+
eventReceived = false;
43+
}
3544
// Additional mouse processing if needed.
3645
}

‎src/HIDCallbacks.cpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
#include "Mouse.h"
77
#include <stdio.h>
88

9+
extern USBHIDKeyboard* keyboardInstance;
10+
extern USBHIDMouse* mouseInstance;
911
// Mapping from HID keycodes to ASCII.
1012
// This macro should be provided by your USB host/HID stack.
1113
static uint8_t const keycodeToAscii[128][2] = { HID_KEYCODE_TO_ASCII };

0 commit comments

Comments
 (0)