Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Dependencies

This driver depends on:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-bitmapsaver-1.2.7.tar.gz (128.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-bitmapsaver-1.2.7.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-bitmapsaver-1.2.7.tar.gz
Algorithm Hash digest
SHA256 7af440300d8664a9266fefefd5b0bb5a8ef61f8dcf246eac3ea574d48fd68e4a
MD5 8f29c5b0527d58f0f10cd9fda71eba5e
BLAKE2b-256 56be37d29a0b96c0e1fea7af9935b37931b1ea917b8e68bd82bda0618c4d5449

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_bitmapsaver-1.2.7-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_bitmapsaver-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c46c66c079d4107e32978286f93059a6d42ad0e336469ad03e0df6fdbfadb0d7
MD5 92a54a66fc9d9c716f9614fc2c927397
BLAKE2b-256 fdc47d145fb6a5a5dc5fa3cf3b0f0ad0cb0ce78d8464d217f07809b27738e27a

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