Skip to Content
Lumensalis CircuitPython framework coming soon 🎉

Project Definition

A ProjectDefinition is the description you provide to the LCPF which defines what you want your project to do. Techinically, it is a CircuitPython file, but you’re welcome (and maybe even encouraged) to ignore that for now.

Recommendations

Your project definition file should always start with

from LumensalisCP.Simple import *

and end with

main.launchProject(globals())

The first line “activates” the LCPF environment so you can use it to define your project. The second lets LCPF know that your done defining the project and want it to “turn it on. You don’t need to understand anything more than that, just copy them in and they’ll “do their thing”. Better yet, start your project by copying an existing example ProjectDefinition which does somthing similar to what you want, or a template like the one on the Simple Start page.

Last updated on