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.84.0.tar.gz (49.2 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.84.0-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: adafruit_platformdetect-3.84.0.tar.gz
  • Upload date:
  • Size: 49.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for adafruit_platformdetect-3.84.0.tar.gz
Algorithm Hash digest
SHA256 71dc77b358047e6ae4fe94247ea03449fe8ab3e3e937239d5bd1d4b942ebee73
MD5 3190fe86944f7a8898670b5d6e61a33a
BLAKE2b-256 5a7b42a3d2a5d6f470a70e47c8c4c122c8014e91bda35876518709004651338b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.84.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c0ebb89e3e40a36b53363377fe05b517e756b1a8944afcee25f633de79e149f
MD5 84198b8df5fd4b48bb9b70ef846a8ab1
BLAKE2b-256 aae0932c83d203fa90961dc8f853bbfc889d1985a81267db0a1032a91f086af8

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