Skip to content

Commit

Permalink
github markup != gitea markup
Browse files Browse the repository at this point in the history
  • Loading branch information
@easytarget
easytarget committed Sep 18, 2019
1 parent 3c627b9 commit 661c666
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
![Prototype](./images/assembled-running.jpg)

* Only displays very basic info: Status, tool and bed status + temperatures, prcentage printed.
* This is it.. the displays are less then an 2cm in size and I will not overload them with info.
* This is it.. the displays are less then an 2cm in size and I will not overload them with info.
* Periodically sends `M408 S0` status requests to the controller and processes the Json reply.
* Uses Jsmn (jasmin) to process lots of Json in a smallish footprint.
* Uses Jsmn (jasmin) to process lots of Json in a smallish footprint.
* Also responds to some 'config' Json for update speed, brightness, button and [more](#control)
* Sleep mode when controller reports PSU off, (configurable).
* Activity LED and Pause button (configurable).
Expand All @@ -19,17 +19,17 @@ The hardware for this is as important as the software; it runs on a standlaone A

![Thumb](./images/PrintEye-Schematic-thumb.png "Full Schematics in Hardware repo") ![Thumb](./images/PrintEye-pcb-thumb.jpg "Full KiCad files in Hardware repo")

* Level converters allow the PrintEye to run at 5V while communicating with the 3.2v Duet.
* Level converters allow the PrintEye to run at 5V while communicating with the 3.3v Duet.
* This should also be Compatible with the (as of this writing) upcoming V3 Duet electronics
* A new cable layout and duet config would be needed since the V3 hardware uses 5 pin connectors that can be mapped to functions
* A new cable layout and duet config would be needed since the V3 hardware uses 5 pin connectors that can be mapped to functions

# Software
## Requirements
* You need to include the [U8glib](https://github.com/olikraus/u8g2/) Graphics library for the displays; this is available in the ArduinoIDE; search for 'U8g2' in the library manager, or follow instructions [here](https://github.com/olikraus/u8g2/wiki)
* The Jsmn library (https://github.com/zserge/jsmn) is included with the sketch.
* I used a FTDI adapter to do the programming and serial debugging during development; the circuit incorporates a the correct reset pin pullup+capacitor to allow low voltage in-circuit reprogramming.
* For more on FTDI programmers see https://learn.adafruit.com/ftdi-friend/overview
* I found I had to leave my FTDI programmer set to 5v for reliable programming of the final PCB; it would frequently fail to detect the reset pulldown otherwise.
* For more on FTDI programmers see https://learn.adafruit.com/ftdi-friend/overview
* I found I had to leave my FTDI programmer set to 5v for reliable programming of the final PCB; it would frequently fail to detect the reset pulldown otherwise.
* The Arduino MemoryFree lib was used during debug (see comments and `#define DEBUG` in code).

## Development
Expand All @@ -39,29 +39,29 @@ I used the Arduino IDE for development and testing; and did a lot of work using
You can use `M118` from the terminal or in your macros to configure the PrintEye via Json.

* `{"pe_rate":integer}`
* Set the approximate interval in ms that PrintEye spends waiting for a `M408` response before retrying
* Default: 1000
* Set the approximate interval in ms that PrintEye spends waiting for a `M408` response before retrying
* Default: 1000
* `{"pe_fails":integer}`
* Maximum number of failures before displaying `Waiting for Printer`
* `-1` to prevent entering `Waiting for Printer` state
* Default: 6
* Maximum number of failures before displaying `Waiting for Printer`
* `-1` to prevent entering `Waiting for Printer` state
* Default: 6
* `{"pe_bright":byte}`
* Brightness for display, 0-255, 0 is off
* Default 128
* Brightness for display, 0-255, 0 is off
* Default 128
* `{"pe_saver":boolean}`
* If true enter sleep mode when printer status = 'O' (Vin off)
* Default: true
* If true enter sleep mode when printer status = 'O' (Vin off)
* Default: true
* `{"pe_pause":integer}`
* Number of ms the button must be held to trigger a pause (`M25`) while printing, and resume (`M24`) when paused
* Set to zero to disable the pause button
* Setting this longer than the updateinterval might produce activity LED weirdness and laggy response
* Default: 333
* Number of ms the button must be held to trigger a pause (`M25`) while printing, and resume (`M24`) when paused
* Set to zero to disable the pause button
* Setting this longer than the updateinterval might produce activity LED weirdness and laggy response
* Default: 333
* `{"pe_led":byte}`
* Brightness level (0-255) for the activity LED, set to 0 to disable
* Default: 80
* Brightness level (0-255) for the activity LED, set to 0 to disable
* Default: 80
* `{"pe_lmsg":"string"}` & `{"pe_rmsg":"string"}`
* Left and right panel text to be displayed in Idle and Sleep mode, max 10 characters, enclose in quotes.
* Setting the left text to `SHOWSTATUS` results in the default behaviour of showing the actual status there
* Left and right panel text to be displayed in Idle and Sleep mode, max 10 characters, enclose in quotes.
* Setting the left text to `SHOWSTATUS` results in the default behaviour of showing the actual status there

The Jsmn library provides some robustness in processing key/value pairs (in the use of quotes etc); but the Json must be structually correct and terminated.
* Be aware that you need to repeat double quotes to pass them via 'M118'.
Expand All @@ -80,12 +80,12 @@ M118 P2 S"{""pe_bright"":1}" ; Printeye as low as possible
## Caveats
* Memory is the biggest limit here; the Json parser uses quite a bit of ram, and code space. The Displays and their library eat the rest. I've had to fight low program memory and ram to get this working acceptably.
* Max json size = 500 bytes; or 86 [Jsmn tokens](https://github.com/zserge/jsmn#design).
* Exceeding this causes the incoming Json to be ignored
* These defaults are the result of considerable testing and debugging; they should be good for responses from a 4 extruder system with heated bed and enclosure
* Exceeding this causes the incoming Json to be ignored
* These defaults are the result of considerable testing and debugging; they should be good for responses from a 4 extruder system with heated bed and enclosure
* Software I2C is slow.
* Experimenting with an alternative (one HW + One SW) looked weird and unbalanced.
* An I2C multiplexer would solve this, or using a chip (Mega256?) with dual hardware I2C, both add complexity
* I have tried to compensate for the slow redrawing by sequencing the order of updating screen elements; eg making the updates look more like animations.
* Experimenting with an alternative (one HW + One SW) looked weird and unbalanced.
* An I2C multiplexer would solve this, or using a chip (Mega256?) with dual hardware I2C, both add complexity
* I have tried to compensate for the slow redrawing by sequencing the order of updating screen elements; eg making the updates look more like animations.
* You need level shifters for interfacing to a Duet UART (PanelDue) port if you run this at 16Mhz/5v, alternatively use a 12Mhz/3.3v combo, or experiment with 16Mhz/3.3v and the underclock option discussed in the `setup()` section of the sketch. Display updates will be even slower for this, and you will need to add a 3v3 regulator, or tap the controllers 3v3 line for power.

## Enhancements:
Expand Down

0 comments on commit 661c666

Please sign in to comment.