Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattfryer/board_identify
An Arduino library which allows identification of the board/controller
https://github.com/mattfryer/board_identify
arduino arduino-boards arduino-ide arduino-library
Last synced: about 10 hours ago
JSON representation
An Arduino library which allows identification of the board/controller
- Host: GitHub
- URL: https://github.com/mattfryer/board_identify
- Owner: MattFryer
- License: gpl-3.0
- Created: 2017-12-20T20:20:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-23T21:35:01.000Z (18 days ago)
- Last Synced: 2025-01-23T22:25:37.863Z (18 days ago)
- Topics: arduino, arduino-boards, arduino-ide, arduino-library
- Language: C++
- Size: 56.6 KB
- Stars: 28
- Watchers: 5
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.arduino.cc/en/Guide/Libraries#toc3)
[](https://github.com/MattFryer/Board_Identify/releases/latest)
[](https://github.com/MattFryer/Board_Identify/releases/latest)
[](https://github.com/MattFryer/Board_Identify/stargazers)
[](https://github.com/MattFryer/Board_Identify/issues)
[](https://www.codacy.com/app/MattFryer/Board_Identify)
[](https://github.com/MattFryer/Board_Identify/blob/master/LICENSE)
# Board Identify
An Arduino library which allows identification of the make, model and MCU of board/controller which the code was compiled for. Currently supports identification of over 100 different boards including all Arduino/Genuino, Teensy, ESP8266, ESP32, BBC micro:bit and Digispark boards.
Please note, some boards share the same identifiers and so can't be distinguished between. When this is the case, both boards will be returned.
## How to Install
For details on how to install libraries in the Arduino IDE, please see the [Arduino website](https://www.arduino.cc/en/Guide/Libraries).
## How to Use
A full example is provided with the library and can be found in the Arduino IDE under "File->Examples->Board_Identify".
Firstly, you must include the library in your sketch:
```cpp
#include
```
Board Identify uses the namespace "BoardIdentify" to prevent conflicts with other libraries. You can therefor access the board information as follows:
```cpp
Serial.print(F("Board Type: "));
Serial.println(BoardIdentify::type);
Serial.print(F("Board Make: "));
Serial.println(BoardIdentify::make);
Serial.print(F("Board Model: "));
Serial.println(BoardIdentify::model);
Serial.print(F("Board MCU: "));
Serial.println(BoardIdentify::mcu);
```
It is advised to use BoardIdentify::type for any logic as it will never be changed and so should maintain future compatibility.
Adding this line before the library is included will cause a warning in the compile output window containing the identified board:
```cpp
#define BOARD_IDENTIFY_WARNING
```
If warnings still don't display, ensure "File->Preferences->compiler warnings" is set to "Default".
Even doing this, some boards still won't display the warning in the compile window but the constants will still be created.
## Currently Supported Boards
Over 100 boards/controllers are currently supported including:
* All Arduino/Genuino AVR
* All Arduino SAM
* All Arduino SAMD
* All Adafruit AVR
* All Arduboy
* All Digispark
* ESP8266 boards including NodeMCU, SparkFun ESP8266 Thing, WeMos boards and Adafruit ESPino
* ESP32 based boards inlcuding Node32s, Adafruit ESP32 Feather and SparkFun ESP32 Thing
* nRF52832 / nRF51 based boards including BBC micro:bit and RedBearLab boards
* All Teensy
## Planned Improvements/Changes
For planned changes, improvements and known bugs please visit the [Github issues tracker](https://github.com/MattFryer/Board_Identify/issues).