telegen-iot 0.1.4.dev9__tar.gz

telegen_iot-0.1.4.dev9/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jim Bennett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

telegen_iot-0.1.4.dev9/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include src/TeleGen/static *
+recursive-include src/TeleGen/templates *

telegen_iot-0.1.4.dev9/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: telegen-iot
+Version: 0.1.4.dev9
+Summary: A virtual IoT hardware simulator.
+Home-page: https://github.com/Jeansonnej23/TeleGen
+Author: Jim Bennett
+Maintainer: Jim Bennett
+License: MIT
+Project-URL: Documentation, https://github.com/Jeansonnej23/TeleGen
+Project-URL: Source Code, https://github.com/Jeansonnej23/TeleGen
+Project-URL: Issue Tracker, https://github.com/Jeansonnej23/TeleGen/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: System :: Hardware
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask==3.1.1
+Requires-Dist: Flask-SocketIO==5.5.1
+Dynamic: license-file
+Dynamic: requires-dist
+
+# Telegen-IoT
+
+IoT is great fun, but has a downside - hardware. You need access to a range of devices such as sensors and actuators to build your IoT projects. Sometimes you might have these devices, other times you may not - maybe you are waiting for a delivery, or parts are out of stock, or they are too expensive.
+
+That's where this tool comes in.
+
+## What is Telegen-IoT
+
+Telegen-IoT is a tool that is designed to fake various IoT hardware components, such as LEDs, buttons, temperature sensors and the like, that you can then access from IoT device code running on your computer rather than on an IoT device. It is made of two parts:
+
+* The Telegen-IoT app - this is a web app run locally where you can connect fake sensors and actuators to your virtual hardware
+* Shims - these are libraries that mimic popular hardware APIs so you can take code that runs against well known hardware and run it against the Telegen-IoT app.
+
+## Getting started
+
+* Install the Telegen-IoT app:
+
+    ```sh
+    pip install telegen-iot
+    ```
+
+* Run the app:
+
+    ```sh
+    telegen-iot
+    ```
+
+* The app will launch, listening for web requests on port 5000, and open a web browser for you to start adding virtual sensors and actuators to your project
+
+### Running on a different port
+
+To use a different port than the default 5000, set the `--port` option when you run the app:
+
+```sh
+telegen-iot --port 5050
+```
+
+## Connecting your code
+
+You can connect your device code to Telegen-IoT, using one of the available shims. See the [shim list for more details](https://github.com/Jeansonnej23/TeleGen#shims).

telegen_iot-0.1.4.dev9/README.md

@@ -0,0 +1,40 @@
+# Telegen-IoT
+
+IoT is great fun, but has a downside - hardware. You need access to a range of devices such as sensors and actuators to build your IoT projects. Sometimes you might have these devices, other times you may not - maybe you are waiting for a delivery, or parts are out of stock, or they are too expensive.
+
+That's where this tool comes in.
+
+## What is Telegen-IoT
+
+Telegen-IoT is a tool that is designed to fake various IoT hardware components, such as LEDs, buttons, temperature sensors and the like, that you can then access from IoT device code running on your computer rather than on an IoT device. It is made of two parts:
+
+* The Telegen-IoT app - this is a web app run locally where you can connect fake sensors and actuators to your virtual hardware
+* Shims - these are libraries that mimic popular hardware APIs so you can take code that runs against well known hardware and run it against the Telegen-IoT app.
+
+## Getting started
+
+* Install the Telegen-IoT app:
+
+    ```sh
+    pip install telegen-iot
+    ```
+
+* Run the app:
+
+    ```sh
+    telegen-iot
+    ```
+
+* The app will launch, listening for web requests on port 5000, and open a web browser for you to start adding virtual sensors and actuators to your project
+
+### Running on a different port
+
+To use a different port than the default 5000, set the `--port` option when you run the app:
+
+```sh
+telegen-iot --port 5050
+```
+
+## Connecting your code
+
+You can connect your device code to Telegen-IoT, using one of the available shims. See the [shim list for more details](https://github.com/Jeansonnej23/TeleGen#shims).

telegen_iot-0.1.4.dev9/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=65", "wheel"]
+build-backend = "setuptools.build_meta"

telegen_iot-0.1.4.dev9/setup.cfg

@@ -0,0 +1,51 @@
+[metadata]
+name = telegen-iot
+version = attr: TeleGen.__version__
+url = https://github.com/Jeansonnej23/TeleGen
+project_urls = 
+	Documentation = https://github.com/Jeansonnej23/TeleGen
+	Source Code = https://github.com/Jeansonnej23/TeleGen
+	Issue Tracker = https://github.com/Jeansonnej23/TeleGen/issues
+license = MIT
+author = Jim Bennett
+maintainer = Jim Bennett
+description = A virtual IoT hardware simulator.
+long_description = file: README.md
+long_description_content_type = text/markdown
+classifiers = 
+	Development Status :: 2 - Pre-Alpha
+	Intended Audience :: Developers
+	Topic :: System :: Hardware
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
+	Programming Language :: Python :: 3.14
+
+[options]
+packages = find:
+package_dir = = src
+include_package_data = true
+python_requires = >= 3.9
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts = 
+	telegen-iot = TeleGen.telegen:main
+
+[tool:pytest]
+testpaths = 
+	src/tests
+pythonpath = 
+	src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

telegen_iot-0.1.4.dev9/setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup
+
+setup(
+    name='telegen-iot',
+    install_requires=[
+        "Flask==3.1.1",
+        "Flask-SocketIO==5.5.1"
+    ],
+    tests_require=['pytest==7.2.2'],
+    test_suite='tests',
+)

telegen_iot-0.1.4.dev9/src/TeleGen/__init__.py

@@ -0,0 +1,9 @@
+# pylint: disable=C0103
+
+from TeleGen.sensors import *
+from TeleGen.serial_sensors import *
+from TeleGen.binary_sensors import *
+from TeleGen.i2c_sensors import *
+from TeleGen.actuators import *
+
+__version__ = "0.1.4.dev09"

telegen_iot-0.1.4.dev9/src/TeleGen/actuators.py

@@ -0,0 +1,102 @@
+from abc import ABC, abstractmethod
+from enum import Enum
+
+
+class ActuatorType(Enum):
+    FLOAT = 1
+    BOOLEAN = 2
+
+
+class ActuatorBase(ABC):
+    def __init__(self, port: str):
+        self.__port = port
+
+    @staticmethod
+    @abstractmethod
+    def actuator_name() -> str:
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def actuator_type() -> ActuatorType:
+        pass
+
+    @property
+    def port(self) -> str:
+        return self.__port
+
+    @property
+    # pylint: disable=invalid-name
+    def id(self) -> str:
+        return self.__port
+
+
+class FloatActuatorBase(ActuatorBase):
+    def __init__(self, port: str):
+        super().__init__(port)
+        self.__value = 0
+
+    @staticmethod
+    @abstractmethod
+    def actuator_name() -> str:
+        pass
+
+    @staticmethod
+    def actuator_type() -> ActuatorType:
+        return ActuatorType.FLOAT
+
+    @property
+    def value(self) -> float:
+        return self.__value
+
+    @value.setter
+    def value(self, val: float):
+        self.__value = val
+
+
+class BooleanActuatorBase(ActuatorBase):
+    def __init__(self, port: str):
+        super().__init__(port)
+
+        self.__value = False
+
+    @staticmethod
+    @abstractmethod
+    def actuator_name() -> str:
+        pass
+
+    @staticmethod
+    def actuator_type() -> ActuatorType:
+        return ActuatorType.BOOLEAN
+
+    @property
+    def value(self) -> bool:
+        return self.__value
+
+    @value.setter
+    def value(self, val: bool):
+        self.__value = val
+
+
+class RelayActuator(BooleanActuatorBase):
+    @staticmethod
+    def actuator_name() -> str:
+        return "Relay"
+
+
+class LedActuator(BooleanActuatorBase):
+    def __init__(self, port: str):
+        super().__init__(port)
+        self.__color = "#FF0000"
+
+    @staticmethod
+    def actuator_name() -> str:
+        return "LED"
+
+    @property
+    def color(self) -> str:
+        return self.__color
+
+    @color.setter
+    def color(self, val: str):
+        self.__color = val

telegen_iot-0.1.4.dev9/src/TeleGen/binary_sensors.py

@@ -0,0 +1,75 @@
+from abc import abstractmethod
+from enum import Enum
+import io
+
+from TeleGen.sensors import SensorBase, SensorType
+
+
+class BinarySensorBase(SensorBase):
+    def __init__(self, name: str):
+        super().__init__(name)
+        self.__value = io.BytesIO()
+        self._next_repeat_time = None
+        self._value_position = 0
+
+    @staticmethod
+    def sensor_type() -> SensorType:
+        return SensorType.BINARY
+
+    @staticmethod
+    @abstractmethod
+    def sensor_name() -> str:
+        pass
+
+    @property
+    def id(self) -> str:
+        return self.port.replace("/", "").replace(" ", "")
+
+    @property
+    def value(self) -> io.BytesIO:
+        return self.__value
+
+    @value.setter
+    def value(self, val: io.BytesIO):
+        self.__value = val
+
+
+class CameraImageSource(Enum):
+    FILE = 1
+    WEBCAM = 2
+
+
+class CameraSensor(BinarySensorBase):
+    def __init__(self, name: str):
+        super().__init__(name)
+        self.__image_source = CameraImageSource.FILE
+        self.__image_file_name = ""
+        self.__web_cam_device_id = ""
+
+    @staticmethod
+    def sensor_name() -> str:
+        return "Camera"
+
+    @property
+    def image_source(self) -> CameraImageSource:
+        return self.__image_source
+
+    @image_source.setter
+    def image_source(self, val: CameraImageSource):
+        self.__image_source = val
+
+    @property
+    def image_file_name(self) -> str:
+        return self.__image_file_name
+
+    @image_file_name.setter
+    def image_file_name(self, val: str):
+        self.__image_file_name = val
+
+    @property
+    def web_cam_device_id(self) -> str:
+        return self.__web_cam_device_id
+
+    @web_cam_device_id.setter
+    def web_cam_device_id(self, val: str):
+        self.__web_cam_device_id = val

telegen_iot-0.1.4.dev9/src/TeleGen/i2c_sensors.py

@@ -0,0 +1,199 @@
+from abc import abstractmethod
+from enum import Enum
+from typing import List
+import random
+
+from TeleGen.sensors import SensorBase, SensorType
+
+
+class I2CSensorBase(SensorBase):
+    @staticmethod
+    def sensor_type() -> SensorType:
+        return SensorType.I2C
+
+    @staticmethod
+    @abstractmethod
+    def sensor_unit_type() -> SensorType:
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def sensor_name() -> str:
+        pass
+
+    @property
+    def id(self) -> str:
+        return self.port
+
+    @property
+    def address(self) -> str:
+        return f"0x{int(self.port):02x}"
+
+
+class FloatI2CSensorBase(I2CSensorBase):
+    def __init__(self, port: str, valid_min: float, valid_max: float):
+        super().__init__(port)
+
+        self.__valid_min = valid_min
+        self.__valid_max = valid_max
+        self.value = valid_min
+        self.random_min = float(valid_min)
+        self.random_max = float(valid_max)
+
+    @staticmethod
+    @abstractmethod
+    def sensor_name() -> str:
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def sensor_units() -> List[str]:
+        pass
+
+    @staticmethod
+    def sensor_unit_type() -> SensorType:
+        return SensorType.FLOAT
+
+    @property
+    @abstractmethod
+    def unit(self) -> str:
+        pass
+
+    @property
+    def value(self) -> float:
+        if self._random:
+            return round(random.uniform(self.__random_min, self.__random_max), 2)
+
+        return self.__value
+
+    @value.setter
+    def value(self, val: float):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__value = val
+
+    @property
+    def random_min(self) -> float:
+        return self.__random_min
+
+    @random_min.setter
+    def random_min(self, val: float):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__random_min = val
+
+    @property
+    def random_max(self) -> float:
+        return self.__random_max
+
+    @random_max.setter
+    def random_max(self, val: float):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__random_max = val
+
+    @property
+    def valid_min(self) -> float:
+        return self.__valid_min
+
+    @property
+    def valid_max(self) -> float:
+        return self.__valid_max
+
+
+class IntegerI2CSensorBase(I2CSensorBase):
+    def __init__(self, port: str, valid_min: int, valid_max: int):
+        super().__init__(port)
+
+        self.__valid_min = valid_min
+        self.__valid_max = valid_max
+        self.value = valid_min
+        self.random_min = int(valid_min)
+        self.random_max = int(valid_max)
+
+    @staticmethod
+    @abstractmethod
+    def sensor_name() -> str:
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def sensor_units() -> List[str]:
+        pass
+
+    @staticmethod
+    def sensor_unit_type() -> SensorType:
+        return SensorType.INTEGER
+
+    @property
+    @abstractmethod
+    def unit(self) -> str:
+        pass
+
+    @property
+    def value(self) -> int:
+        if self._random:
+            return random.randint(self.__random_min, self.__random_max)
+
+        return self.__value
+
+    @value.setter
+    def value(self, val: int):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__value = val
+
+    @property
+    def random_min(self) -> int:
+        return self.__random_min
+
+    @random_min.setter
+    def random_min(self, val: int):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__random_min = val
+
+    @property
+    def random_max(self) -> int:
+        return self.__random_max
+
+    @random_max.setter
+    def random_max(self, val: int):
+        if val < self.__valid_min or val > self.__valid_max:
+            raise ValueError()
+        self.__random_max = val
+
+    @property
+    def valid_min(self) -> int:
+        return self.__valid_min
+
+    @property
+    def valid_max(self) -> int:
+        return self.__valid_max
+
+
+# pylint: disable=C0103
+class DistanceUnit(Enum):
+    Millimeter = 1
+
+
+class DistanceSensor(IntegerI2CSensorBase):
+    def __init__(self, port: str, unit):
+        if isinstance(unit, str):
+            unit = DistanceUnit[unit]
+
+        self.__unit = unit
+
+        super().__init__(port, 0, 999999)
+
+    @staticmethod
+    def sensor_name() -> str:
+        return "Distance"
+
+    @property
+    def unit(self) -> str:
+        return self.__unit.name
+
+    @staticmethod
+    def sensor_units() -> List[str]:
+        return [DistanceUnit.Millimeter.name]