Skip to content

craftmicro/craftmicro-sdk

Repository files navigation

Craft Micro SDK

Craft Micro logo

The Craft Micro SDK is a code library for rapid development of graphical apps for microprocessor-based systems. The various individual libraries that make up this library (such as display and drawing libraries) might also be useful in other projects.

Craft Micro maintains an open-source software library and set of plans to craft your own microprocessor-based handheld gaming console.

Craft Micro is based on the Arduino Framework. We recommend the PlatformIO plugin for VSCode for cross-platform microprocessor development.

Status

Although it is usable, the Craft Micro SDK is pre-alpha and is not recommended for release. Feel free to try it out and use it for your own projects, but expect to find bugs, and expect parts of the codebase to change without warning.

Examples and Documentation

A good place to begin with Craft Micro is to check out the SDK examples.

Refer to the documentation for more detail. The docs are also included in the repo.

Dependencies

Craft Micro itself has no dependencies. However, it's likely that the hardware you are using, such as a TFT display, will require additional libraries - for example SPI or I2C.

The examples use Bodmer's TFT_eSPI library.

Minimum requirements

Tested on:

See examples for some of these platforms.

Recommend at least:

  1. 16kB RAM
  2. 128kB of Flash (Storage for music and graphics etc)

Minimum requirements are as-yet untested. This section will be updated as new devices are tested.

To keep memory usage low, this SDK uses a linebuffer (double-buffered) instead of a full framebuffer for rendering graphics to the screen. This only requires 6 * display_width bytes of RAM. E.g. A 320 width displays scaled to 4x4 pixels (resulting in 80 pixels) requires a 480 byte linebuffer.

Licence

The software components of this project are released under the MIT licence.

Acknowledgements

Code from many authors has contributed to Craft Micro. This project would not be possible without them. There are too many people to thank, but a special shout-out goes to Adafruit industries for their amazing, comprehensive and well-written software libraries.

About

The Craft Micro SDK is a code library for rapid development of graphical apps for microprocessor-based systems

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors