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.83.1.tar.gz (48.9 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.83.1-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.83.1.tar.gz
Algorithm Hash digest
SHA256 9d199826d78abb65972fdaeab7ba69dd5ee1c44672c07be8b5df68c3bee0f890
MD5 3420dadc6b4aaf3a76af3113b9a99c11
BLAKE2b-256 8f3584d27c400b4db6ea91265465956e69f69a6f385a5f7faab1cc9c4ca47430

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.83.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4ea2dd31617390050a2c5e1b09f4362ce68ae6194e91e9a02d476a0826e63c7
MD5 fe734925c73f32b4e42ccda2980cec1c
BLAKE2b-256 d25b74bc873f6fe6d5e5cb52352ab201b1593100d4ed52fdbe92bf84c8776932

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