You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
James Carr 9fcb7a492b
Update .pylintrc
11 months ago
.github/workflows Allow latest release of black to run 1 year ago
adafruit_platformdetect Moves the U2IF constant definitions to a single file so they are not repeated. (Closes #174) 11 months ago
bin add qt2040 trinkey 1 year ago
docs Change minimum Python to 3.6 1 year ago
.gitignore Fixed gitignore and added build 2 years ago
.pylintrc Update .pylintrc 11 months ago Documentification 2 years ago
LICENSE initial commit 3 years ago
README.rst Fix expired Discord link 1 year ago
requirements.txt initial commit 3 years ago Change minimum Python to 3.6 1 year ago



.. image::
:alt: Documentation Status

.. image::
:alt: Discord

.. image::
:alt: Build Status

.. image::
:alt: Code Style: Black

This library provides best-guess platform detection for a range of single-board
computers and (potentially) other platforms. It was written primarily for use
in `Adafruit_Blinka <>`_, but may be
useful in other contexts.

Platform detection is divided into "chip" and "board" detection, with the latter
generally dependent on the former. Platform info is gathered from:

- Python's `sys.platform`

- Various files on Linux systems:

- /proc/cpuinfo (for processor info, Raspberry Pi hardware revisions, etc.)

- /proc/device-tree/compatible (for 96Boards info)

- Beaglebone EEPROM board IDs

- Distribution-specific files such as /etc/armbian-release.

This driver depends on:

* Python 3.5 or higher

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <>`_. To install for current user:

.. code-block:: shell

pip3 install Adafruit-PlatformDetect

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install Adafruit-PlatformDetect

To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install Adafruit-PlatformDetect

Usage Example

.. code-block:: python

from adafruit_platformdetect import Detector
detector = Detector()
print("Chip id: ",
print("Board id: ",

# Check for specific board models:
print("Pi 3B+? ", detector.board.RASPBERRY_PI_3B_PLUS)
print("BBB? ", detector.board.BEAGLEBONE_BLACK)
print("Orange Pi PC? ", detector.board.ORANGE_PI_PC)
print("generic Linux PC? ", detector.board.GENERIC_LINUX_PC)


Contributions are welcome! Please read our `Code of Conduct
before contributing to help this project stay welcoming.


For information on building library documentation, please check out `this guide <>`_.