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.78.0.tar.gz (48.4 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.78.0-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.78.0.tar.gz
Algorithm Hash digest
SHA256 84d5333e002fb1f1c352c70e9a469c6729045c3d6cdcce67efce4d2a77a60951
MD5 01c1300e80a6214d1380ec06c778a119
BLAKE2b-256 1f64d6ae6d96910f6ba64456bcc0ab15d03cfbd95952f21f4bb0e0c5e89c8c15

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.78.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75a2ea6a479db2ea2e82573ee4d224d70a194d774a6bc524ee92ca72e1489c01
MD5 ef315ca804200826ae0f78bfeae3f3de
BLAKE2b-256 b2fab4dc4632168d78c700fcdc510fc0789035811f3e08ff831b091730f8732b

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