added option for centering in post_frame method.

when passed frame is smaller than the display it can be centered.
minor fixes and updated readme.

Author: KS-HTK

README.md

@@ -14,17 +14,17 @@ fd = Fluepdot("http://module.local")
 ## Functions
 
 
-function | args | default values | return type | description
----|---|---|---|---
-_init_ | baseURL: str, width: int, height: int | x=115, y=16 | fluepdot.Fluepdot | Constructor for Fluepdot class
-post_time ||| None | indefinitly sets the module to display the current time.
-get_size ||| (int, int) | returns the size of the connected display
-get_frame ||| str | returns the current frame stored by the module
-get_pixel | x: int, y: int | x=0, y=0 | returns the state of a single pixel
-get_fonts ||| None | prints a list of fonts installed on the module
-get_mode ||| fluepdot.Mode | returns the mode the module is in
-post_text | text: str, x: int, y: int, font: str | x=0, y=0, font="DejaVuSans12" | requests.Response | posts a text to the module and returns the requests response
-post_frame | frame: List[List[bool]] || requests.Response | posts a frame to the module and returns the requests response
-set_pixel | x: int, y: int | x=0, y=0 | requests.Response | sets a pixel on the display to active and returns the requests response
-unset_pixel | x: int, y: int | x=0, y=0 | sets a pixel on thes display to inactive and returns the requests response
-set_mode | mode: fluepdot.Mode | mode=Mode.FULL | requests.Response | sets the module to FULL or DIFFERENTIAL update mode and returns the requests response
+| function    | args                                  | default values                | return type       | description                                                                           |
+|-------------|---------------------------------------|-------------------------------|-------------------|---------------------------------------------------------------------------------------|
+| _init_      | baseURL: str, width: int, height: int | x=115, y=16                   | fluepdot.Fluepdot | Constructor for Fluepdot class                                                        |
+| post_time   |                                       |                               | None              | indefinitly sets the module to display the current time.                              |
+| get_size    |                                       |                               | tuple[int, int]   | returns the size of the connected display                                             |
+| get_frame   |                                       |                               | str               | returns the current frame stored by the module                                        |
+| get_pixel   | x: int, y: int                        | x=0, y=0                      | bool              | returns the state of a single pixel                                                   |
+| get_fonts   |                                       |                               | None              | prints a list of fonts installed on the module                                        |
+| get_mode    |                                       |                               | fluepdot.Mode     | returns the mode the module is in                                                     |
+| post_text   | text: str, x: int, y: int, font: str  | x=0, y=0, font="DejaVuSans12" | requests.Response | posts a text to the module and returns the requests response                          |
+| post_frame  | frame: List[List[bool]], center: bool | center=False                  | requests.Response | posts a frame to the module and returns the requests response                         |
+| set_pixel   | x: int, y: int                        | x=0, y=0                      | requests.Response | sets a pixel on the display to active and returns the requests response               |
+| unset_pixel | x: int, y: int                        | x=0, y=0                      | requests.Response | sets a pixel on thes display to inactive and returns the requests response            |
+| set_mode    | mode: fluepdot.Mode                   | mode=Mode.FULL                | requests.Response | sets the module to FULL or DIFFERENTIAL update mode and returns the requests response |

src/fluepdot/fluepdot.py

@@ -1,11 +1,3 @@
-# python fluepdot module
-
-import requests
-import binascii
-from requests import Response
-from enum import Enum
-from typing import Any, Dict, Optional, List
-
 """
   Small library to interact with a fluepdot controlled display
   https://fluepdot.readthedocs.io/en/latest/
@@ -15,6 +7,11 @@
   Currently there is no support for changing the timings.
 """
 
+import requests
+from requests import Response
+from enum import Enum
+from typing import Any, Dict, Optional, List
+
 GetParam = Dict[str, Any]
 PostParam = str
 
@@ -51,17 +48,17 @@ def post_time(self) -> None:
                 dt = ndt
                 self.post_text(dt, x=8, y=1, font="fixed_7x14")
 
-    def get_size(self) -> (int, int):
+    def get_size(self) -> tuple[int, int]:
         frame = self.get_frame()
         self.width = len(frame[0])
         self.height = len(frame) - 1
-        return [self.width, self.height]
+        return self.width, self.height
 
     def get_frame(self) -> List[str]:
         r = self._get(frameURL)
         return r.text.split('\n')
 
-    def get_pixel(self, x: int = 0, y: int = 0) -> bool:
+    def get_pixel(self, x: int = 0, y: int = 0) -> bool | None:
         r = self._get(pixelURL, get={"x": x, "y": y})
         rtn = True if r.text == "X" else False if r.text == " " else None
         return rtn
@@ -81,13 +78,18 @@ def post_text(self, text: str, x: int = 0, y: int = 0, font: str = "DejaVuSans12
     def post_frame_raw(self, frame: str) -> Response:
         return self._post(frameURL, post=frame)
 
-    def post_frame(self, frame: List[List[bool]]) -> Response:
+    def post_frame(self, frame: List[List[bool]], center: bool = False) -> Response:
         data: List[List[str]] = [[" "] * self.width for _ in range(self.height)]
-        for x, l in enumerate(frame):
-            for y, b in enumerate(l):
+        x_offset: int = 0
+        y_offset: int = 0
+        if center:
+            x_offset = (self.width - max(len(line) for line in frame)) // 2
+            y_offset = (self.height - len(frame))//2
+        for y, l in enumerate(frame):
+            for x, b in enumerate(l):
                 if b:
                     try:
-                        data[x][y] = "X"
+                        data[y+y_offset][x+x_offset] = "X"
                     except IndexError as e:
                         print(e)
         outStr = ""