Skip to main content

Platform detection for use by libraries like Adafruit-Blinka.

Project description

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.

Project details


Release history Release notifications | RSS feed

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.42.0.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

Adafruit_PlatformDetect-3.42.0-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file Adafruit-PlatformDetect-3.42.0.tar.gz.

File metadata

File hashes

Hashes for Adafruit-PlatformDetect-3.42.0.tar.gz
Algorithm Hash digest
SHA256 9c5a4f24a42fed436ccdad4f01c4ec64d569f671556bfa4796f35154ce142146
MD5 b5c5c6f4a8753139e49c2cc2efc9b345
BLAKE2b-256 5030a777b31f34249b9c367cf42fe80325f0699d66ed86343dc7eb6dd027d34d

See more details on using hashes here.

File details

Details for the file Adafruit_PlatformDetect-3.42.0-py3-none-any.whl.

File metadata

File hashes

Hashes for Adafruit_PlatformDetect-3.42.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64e243e19f9604b7dfd2ce53e88c41fa4b11b9e1441c6492f00fc5796b39b373
MD5 f2a09ea246630aa383720ca5de77e34c
BLAKE2b-256 2825e4bfc69878f8065b1cfc95c31567adcca2e6b9974554b51f330b8cb04559

See more details on using hashes here.

Supported by

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