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

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-bitmapsaver-1.2.10.tar.gz
Algorithm Hash digest
SHA256 0a1ab623ce65667728650fd443142256f621d8ff934c842b50e7b5e71fb48283
MD5 3d8e95c22f60aaf4230f2c4385a58cbc
BLAKE2b-256 f5265e00a7a0f2a0dab7687e559f21cc512c42d71d6661aefa0c728a7b033640

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_bitmapsaver-1.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a6ddb75c775b1f0902bee96e023eef1077fe1e7cc46fe3a33d3577a75c292c91
MD5 c475de8c8136dfbe3c59b996a923b4b7
BLAKE2b-256 afebe96245f3354422a56b2dbdcf192fa70e2c29565dff2d19c95e0f4b6756f2

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