added a scroll frame function

Author: KS-HTK

src/fluepdot/fluepdot.py

@@ -5,12 +5,16 @@
 from requests import Response
 from enum import Enum
 from typing import Any, Dict, Optional, List
+from time import sleep
 
 """
   Small library to interact with a fluepdot controlled display
   https://fluepdot.readthedocs.io/en/latest/
 
-  it should only be required to change the baseURL
+  Usage:
+    from fluepdot import Fluepdot
+    fd = Fluepdot("http://module.local")
+    fd.post_text("Hello World!")
 
   Currently there is no support for changing the timings.
 """
@@ -38,11 +42,9 @@ def __init__(self, baseURL: str, width: int = 115, height: int = 16):
         self.height = height
         self.fonts: Optional[List[str]] = None
 
-
     def set_url(self, url: str):
         self.baseURL = url
 
-
     def post_time(self) -> None:
         import datetime
         dt: str = ""
@@ -52,14 +54,12 @@ def post_time(self) -> None:
                 dt = ndt
                 self.post_text(dt, x=8, y=1, font="fixed_7x14")
 
-
     def get_size(self) -> (int, int):
         frame = self.get_frame()
         self.width = len(frame[0])
         self.height = len(frame) - 1
         return [self.width, self.height]
 
-
     def get_frame(self) -> List[str]:
         r = self._get(frameURL)
         return r.text.split('\n')
@@ -70,25 +70,56 @@ def get_pixel(self, x: int = 0, y: int = 0) -> bool | None:
         rtn = True if r.text == "X" else False if r.text == " " else None
         return rtn
 
-
     def get_fonts(self) -> None:
         r = self._get(fontURL)
         fonts = r.text.split("\n")
         print(fonts)
 
-
     def get_mode(self) -> Mode:
         r = self._get(modeURL)
         return Mode(r.text)
 
-
     def post_text(self, text: str, x: int = 0, y: int = 0, font: str = "DejaVuSans12") -> Response:
         return self._post(textURL, get={"x": x, "y": y, "font": font}, post=text)
 
-
     def post_frame_raw(self, frame: str) -> Response:
         return self._post(frameURL, post=frame)
 
+    def post_scroll_frame_raw(self, frame: str, loop:bool or int=False, sleep_time:int=1) -> None:
+        """
+        Parameters
+        ----------
+        frame : str
+            A " " and "X" encoded framestring exactly the length of and 16 lines high
+        loop : bool or int, optional
+            if int it will loop the frame with the given number of seperation spaces
+            if bool:
+                True: same as with loop=115
+                False: will scroll the frame from right to left starting at blank and scrolling till blank
+        sleep_time : int, optional
+            The number of seconds to wait between steps, by default 1
+            will be limited by the timing interval of the display
+        """
+        def _extend_frame(line: str) -> str:
+            return line+(" "*loop)+line[0:115]
+        def _pad_frame(line: str) -> str:
+            pad = " "*115
+            return pad+line+pad
+
+        frame = frame.split("\n")
+        length = len(frame[0])+loop if type(loop) == int else len(frame[0])+115
+
+        if type(loop) == int:
+            frame = list(map(_extend_frame, frame))
+        else:
+            frame = list(map(_pad_frame, frame))
+
+        _run_once=True
+        while loop or type(loop)==int or _run_once:
+            _run_once=False
+            for i in range(0, length, 2):
+                self.post_frame_raw("\n".join(l[i:i+115] for l in frame))
+                sleep(sleep_time)
 
     def post_frame(self, frame: List[List[bool]]) -> Response:
         data: List[List[str]] = [[" "] * width for _ in range(height)]
@@ -109,34 +140,30 @@ def set_pixel(self, x: int = 0, y: int = 0) -> Response:
     def unset_pixel(self, x: int = 0, y: int = 0) -> Response:
         return self._delete(pixelURL, get={"x": x, "y": y})
 
-
     def set_mode(self, mode: Mode = Mode.FULL) -> Response:
         return self._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 _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 _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 _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__":
-    pass
+    fd = Fluepdot("http://module.local")
+    fd.post_text("Hello World!")