adafruit-circuitpython-bitmapsaver

Introduction

Save a displayio.Bitmap (and associated displayio.Palette) into a BMP file.

Dependencies

This driver depends on:

Adafruit CircuitPython

CircuitPython 5.0 or later is required.

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

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-circuitpython-bitmapsaver

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-bitmapsaver

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-bitmapsaver

Usage Example

import board
import busio
import digitalio
from displayio import Bitmap, Palette
import adafruit_sdcard
import storage
from adafruit_bitmapsaver import save_pixels

print('Setting up SD card')
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
cs = digitalio.DigitalInOut(board.SD_CS)
sdcard = adafruit_sdcard.SDCard(spi, cs)
vfs = storage.VfsFat(sdcard)
storage.mount(vfs, "/sd")

WHITE = 0xFFFFFF
BLACK = 0x000000
RED = 0xFF0000
ORANGE = 0xFFA500
YELLOW = 0xFFFF00
GREEN = 0x00FF00
BLUE = 0x0000FF
PURPLE = 0x800080
PINK = 0xFFC0CB

colors = (BLACK, RED, ORANGE, YELLOW, GREEN, BLUE, PURPLE, WHITE)

print('Building sample bitmap and palette')
bitmap = Bitmap(16, 16, 9)
palette = Palette(len(colors))
for i, c in enumerate(colors):
    palette[i] = c

for x in range(16):
    for y in range(16):
        if x == 0 or y == 0 or x == 15 or y == 15:
            bitmap[x, y] = 1
        elif x == y:
            bitmap[x, y] = 4
        elif x == 15 - y:
            bitmap[x, y] = 5
        else:
            bitmap[x, y] = 0

print('Saving bitmap')
save_pixels('/sd/test.bmp', bitmap, palette)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Metadata

Release files for adafruit-circuitpython-bitmapsaver 1.3.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-bitmapsaver 1.3.11
File	Size	Uploaded
adafruit_circuitpython_bitmapsaver-1.3.11.tar.gz	124.2 kB	Apr 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-bitmapsaver 1.3.11
File	Interpreter	ABI	Platform	Reset
adafruit_circuitpython_bitmapsaver-1.3.11-py3-none-any.whl 6.3 kB Apr 23, 2026	Python 3	none	any	Details

Total release size: 130.5 kB

Release files / adafruit_circuitpython_bitmapsaver-1.3.11.tar.gz

Download URL	adafruit_circuitpython_bitmapsaver-1.3.11.tar.gz
Size	124.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`f62597ffd7ad4940765797f17ae42e1ac947460507f27c4a207c2b4d46d1bc4a`
BLAKE2b-256 checksum How to use checksums	`b95dd74f4eca3c6217c7ac959d02a8d94c7397892bfefff27fb4f67833137944`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`

Release files / adafruit_circuitpython_bitmapsaver-1.3.11-py3-none-any.whl

Download URL	adafruit_circuitpython_bitmapsaver-1.3.11-py3-none-any.whl
Size	6.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4acee973a882846317732ad1e1ee29efe192eab587ff0e627b5c7db10833b6ec`
BLAKE2b-256 checksum How to use checksums	`b91e516bd08bde7cddcb81e75ddc3024bf52fea3a75633d95294c186644f598d`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`