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

Uploaded Source

Built Distribution

Adafruit_PlatformDetect-3.72.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_platformdetect-3.72.1.tar.gz
Algorithm Hash digest
SHA256 a360ccb5fddfe60ce52304bb2d5a5345993df03997e33b7fd2dc65e51c39f02c
MD5 78212af3ea739d8679f7ccf5647961a6
BLAKE2b-256 51782de7248ed259c8e3c5b20194ff7b40af15dde88cc6462bdf3b8b78339f12

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Adafruit_PlatformDetect-3.72.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65a0aa5054a4a9a8f7e3d4eec9828815a4e1b02085b3c977975e41f697226fd5
MD5 a60c1ac54c0ea7211ae1f3f43b90ad13
BLAKE2b-256 9f80f6ed00cfb6511fd7514c51d781d83eb668c7f9a2996201002eb4ee388617

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