pitop
stable
1. Getting Started
1.1. Installing the SDK
1.1.1. pi-topOS
1.1.2. Using apt
1.1.3. Using PyPI
1.1.4. Building from source
1.2. Checking that the SDK is installed and working
1.3. What next!?
2. Overview
2.1. pi-top [4]
2.1.1. Interacting with onboard pi-top [4] hardware
2.1.2. Physical computing with pi-top [4]
2.2. pi-top laptops
2.2.1. Interacting with onboard pi-top laptop hardware
2.2.2. Using peripherals with a pi-top laptop
2.3. pi-topCEED
2.3.1. Interacting with onboard pi-topCEED hardware
2.3.2. Using peripherals with a pi-topCEED
3. Key Concepts
3.1. pi-top Maker Architecture
3.1.1. Inputs and Outputs
3.1.2. Digital and Analog
3.1.3. Ports and Pins
3.1.3.1. Digital Ports
3.1.3.2. Analog Ports
3.1.3.3. Motor Ports
3.1.3.4. ServoMotor Ports
3.1.3.5. I2C Ports
3.1.4. Identifying PMA port for a component
3.1.4.1. Digital component
3.1.4.2. Analog component
3.1.4.3. Motor component
3.1.5. More Information
3.2. pi-top [4] Miniscreen
4. Recipes
4.1. PMA: Using a Button to Control an LED
4.2. Robotics Kit: DIY Rover
4.3. Robotics Kit: Robot - Moving Randomly
4.4. Robotics Kit: Robot - Line Detection
4.5. Displaying camera stream in pi-top [4]’s miniscreen
4.6. Robotics Kit: Robot - Control using Bluedot
4.7. Using the pi-topPULSE’s LED matrix to show the battery level
4.8. Choose a pi-top [4] miniscreen startup animation
5. API - pi-top Device
5.1. Pitop
5.1.1. Class Reference: Pitop
5.1.2. Using the Pitop object
5.1.2.1. Attaching objects and saving configuration to a file
5.1.2.2. Loading an existing configuration
5.2. pi-top Battery
5.2.1. Class Reference: pi-top Battery
5.3. pi-top Display
5.3.1. Class Reference: pi-top Display
5.4. pi-top [4] Miniscreen
5.4.1. Using the Miniscreen’s OLED Display
5.4.1.1. Displaying text
5.4.1.2. Showing an image
5.4.1.3. Loop a GIF
5.4.1.4. Displaying an GIF once
5.4.1.5. Displaying an GIF once through frame by frame
5.4.1.6. Displaying an GIF looping in background
5.4.1.7. Handling basic 2D graphics drawing and displaying
5.4.1.8. Displaying a clock
5.4.1.9. Display a particle-based screensaver
5.4.1.10. Prim’s algorithm
5.4.1.11. 2-Player Pong Game
5.4.2. Class Reference: pi-top [4] Miniscreen
5.4.3. Using the Miniscreen’s Buttons
5.4.4. Class Reference: pi-top [4] Miniscreen Button
6. API - pi-top Maker Architecture (PMA) Components
6.1. Button
6.2. Buzzer
6.3. Encoder Motor
6.3.1. Parameters
6.4. LED
6.5. Light Sensor
6.6. Potentiometer
6.7. Servo Motor
6.8. Sound Sensor
6.9. Ultrasonic Sensor
7. API - pi-top Peripheral Devices
7.1. pi-topPROTO+
7.1.1. Using the pi-topPROTO+ as a Distance Sensor
7.1.2. Class Reference: pi-topPROTO+ Distance Sensor
7.1.3. Using the pi-topPROTO+’s onboard ADC
7.1.4. Class Reference: pi-topPROTO+ ADC Probe
7.2. pi-topPULSE
7.2.1. Using the pi-topPULSE’s microphone
7.2.2. Using the pi-topPULSE’s LED matrix: Test colors
7.2.3. Using the pi-topPULSE’s LED matrix: Fancy Light Show!
7.2.4. Using the pi-topPULSE’s LED matrix: Showing CPU temperature
7.2.5. Using the pi-topPULSE’s LED matrix: Showing CPU usage
7.2.6. Module Reference: pi-topPULSE Configuration
7.2.7. Module Reference: pi-topPULSE LED Matrix
7.2.8. Module Reference: pi-topPULSE Microphone
7.2.9. Advanced: EEPROM
8. API - System Peripheral Devices
8.1. USB Camera
8.1.1. Using a USB Camera to Access Image Data
8.1.2. Using a USB Camera to Capture Video
8.1.3. Adding Motion Detection to a USB Camera
8.1.4. Processing Camera Frame
8.1.5. Processing Camera Frame Stream with OpenCV (Convert to grayscale)
8.1.6. Ball Color Detection with OpenCV
8.1.7. Class Reference: USB Camera
8.2. Keyboard Button
8.2.1. Class Reference: KeyboardButton
8.2.2. Special Key Names
9. Command-Line Tools (CLI)
9.1. ‘pi-top’ Command
9.1.1. pi-top battery
9.1.2. pi-top display
9.1.2.1. pi-top display brightness
9.1.2.2. pi-top display backlight
9.1.2.3. pi-top display blank_time
9.1.3. pi-top devices
9.1.4. pi-top imu
9.1.5. pi-top oled
9.1.5.1. pi-top oled display
9.1.5.2. pi-top oled spi
9.1.6. pi-top support
9.1.6.1. pi-top support links
9.1.6.2. pi-top support health_check
10. 🧪 Labs - Experimental APIs ⚠️
10.1. Web
10.1.1. Servers
10.1.1.1. WebServer
10.1.1.2. WebController
10.1.1.3. RoverWebController
10.1.2. Blueprints
10.1.2.1. BaseBlueprint
10.1.2.2. WebComponentsBlueprint
10.1.2.3. MessagingBlueprint
10.1.2.4. VideoBlueprint
10.1.2.5. ControllerBlueprint
10.1.2.6. RoverControllerBlueprint
11. More Information
11.1. Frequently Asked Questions
11.1.1. How does this SDK work?
11.1.2. What is PMA?
11.1.3. I keep getting an Exception - what is the problem?
11.1.4. Where did this SDK come from?
11.1.5. I was using an older version of the Python libraries. How can I update to use this SDK?
11.1.6. I lost my miniscreen menu - where is it?
11.2. API Changes
11.3. Contributing
11.4. References
11.5. Requirements
11.6. License
pitop
Docs
»
11. More Information
»
11.2. API Changes
Edit on GitHub
11.2. API Changes
¶
This section aims to outline key changes made between versions, to support upgrading.
Read the Docs
v: stable
Versions
latest
stable
v0.32.0-1
v0.31.0-4
v0.31.0-3
v0.31.0-2
v0.31.0-1
v0.30.0-1
v0.29.0-2
v0.29.0-1
v0.28.0-1
v0.27.1-1
v0.26.3-1
v0.26.2-1
v0.26.1-1
v0.26.0-1
v0.25.0-1
v0.24.3-1
v0.24.2-1
v0.24.1-3
v0.24.1-1
v0.24.0-1
v0.23.0-1
v0.22.0-1
v0.21.0-1
v0.20.3-2
v0.20.3-1
v0.20.2-1
v0.20.1-1
v0.20.0-2
v0.19.0
v0.18.12
v0.18.11
v0.18.10
v0.18.9
v0.18.7
v0.18.6
v0.18.5
v0.18.4
v0.18.3
v0.18.2
v0.18.1
v0.18.0
v0.17.1
v0.17.0
v0.16.6
v0.16.5
v0.16.4
0.16.2
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.