updated fluepdot.py to a class

  so that multiple instances can be created

updated README.md accordingly

Author: KS-HTK

README.md

@@ -3,20 +3,20 @@
 This is a small collection of functions for interacting with a
 [fluepdot](https://fluepdot.readthedocs.io/en/latest/) module.
 
-the first call after importing should always be to set the URL at
-which the module can be reached.
+import Fluepdot class and create an instance with link as the first arg
 
 ```python
-import fluepdot as fd
+from fluepdot import Fluepdot
 
-fd.set_url("module.local")
+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

src/fluepdot/fluepdot.py

@@ -25,119 +25,117 @@ class Mode(Enum):
 
 
 # endpoints:
-baseURL: str = None
 frameURL: str = "/framebuffer"
 pixelURL: str = "/pixel"
 textURL: str = "/framebuffer/text"
 fontURL: str = "/fonts"
 modeURL: str = "/rendering/mode"
 
-# size defaults:
-width: int = 115
-height: int = 16
+class Fluepdot:
+    def __init__(self, baseURL: str, width: int = 115, height: int = 16):
+        self.baseURL = baseURL
+        self.width = width
+        self.height = height
+        self.fonts: Optional[List[str]] = None
 
-fonts: Optional[List[str]] = None
 
+    def set_url(self, url: str):
+        self.baseURL = url
 
-def set_url(url: str):
-    global baseURL
-    baseURL = url
 
+    def post_time(self) -> None:
+        import datetime
+        dt: str = ""
+        while True:
+            ndt: str = datetime.datetime.now().strftime("%d.%m.%y %H:%M")
+            if ndt != dt:
+                dt = ndt
+                post_text(dt, x=8, y=1, font="fixed_7x14")
 
-def post_time() -> None:
-    import datetime
-    dt: str = ""
-    while True:
-        ndt: str = datetime.datetime.now().strftime("%d.%m.%y %H:%M")
-        if ndt != dt:
-            dt = ndt
-            post_text(dt, x=8, y=1, font="fixed_7x14")
 
+    def get_size(self) -> (int, int):
+        frame = get_frame()
+        self.width = len(frame[0])
+        self.height = len(frame) - 1
+        return [self.width, self.height]
 
-def get_size() -> (int, int):
-    global width, height
-    frame = get_frame()
-    width = len(frame[0])
-    height = len(frame) - 1
-    return [width, height]
 
+    def get_frame(self) -> List[str]:
+        r = _get(frameURL)
+        return r.text.split('\n')
 
-def get_frame() -> List[str]:
-    r = _get(frameURL)
-    return r.text.split('\n')
 
+    def get_pixel(self, x: int = 0, y: int = 0) -> bool | None:
+        r = _get(pixelURL, get={"x": x, "y": y})
+        rtn = True if r.text == "X" else False if r.text == " " else None
+        return rtn
 
-def get_pixel(x: int = 0, y: int = 0) -> bool:
-    r = _get(pixelURL, get={"x": x, "y": y})
-    rtn = True if r.text == "X" else False if r.text == " " else None
-    return rtn
 
+    def get_fonts(self) -> None:
+        r = _get(fontURL)
+        fonts = r.text.split("\n")
+        print(fonts)
 
-def get_fonts() -> None:
-    r = _get(fontURL)
-    fonts = r.text.split("\n")
-    print(fonts)
 
+    def get_mode(self) -> Mode:
+        r = _get(modeURL)
+        return Mode(r.text)
 
-def get_mode() -> Mode:
-    r = _get(modeURL)
-    return Mode(r.text)
 
+    def post_text(self, text: str, x: int = 0, y: int = 0, font: str = "DejaVuSans12") -> Response:
+        return _post(textURL, get={"x": x, "y": y, "font": font}, post=text)
 
-def post_text(text: str, x: int = 0, y: int = 0, font: str = "DejaVuSans12") -> Response:
-    return _post(textURL, get={"x": x, "y": y, "font": font}, post=text)
 
+    def post_frame_raw(self, frame: str) -> Response:
+        return _post(frameURL, post=frame)
 
-def post_frame_raw(frame: str) -> Response:
-    return _post(frameURL, post=frame)
 
+    def post_frame(self, frame: List[List[bool]]) -> Response:
+        data: List[List[str]] = [[" "] * width for _ in range(height)]
+        for x, l in frame:
+            for y, b in l:
+                if b:
+                    try:
+                        data[x, y] = "X"
+                    except IndexError as e:
+                        print(e)
+        return _post(frameURL, post=data)
 
-def post_frame(frame: List[List[bool]]) -> Response:
-    data: List[List[str]] = [[" "] * width for _ in range(height)]
-    for x, l in frame:
-        for y, b in l:
-            if b:
-                try:
-                    data[x, y] = "X"
-                except IndexError as e:
-                    print(e)
-    return _post(frameURL, post=data)
 
+    def set_pixel(self, x: int = 0, y: int = 0) -> Response:
+        return _post(pixelURL, get={"x": x, "y": y})
 
-def set_pixel(x: int = 0, y: int = 0) -> Response:
-    return _post(pixelURL, get={"x": x, "y": y})
 
+    def unset_pixel(self, x: int = 0, y: int = 0) -> Response:
+        return _delete(pixelURL, get={"x": x, "y": y})
 
-def unset_pixel(x: int = 0, y: int = 0) -> Response:
-    return _delete(pixelURL, get={"x": x, "y": y})
 
+    def set_mode(self, mode: Mode = Mode.FULL) -> Response:
+        return _put(modeURL, post=str(mode.value))
 
-def set_mode(mode: Mode = Mode.FULL) -> Response:
-    return _put(modeURL, post=str(mode.value))
 
+    def _delete(self, endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
+        if self.baseURL == None:
+            raise RuntimeError('baseURL is None, call set_url')
+        return requests.delete(url=self.baseURL + endpoint, params=get)
 
-def _delete(endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
-    if baseURL == None:
-        raise RuntimeError('baseURL is None, call set_url')
-    return requests.delete(url=baseURL + endpoint, params=get)
 
+    def _post(self,  endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
+        if self.baseURL == None:
+            raise RuntimeError('baseURL is None, call set_url')
+        return requests.post(url=self.baseURL + endpoint, params=get, data=post)
 
-def _post(endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
-    if baseURL == None:
-        raise RuntimeError('baseURL is None, call set_url')
-    return requests.post(url=baseURL + endpoint, params=get, data=post)
 
+    def _put(self, endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
+        if self.baseURL == None:
+            raise RuntimeError('baseURL is None, call set_url')
+        return requests.put(url=self.baseURL + endpoint, params=get, data=post)
 
-def _put(endpoint: str, get: GetParam = {}, post: PostParam = '') -> Response:
-    if baseURL == None:
-        raise RuntimeError('baseURL is None, call set_url')
-    return requests.put(url=baseURL + endpoint, params=get, data=post)
 
-
-def _get(endpoint: str, get: GetParam = {}) -> Response:
-    if baseURL == None:
-        raise RuntimeError('baseURL is None, call set_url')
-    return requests.get(url=baseURL + endpoint, params=get)
+    def _get(self, endpoint: str, get: GetParam = {}) -> Response:
+        if self.baseURL == None:
+            raise RuntimeError('baseURL is None, call set_url')
+        return requests.get(url=self.baseURL + endpoint, params=get)
 
 
 if __name__ == "__main__":