Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@adriankeenan
adriankeenan committed Jan 10, 2025
1 parent f907ea9 commit d763b91
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ Data should be sent form-encoded.
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------|
| `image` | Image file to display. Any image type supported by the Python PIL library should work. | N/A | Yes |
| `mode` | Display mode, corresponding to the `display_XXX` method on the `epd` object.<br>`FAST` - uses `display_Fast` for a complete screen refresh.<br>`4GRAY` - uses `display_4Gray` in order to display an image in black, white and 2 shades of grey.<br>`PARTIAL` - uses `display_Partial` for incremental updates (which may cause ghosting). | `FAST` | No |
| `dither` | Whether to enable dithering when converting image to mono chromatic. `true` or `1` to enable. | `true` | No |
| `dither` | Whether to enable dithering when converting image to mono or 4 gray palette. `true` or `1` to enable. | `true` | No |
| `resize` | `FIT` Resize keeping aspect ratio, without cropping.<br>`CROP` Resize keeping aspect ratio, with cropping.<br>`STRETCH` fill display, ignoring aspect ratio.<br>`NONE` Display without any scaling, pixels drawn 1:1. | `FIT` | No |
| `rotate` | Number of degrees to rotate counter-clockwise, supports increments of 90 degrees. | `0` | No |
| `background` | Background colour to use if the image doesn't fill the display. Either `WHITE` or `BLACK`. | `WHITE` | No |

Expect this call to take ~5 seconds.
Expect this call to take ~5 seconds.

Display update will be skipped if the resulting image is the same as the last request (see `updated` field in the response).
Display update will be skipped if the resulting image is the same as the last request (see `updated` field in the response).

### Fetching the current image

Expand Down

0 comments on commit d763b91

Please sign in to comment.