Skip to main content

Introduction

Documentation Status Discord Build Status 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.

Dependencies

This driver depends on:

  • Python 3.7 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:

pip3 install Adafruit-PlatformDetect

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

sudo pip3 install Adafruit-PlatformDetect

To install in a virtual environment in your current project:

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

Usage Example

from adafruit_platformdetect import Detector
detector = Detector()
print("Chip id: ", detector.chip.id)
print("Board id: ", detector.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)

Contributing

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

Documentation

For information on building library documentation, please check out this guide.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_platformdetect-3.79.0.tar.gz (48.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_platformdetect-3.79.0-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_platformdetect-3.79.0.tar.gz.

File metadata

  • Download URL: adafruit_platformdetect-3.79.0.tar.gz
  • Upload date:
  • Size: 48.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for adafruit_platformdetect-3.79.0.tar.gz
Algorithm Hash digest
SHA256 13f522c4ab92441600c3f47fd795b1610a646034922ecd2cbc1e207c64c3cf7f
MD5 4843b3d6328a6aa8cc9f31c54bee6e75
BLAKE2b-256 dcfe74c3cdba24f06e8748819dbbc4912e3e2193f1a900c96b659e5794dee3a8

See more details on using hashes here.

File details

Details for the file adafruit_platformdetect-3.79.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_platformdetect-3.79.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10e4dccaa72c2a0fcb64eab1482b55857264d667ae5481963a20786948a44b72
MD5 f656ab0bc4193afae0f54013e5169aee
BLAKE2b-256 bab14dbbe1b147bf1e1fc1c1247e2b8644f9cdcdb2440402664ae99e75899495

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page