Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
500Foods authored Jun 2, 2024
1 parent 8a05f5a commit dc6a05a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@ While Klipper has been an enormous boon to the 3D printing community as a whole,

As for the name, it is a combination of terms like Phi (referencing the number 500 among other meanings), filament (that's what we're primarily obsessed with in 3D printing) and element (we're taking things down to the element level, that sort of thinking). The individual components of the project have been named after atomic elements, for example.

## Elements
This project has a number of components, each named after an element in the periodic table.
- hydrogen - A C program that is the basic building block of Philement. This is intended to run on or close to the printer (or perhaps control several printers), like on a Raspberry Pi, typically alongside Klipper. It provides a combination of what Klipper and Moonraker provide, in that it serves up a websocket interface, but provides the low-level control of the printer. In the near-term, this will act more like Moonraker where it interfaces with Klipper, which we would need to do anyway.
- helium - Everything database-related. And there's a lot of database stuff going on. Support for the most popular flavors, naturally - SQLite, Postgres, MySQL/MariaDB, and IBM DB2 just because we can.
- lithium - The UI. This is all CSS/HTML/JS. Talks almost exclusively to the hydrogen websocket interface.
- beryllium - Deals with everything gcode-related. Analyzing gcode for print times and filament requirements. Macro expansion. Lua support. Things like that.
- boron - Rhymes with Voron! This component is concerned with managing the vast amount of information about printers and components. Like Vorons. Or Troodons.
- carbon - A C program used to compare two images. This is part of a basic print failure detection system that uses timelapse-style images taken between layers to see if an object has been knocked out of position, or if we're dealing with spaghetti, that sort of thing.
- Nitrogen - Think "clapperboard" for 3D printers.
- Oxygen - Notifications.
- Fluorine - Security stuff.
- Neon - Well, lighting, obviously.
- Sodium - MMU stuff.
- Magnesium - Print farm stuff.

## Additional Notes
While this project is currently under active development, feel free to give it a try and post any issues you encounter. Or start a discussion if you would like to help steer the project in a particular direction. Early days yet, so a good time to have your voice heard. As the project unfolds, additional resources will be made available, including platform binaries, more documentation, demos, and so on.

Expand Down

0 comments on commit dc6a05a

Please sign in to comment.