Skip to content

Commit dd2b427

Browse files
committed
Update library.properties
1 parent ee36a75 commit dd2b427

File tree

4 files changed

+27
-775
lines changed

4 files changed

+27
-775
lines changed

.github/workflows/compile-examples.yml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,11 @@ jobs:
2626

2727
matrix:
2828
board:
29-
# Arduino
30-
- fqbn: arduino:avr:uno
31-
platforms: |
32-
- name: arduino:avr
33-
- fqbn: arduino:avr:nano
34-
platforms: |
35-
- name: arduino:avr
29+
# Arduino - Only Mega has enough RAM for this library
30+
# Uno, Nano, Leonardo removed due to insufficient RAM (2KB SRAM)
3631
- fqbn: arduino:avr:mega
3732
platforms: |
3833
- name: arduino:avr
39-
- fqbn: arduino:avr:leonardo
40-
platforms: |
41-
- name: arduino:avr
4234
- fqbn: arduino:megaavr:nona4809
4335
platforms: |
4436
- name: arduino:megaavr

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,24 @@ Load any example: **File → Examples → Protocentral MAX30001 → Example0X_..
111111

112112
---
113113

114+
## Platform Requirements
115+
116+
This library requires at least **8 KB of SRAM** and **16 KB of Flash memory**. It is **NOT compatible with low-memory boards** like Arduino Uno, Nano, or Leonardo (only 2 KB SRAM).
117+
118+
### Recommended Platforms:
119+
-**Arduino Mega** (8 KB SRAM, 256 KB Flash) - Minimum supported
120+
-**Arduino Uno R4 Minima** (32 KB SRAM, 262 KB Flash) - **Recommended for best performance**
121+
-**Arduino Uno R4 WiFi** (32 KB SRAM, 262 KB Flash)
122+
-**ESP32 / ESP32-S2 / ESP32-C3** (320+ KB SRAM)
123+
-**Arduino SAMD21 / SAMD51** (32+ KB SRAM)
124+
-**Arduino MKR boards** (32 KB SRAM)
125+
-**Arduino Nano 33 BLE** (256 KB SRAM)
126+
-**Arduino Portenta** (2+ MB SRAM)
127+
-**Raspberry Pi Pico / RP2040** (264 KB SRAM)
128+
-**STM32 boards** (varies, most modern boards supported)
129+
130+
---
131+
114132
## Hardware Setup
115133

116134
### Standard Arduino Wiring

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ paragraph=Complete redesign with high-level API, advanced features, and 30+ meth
77
category=Sensors
88
url=https://github.com/Protocentral/protocentral_max30001_arduino_library
99
architectures=*
10-
includes=protocentral_max30001.h
10+
includes=ProtoCentral_MAX30001.h
1111

0 commit comments

Comments
 (0)