This API provides features that are selectively available, depending on the pi-top device that you are using. To find out what is available for your pi-top device, see the relevant section below.
Choose your pi-top device to go to the relevant section:
pi-top [4]<overview:pi-top [4]>pi-top [3]<overview:pi-top laptops>pi-topCEED<overview:pi-topCEED>Original pi-top<overview:pi-top laptops>
This API provides some convenience classes for common System Peripheral Devices<api_system_devices:API - System Peripheral Devices>, such as:
- Camera
- Keyboard
pi-top [4] supports the following API devices/components for its onboard hardware:
api_pitop_device:pi-top Batteryapi_pitop_device:pi-top [4] Miniscreen
pi-top [4] does not support the following API devices/components:
api_pitop_device:pi-top Display
This is due to the fact that pi-top [4] has no attached display, and the pi-top [4] official display's brightness is handled in hardware with physical brightness buttons, and the backlight is handled by DPMS (the operating system's internal screen blanking functionality).
pi-top [4] supports the following API devices/components for physical computing:
api_pitop_peripheral_devices:pi-topPULSEpi-top Maker Architecture (PMA) Components<api_pma_components:API - pi-top Maker Architecture (PMA) Components>
The pi-topPULSE can be used as a Raspberry Pi HAT with a pi-top [4]. The USB camera library can be used with any USB camera, and - whilst technically can be used with any Raspberry Pi/pi-top, was designed with the pi-top [4] and PMA in mind.
pi-top [4] does not support the following API devices/components:
api_pitop_peripheral_devices:pi-topPROTO+
This is due to the fact that pi-topPROTO+ makes use of the legacy 'modular rail', which has no way of connecting to a pi-top [4].
Check out the key concepts for pi-top Maker Architecture<key_concepts:pi-top Maker Architecture> for more information.
pi-top laptops (Original pi-top and pi-top [3]) support the following API devices/components for their onboard hardware:
api_pitop_device:pi-top Batteryapi_pitop_device:pi-top Display
pi-top laptops does not support the following API devices/components:
api_pitop_device:pi-top [4] Miniscreen
This is due to the fact that pi-top laptops do not include the pi-top [4]'s miniscreen.
pi-top laptops (Original pi-top and pi-top [3]) support the following API devices/components for use with peripherals:
api_pitop_peripheral_devices:pi-topPROTO+api_pitop_peripheral_devices:pi-topPULSE
Note that the USB camera library works with any pi-top with a USB camera connected. This was designed for pi-top [4] usage, but due to its general purpose functionality, it can technically be used if desired.
pi-topSPEAKER support is provided automagically by pi-topd, and so there is no exposed API for this.
pi-top laptops does not support the following API devices/components:
pi-top Maker Architecture (PMA) Components<api_pma_components:API - pi-top Maker Architecture (PMA) Components>
This is due to the fact that PMA is only available for pi-top [4].
pi-top laptops (Original pi-top and pi-top [3]) support the following API devices/components for their onboard hardware:
api_pitop_device:pi-top Display
pi-top laptops does not support the following API devices/components:
api_pitop_device:pi-top Batteryapi_pitop_device:pi-top [4] Miniscreen
This is due to the fact that pi-topCEED does not include a battery or the pi-top [4]'s miniscreen.
pi-topCEED supports the following API devices/components for use with peripherals:
api_pitop_peripheral_devices:pi-topPROTO+api_pitop_peripheral_devices:pi-topPULSE
Note that the USB camera library works with any pi-top with a USB camera connected. This was designed for pi-top [4] usage, but due to its general purpose functionality, it can technically be used if desired.
pi-topSPEAKER support is provided automagically by pi-topd, and so there is no exposed API for this.
pi-topCEED does not support the following API devices/components:
pi-top Maker Architecture (PMA) Components<api_pma_components:API - pi-top Maker Architecture (PMA) Components>
This is due to the fact that PMA is only available for pi-top [4].