josh
/
Teacup_Firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README to match new file layout

This commit is contained in:
Michael Moon 2010-11-10 15:33:57 +11:00
parent 37f6dbff23
commit 5460750ee3
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README
View File

@ -108,11 +108,11 @@ The PID code in heater.c is probably quite generalisable, and seems to work well
*** analog.[ch] *** analog.[ch]
This is the analog subsystem. Only used if you have a thermistor or ad595 This is the analog subsystem. Only used if you have a thermistor or ad595
*** arduino.h *** arduino.h, arduino_[chip].h
Pin mappings and helper functions for various arduinos ('168/'328-based and '644-based only so far, feel free to add '1280 and post a patch) Pin mappings and helper functions for various atmegas
*** clock.[ch] *** config.h.dist, config.h
A system clock for periodic tasks. Supports a long-running clock, but this is disabled by default as nothing uses it (yet!) Configuration for your electronics and hardware. Copy config.h.dist to config.h, edit config.h to suit
*** copier.[ch] *** copier.[ch]
A totally untested and currently unused chunk of code for copying firmware to another identical chip A totally untested and currently unused chunk of code for copying firmware to another identical chip
@ -126,20 +126,29 @@ The queue of moves received from the host.
*** debug.[ch] *** debug.[ch]
Debugging aids Debugging aids
*** delay.[ch]
Delay functions
*** FiveD_on_Arduino.pde *** FiveD_on_Arduino.pde
Allows firmware to be built in arduino ide Allows firmware to be built in arduino ide
*** func.sh *** func.sh
Lots of host-side shell scripts for talking to firmware Lots of host-side shell scripts for talking to firmware
*** gcode.[ch] *** gcode_parse.[ch]
Gcode interpreter. Scaling of factors to internally used integer or fixed point happens here too. Gcode parser. Scaling of factors to internally used integer or fixed point happens here too.
*** gcode_process.[ch]
Gcodes actually get executed here after being parsed.
*** heater.[ch] *** heater.[ch]
Heater management, including PID and PWM algorithms, and some configuration parameters Heater management, including PID and PWM algorithms, and some configuration parameters
*** machine.h *** intercom.[ch]
Configuration variables to match firmware to your hardware Gen3 serial link control and communication
*** LICENSE
Gnu GPL2 license
*** Makefile *** Makefile
instructions for make on how to build firmware. has a list of modules to build which may need to be updated every so often instructions for make on how to build firmware. has a list of modules to build which may need to be updated every so often
@ -147,8 +156,8 @@ instructions for make on how to build firmware. has a list of modules to build w
*** mendel.c *** mendel.c
Firmware startup and main loop code Firmware startup and main loop code
*** pinout.h *** pinio.h
This file associates various functions with particular pins on your avr A few I/O primitives
*** README *** README
this file this file