[ { "path": ".devcontainer/Dockerfile", "content": "# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.236.0/containers/python-3/.devcontainer/base.Dockerfile\n\n# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster\nARG VARIANT=\"3.10-bullseye\"\nFROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}\n\n# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10\nARG NODE_VERSION=\"none\"\nRUN if [ \"${NODE_VERSION}\" != \"none\" ]; then su vscode -c \"umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1\"; fi\n\n# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.\n# COPY requirements.txt /tmp/pip-tmp/\n# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \\\n# && rm -rf /tmp/pip-tmp\n\n# [Optional] Uncomment this section to install additional OS packages.\n# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \\\n# && apt-get -y install --no-install-recommends \n\n# [Optional] Uncomment this line to install global node packages.\n# RUN su vscode -c \"source /usr/local/share/nvm/nvm.sh && npm install -g \" 2>&1" }, { "path": ".devcontainer/devcontainer.json", "content": "// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:\n// https://github.com/microsoft/vscode-dev-containers/tree/v0.236.0/containers/python-3\n{\n\t\"name\": \"Python 3\",\n\t\"build\": {\n\t\t\"dockerfile\": \"Dockerfile\",\n\t\t\"context\": \"..\",\n\t\t\"args\": { \n\t\t\t// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6\n\t\t\t// Append -bullseye or -buster to pin to an OS version.\n\t\t\t// Use -bullseye variants on local on arm64/Apple Silicon.\n\t\t\t\"VARIANT\": \"3.10-bullseye\",\n\t\t\t// Options\n\t\t\t\"NODE_VERSION\": \"none\"\n\t\t}\n\t},\n\n\t// Configure tool-specific properties.\n\t\"customizations\": {\n\t\t// Configure properties specific to VS Code.\n\t\t\"vscode\": {\n\t\t\t// Set *default* container specific settings.json values on container create.\n\t\t\t\"settings\": { \n\t\t\t\t\"python.defaultInterpreterPath\": \"/usr/local/bin/python\",\n\t\t\t\t\"python.linting.enabled\": true,\n\t\t\t\t\"python.linting.pylintEnabled\": true,\n\t\t\t\t\"python.formatting.autopep8Path\": \"/usr/local/py-utils/bin/autopep8\",\n\t\t\t\t\"python.formatting.blackPath\": \"/usr/local/py-utils/bin/black\",\n\t\t\t\t\"python.formatting.yapfPath\": \"/usr/local/py-utils/bin/yapf\",\n\t\t\t\t\"python.linting.banditPath\": \"/usr/local/py-utils/bin/bandit\",\n\t\t\t\t\"python.linting.flake8Path\": \"/usr/local/py-utils/bin/flake8\",\n\t\t\t\t\"python.linting.mypyPath\": \"/usr/local/py-utils/bin/mypy\",\n\t\t\t\t\"python.linting.pycodestylePath\": \"/usr/local/py-utils/bin/pycodestyle\",\n\t\t\t\t\"python.linting.pydocstylePath\": \"/usr/local/py-utils/bin/pydocstyle\",\n\t\t\t\t\"python.linting.pylintPath\": \"/usr/local/py-utils/bin/pylint\"\n\t\t\t},\n\t\t\t\n\t\t\t// Add the IDs of extensions you want installed when the container is created.\n\t\t\t\"extensions\": [\n\t\t\t\t\"ms-python.python\",\n\t\t\t\t\"ms-python.vscode-pylance\",\n\t\t\t\t\"github.copilot\"\n\t\t\t]\n\t\t}\n\t},\n\n\t// Use 'forwardPorts' to make a list of ports inside the container available locally.\n\t// \"forwardPorts\": [],\n\n\t// Use 'postCreateCommand' to run commands after the container is created.\n\t\"postCreateCommand\": \"pip3 install --user -r requirements.txt\",\n\n\t// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.\n\t\"remoteUser\": \"vscode\"\n}\n" }, { "path": ".gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\npip-wheel-metadata/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n.python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n\n.vscode\n.DS_Store\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2021 Jim Bennett\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# CounterFit\n\n[![GitHub license](https://img.shields.io/github/license/CounterFit-IoT/CounterFit.svg)](https://github.com/CounterFit-IoT/CounterFit/blob/master/LICENSE)\n[![GitHub contributors](https://img.shields.io/github/contributors/CounterFit-IoT/CounterFit.svg)](https://GitHub.com/CounterFit-IoT/CounterFit/graphs/contributors/)\n[![GitHub issues](https://img.shields.io/github/issues/CounterFit-IoT/CounterFit.svg)](https://GitHub.com/CounterFit-IoT/CounterFit/issues/)\n[![GitHub pull-requests](https://img.shields.io/github/issues-pr/CounterFit-IoT/CounterFit.svg)](https://GitHub.com/CounterFit-IoT/CounterFit/pull/)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\n[![GitHub watchers](https://img.shields.io/github/watchers/CounterFit-IoT/CounterFit.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/CounterFit-IoT/CounterFit/watchers/)\n[![GitHub forks](https://img.shields.io/github/forks/CounterFit-IoT/CounterFit.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/CounterFit-IoT/CounterFit/network/)\n[![GitHub stars](https://img.shields.io/github/stars/CounterFit-IoT/CounterFit.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/CounterFit-IoT/CounterFit/stargazers/)\n\n![The CounterFit logo](./images/CounterFitLogo.png)\n\nIoT 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.\n\nThat's where this tool comes in.\n\n## What is CounterFit\n\nCounterFit 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:\n\n* The CounterFit app - this is a web app run locally where you can connect fake sensors and actuators to your virtual hardware\n* Shims - these are libraries that fake popular hardware APIs so you can take code that runs against well known hardware and run it against the CounterFit app.\n\n**This project is under construction**\n\nThis project is seriously under construction! Please let me know if you want to help.\n\n![Under development animated GIF](https://media.giphy.com/media/3o7qE1YN7aBOFPRw8E/giphy.gif)\n\n## Installing and running the app\n\n* Install the CounterFit app:\n\n ```sh\n pip install CounterFit\n ```\n\n* Run the app:\n\n ```sh\n counterfit\n ```\n\n* 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\n\n### Running on a different port\n\nTo use a different port than the default 5000, set the `--port` option when you run the app:\n\n```sh\ncounterfit --port 5050\n```\n\n## Shims\n\nThe shims are designed to mimic the APIs for popular hardware components. The idea being you should be able to take code built against the shim and eventually run it on real hardware by changing the name of the package that is imported.\n\n### Available shims\n\n* ![Seeed Grove Py Shim](https://img.shields.io/badge/Platform-Python-green) [![Seeed Grove Py Shim](https://img.shields.io/badge/Shim-Grove.py-yellow)](./shims/SeeedStudios/grove/README.md) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-grove)](https://pypi.org/project/counterfit-shims-grove) [Grove.Py](https://github.com/Seeed-Studio/grove.py) shims that work with the [Seeed Grove ecosystem](https://www.seeedstudio.com/category/Grove-c-1003.html).\n\n* ![Seeed Grove DHT Shim](https://img.shields.io/badge/Platform-Python-green) [![Seeed DHT Shim](https://img.shields.io/badge/Shim-Seeed_DHT-yellow)](./shims/SeeedStudios/grove/README.md) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-seeed-python-dht)](https://pypi.org/project/counterfit-shims-seeed-python-dht) [Seeed DHT](https://github.com/Seeed-Studio/Seeed_Python_DHT) shims that work with the [Seeed DHT sensors](https://www.seeedstudio.com/Grove-Temperature-Humidity-Sensor-DHT11.html).\n\n## Samples\n\nCheck out the [samples](./samples) directory for a range of samples.\n" }, { "path": "counterfit-app/.pylintrc", "content": "[FORMAT]\n\n# Maximum number of characters on a single line.\nmax-line-length=140\n\n[DESIGN]\n\n# Maximum number of attributes for a class (see R0902).\nmax-attributes=13\n\n[MESSAGES CONTROL]\ndisable=trailing-whitespace,R0801,C0114,C0115,C0116" }, { "path": "counterfit-app/LICENSE", "content": "MIT License\n\nCopyright (c) 2021 Jim Bennett\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "counterfit-app/MANIFEST.in", "content": "include src/CounterFit/static/*.*\ninclude src/CounterFit/static/images/*.*\ninclude src/CounterFit/templates/*.*" }, { "path": "counterfit-app/README.md", "content": "# CounterFit\n\nIoT 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.\n\nThat's where this tool comes in.\n\n## What is CounterFit\n\nCounterFit 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:\n\n* The CounterFit app - this is a web app run locally where you can connect fake sensors and actuators to your virtual hardware\n* 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 CounterFit app.\n\n## Getting started\n\n* Install the CounterFit app:\n\n ```sh\n pip install CounterFit\n ```\n\n* Run the app:\n\n ```sh\n CounterFit\n ```\n\n* 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\n\n### Running on a different port\n\nTo use a different port than the default 5000, set the `--port` option when you run the app:\n\n```sh\nCounterFit --port 5050\n```\n\n## Connecting your code\n\nYou can connect your device code to CounterFit, using one of the available shims. See the [shim list for more details](https://github.com/CounterFit-IoT/CounterFit#shims).\n" }, { "path": "counterfit-app/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "counterfit-app/requirements.txt", "content": "flask=2.1.2\nflask-socketio=5.2.0\neventlet=0.33.3\nsetuptools=65.5.0\ntwine=4.0.2\nwheel=0.38.4\npytest=7.2.2\npytest-runner=6.0.0" }, { "path": "counterfit-app/setup.cfg", "content": "[metadata]\nname = CounterFit\nversion = attr: CounterFit.__version__\nurl = https://github.com/CounterFit-IoT/CounterFit\nproject_urls =\n Documentation = https://github.com/CounterFit-IoT/CounterFit\n Source Code = https://github.com/CounterFit-IoT/CounterFit\n Issue Tracker = https://github.com/CounterFit-IoT/CounterFit/issues\n Twitter = https://twitter.com/JimBobBennett\nlicense = MIT\nauthor = Jim Bennett\nmaintainer = Jim Bennett\ndescription = A virtual IoT hardware simulator.\nlong_description = file: README.md\nlong_description_content_type = text/markdown\nclassifiers =\n Development Status :: 2 - Pre-Alpha\n Intended Audience :: Developers\n Topic :: System :: Hardware\n License :: OSI Approved :: MIT License\n Operating System :: OS Independent\n Programming Language :: Python\n\n[options]\npackages = find:\npackage_dir = = src\ninclude_package_data = true\npython_requires = >= 3.8\n# Dependencies are in setup.py for GitHub's dependency graph.\n\n[options.packages.find]\nwhere = src\n\n[options.entry_points]\nconsole_scripts =\n counterfit = CounterFit.counterfit:main\n\n[tool:pytest]\ntestpaths =\n src/tests" }, { "path": "counterfit-app/setup.py", "content": "from setuptools import setup\n\nsetup(\n name='CounterFit',\n install_requires=[\n \"Flask==2.1.2\",\n \"Flask-SocketIO==5.2.0\",\n \"eventlet==0.33.3\"\n ],\n tests_require=['pytest==7.2.2'],\n test_suite='tests',\n)\n" }, { "path": "counterfit-app/src/CounterFit/__init__.py", "content": "# pylint: disable=C0103\n\nfrom CounterFit.sensors import *\nfrom CounterFit.serial_sensors import *\nfrom CounterFit.binary_sensors import *\nfrom CounterFit.i2c_sensors import *\nfrom CounterFit.actuators import *\n\n__version__ = \"0.1.4.dev09\"\n" }, { "path": "counterfit-app/src/CounterFit/actuators.py", "content": "from abc import ABC, abstractmethod\nfrom enum import Enum\n\n\nclass ActuatorType(Enum):\n FLOAT = 1\n BOOLEAN = 2\n\n\nclass ActuatorBase(ABC):\n def __init__(self, port: str):\n self.__port = port\n\n @staticmethod\n @abstractmethod\n def actuator_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def actuator_type() -> ActuatorType:\n pass\n\n @property\n def port(self) -> str:\n return self.__port\n\n @property\n # pylint: disable=invalid-name\n def id(self) -> str:\n return self.__port\n\n\nclass FloatActuatorBase(ActuatorBase):\n def __init__(self, port: str):\n super().__init__(port)\n self.__value = 0\n\n @staticmethod\n @abstractmethod\n def actuator_name() -> str:\n pass\n\n @staticmethod\n def actuator_type() -> ActuatorType:\n return ActuatorType.FLOAT\n\n @property\n def value(self) -> float:\n return self.__value\n\n @value.setter\n def value(self, val: float):\n self.__value = val\n\n\nclass BooleanActuatorBase(ActuatorBase):\n def __init__(self, port: str):\n super().__init__(port)\n\n self.__value = False\n\n @staticmethod\n @abstractmethod\n def actuator_name() -> str:\n pass\n\n @staticmethod\n def actuator_type() -> ActuatorType:\n return ActuatorType.BOOLEAN\n\n @property\n def value(self) -> bool:\n return self.__value\n\n @value.setter\n def value(self, val: bool):\n self.__value = val\n\n\nclass RelayActuator(BooleanActuatorBase):\n @staticmethod\n def actuator_name() -> str:\n return \"Relay\"\n\n\nclass LedActuator(BooleanActuatorBase):\n def __init__(self, port: str):\n super().__init__(port)\n self.__color = \"#FF0000\"\n\n @staticmethod\n def actuator_name() -> str:\n return \"LED\"\n\n @property\n def color(self) -> str:\n return self.__color\n\n @color.setter\n def color(self, val: str):\n self.__color = val\n" }, { "path": "counterfit-app/src/CounterFit/binary_sensors.py", "content": "from abc import abstractmethod\nfrom enum import Enum\nimport io\n\nfrom CounterFit.sensors import SensorBase, SensorType\n\n\nclass BinarySensorBase(SensorBase):\n def __init__(self, name: str):\n super().__init__(name)\n self.__value = io.BytesIO()\n self._next_repeat_time = None\n self._value_position = 0\n\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.BINARY\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @property\n def id(self) -> str:\n return self.port.replace(\"/\", \"\").replace(\" \", \"\")\n\n @property\n def value(self) -> io.BytesIO:\n return self.__value\n\n @value.setter\n def value(self, val: io.BytesIO):\n self.__value = val\n\n\nclass CameraImageSource(Enum):\n FILE = 1\n WEBCAM = 2\n\n\nclass CameraSensor(BinarySensorBase):\n def __init__(self, name: str):\n super().__init__(name)\n self.__image_source = CameraImageSource.FILE\n self.__image_file_name = \"\"\n self.__web_cam_device_id = \"\"\n\n @staticmethod\n def sensor_name() -> str:\n return \"Camera\"\n\n @property\n def image_source(self) -> CameraImageSource:\n return self.__image_source\n\n @image_source.setter\n def image_source(self, val: CameraImageSource):\n self.__image_source = val\n\n @property\n def image_file_name(self) -> str:\n return self.__image_file_name\n\n @image_file_name.setter\n def image_file_name(self, val: str):\n self.__image_file_name = val\n\n @property\n def web_cam_device_id(self) -> str:\n return self.__web_cam_device_id\n\n @web_cam_device_id.setter\n def web_cam_device_id(self, val: str):\n self.__web_cam_device_id = val\n" }, { "path": "counterfit-app/src/CounterFit/counterfit.py", "content": "# pylint: disable=C0103,E0401,W0603\n\nimport argparse\nimport io\nimport json\nimport uuid\nimport webbrowser\nfrom base64 import b64decode, b64encode\nfrom threading import Timer\n\nfrom eventlet import event\nfrom eventlet.timeout import Timeout\n\nfrom flask import Flask, request, render_template\nfrom flask_socketio import SocketIO\n\nfrom CounterFit.sensors import SensorBase, SensorType\nfrom CounterFit.serial_sensors import GPSSensor, GPSValueType, SerialSensorBase\nfrom CounterFit.binary_sensors import BinarySensorBase, CameraImageSource, CameraSensor\nfrom CounterFit.actuators import ActuatorBase\n\napp = Flask(__name__)\napp.config[\"SECRET_KEY\"] = \"247783f3-bdda-4536-bffc-109e2464f10b\"\nsocketio = SocketIO(app)\n\nsensor_cache = {}\nactuator_cache = {}\n\nall_sensors = []\nall_actuators = []\n\nis_connected = False\n\n\ndef get_all_subclasses(cls, class_list):\n for sub_class in cls.__subclasses__():\n if len(sub_class.__abstractmethods__) == 0:\n class_list.append(sub_class)\n\n get_all_subclasses(sub_class, class_list)\n\n\nget_all_subclasses(SensorBase, all_sensors)\nget_all_subclasses(ActuatorBase, all_actuators)\n\nall_sensors = sorted(all_sensors, key=lambda s: s.sensor_name())\nall_actuators = sorted(all_actuators, key=lambda a: a.actuator_name())\n\n\n@app.route(\"/\", methods=[\"GET\"])\ndef home():\n ports = []\n ports_and__hex = []\n for port in range(0, 127):\n str_port = str(port)\n if str_port not in sensor_cache and str_port not in actuator_cache:\n ports.append(str_port)\n ports_and__hex.append((str_port, f\"0x{port:02x}\"))\n\n return render_template(\n \"home.html\",\n sensors=sensor_cache.values(),\n actuators=actuator_cache.values(),\n all_sensors=all_sensors,\n all_actuators=all_actuators,\n is_connected=is_connected,\n ports=ports,\n ports_and__hex=ports_and__hex,\n )\n\n\ndef set_and_send_connected(connected: bool = True) -> None:\n global is_connected\n is_connected = connected\n socketio.emit(\"device_connect\", {\"connected\": is_connected})\n\n\n@app.route(\"/connect\", methods=[\"POST\"])\ndef device_connect():\n set_and_send_connected()\n\n return \"OK\", 200\n\n\n@app.route(\"/disconnect\", methods=[\"POST\"])\ndef device_disconnect():\n set_and_send_connected(False)\n\n return \"OK\", 200\n\n\ndef create_pin_sensor(sensor, body):\n port = str(body[\"pin\"])\n unit = body[\"unit\"]\n\n if sensor.sensor_type() == SensorType.FLOAT:\n new_sensor = sensor(port, unit)\n elif sensor.sensor_type() == SensorType.INTEGER:\n new_sensor = sensor(port, unit)\n else:\n new_sensor = sensor(port)\n\n sensor_cache[port.lower()] = new_sensor\n\n\ndef create_serial_sensor(sensor, body):\n port = body[\"port\"]\n new_sensor = sensor(port)\n sensor_cache[port.lower()] = new_sensor\n\n\ndef create_binary_sensor(sensor, body):\n name = body[\"name\"]\n new_sensor = sensor(name)\n sensor_cache[name.lower()] = new_sensor\n\n\ndef create_i2c_sensor(sensor, body):\n port = str(body[\"i2c_pin\"])\n unit = body[\"i2c_unit\"]\n new_sensor = sensor(port, unit)\n sensor_cache[port.lower()] = new_sensor\n\n\n@app.route(\"/create_sensor\", methods=[\"POST\"])\ndef create_sensor():\n body = request.get_json()\n\n print(\"Create sensor called:\", body)\n\n sensor_type = body[\"type\"]\n\n for sensor in all_sensors:\n if sensor.sensor_name() == sensor_type:\n if sensor.sensor_type() == SensorType.SERIAL:\n create_serial_sensor(sensor, body)\n elif sensor.sensor_type() == SensorType.BINARY:\n create_binary_sensor(sensor, body)\n elif sensor.sensor_type() == SensorType.I2C:\n create_i2c_sensor(sensor, body)\n else:\n create_pin_sensor(sensor, body)\n\n return \"OK\", 200\n\n\n@app.route(\"/create_actuator\", methods=[\"POST\"])\ndef create_actuator():\n body = request.get_json()\n\n print(\"Create actuator called:\", body)\n\n actuator_type = body[\"type\"]\n port = str(body[\"port\"])\n\n for actuator in all_actuators:\n if actuator.actuator_name() == actuator_type:\n new_actuator = actuator(port)\n\n actuator_cache[port.lower()] = new_actuator\n\n return \"OK\", 200\n\n\n@app.route(\"/sensor_value\", methods=[\"GET\"])\ndef get_sensor_value():\n set_and_send_connected()\n port = str(request.args.get(\"port\", \"\"))\n if port.lower() in sensor_cache:\n sensor = sensor_cache[port.lower()]\n\n response = {\"value\": sensor.value}\n print(\"Returning sensor value\", response, \"for port\", port)\n\n return json.dumps(response)\n\n return \"Sensor with port \" + str(port) + \" not found\", 404\n\n\n@app.route(\"/serial_sensor_character\", methods=[\"GET\"])\ndef get_serial_sensor_character():\n set_and_send_connected()\n port = str(request.args.get(\"port\", \"\"))\n if port.lower() in sensor_cache:\n sensor: SerialSensorBase = sensor_cache[port.lower()]\n\n response = {\"value\": sensor.read()}\n print(\"Returning sensor value\", response, \"for port\", port)\n\n return json.dumps(response)\n\n return \"Sensor with port \" + str(port) + \" not found\", 404\n\n\n@app.route(\"/serial_sensor_line\", methods=[\"GET\"])\ndef get_serial_sensor_line():\n set_and_send_connected()\n port = str(request.args.get(\"port\", \"\"))\n if port.lower() in sensor_cache:\n sensor: SerialSensorBase = sensor_cache[port.lower()]\n\n response = {\"value\": sensor.read_line()}\n print(\"Returning sensor value\", response, \"for port\", port)\n\n return json.dumps(response)\n\n return \"Sensor with port \" + str(port) + \" not found\", 404\n\n\nevents = {}\n\n\ndef capture_camera_image_response(data):\n try:\n e = events[data[\"uuid\"]]\n port = data[\"port\"]\n\n image: str = data[\"image_base64\"]\n image = image.replace(\"data:image/jpeg;base64,\", \"\").strip()\n camera_sensor: CameraSensor = sensor_cache[port.lower()]\n msg = b64decode(image)\n camera_sensor.value = io.BytesIO(msg)\n\n e.send(data)\n del events[data[\"uuid\"]]\n except KeyError:\n pass\n\n\ndef capture_camera_image(sensor: CameraSensor, port) -> bool:\n if sensor.image_source == CameraImageSource.WEBCAM:\n u = str(uuid.uuid4())\n\n req = {\"uuid\": u, \"port\": port}\n\n socketio.emit(\n \"capture_camera_from_webcam\" + str(port).replace(\"/\", \"\").replace(\" \", \"\"),\n req,\n callback=capture_camera_image_response,\n )\n\n timeout = Timeout(10)\n try:\n e = events[u] = event.Event()\n e.wait(10)\n except Timeout:\n return False\n finally:\n events.pop(u, None)\n timeout.cancel()\n\n return True\n\n\n@app.route(\"/binary_sensor_data\", methods=[\"GET\"])\ndef get_binary_sensor_data():\n set_and_send_connected()\n port = str(request.args.get(\"port\", \"\"))\n if port.lower() in sensor_cache:\n if isinstance(sensor_cache[port.lower()], CameraSensor):\n camera_sensor: CameraSensor = sensor_cache[port.lower()]\n if not capture_camera_image(camera_sensor, port):\n return (\n \"Timeout capturing camera image from webcam for camera \"\n + str(port),\n 504,\n )\n\n sensor: BinarySensorBase = sensor_cache[port.lower()]\n\n sensor.value.seek(0)\n img_byte = sensor.value.getvalue()\n\n response = {\"value\": b64encode(img_byte).decode()}\n print(\"Returning sensor value\", str(response)[0:500], \"for port\", port)\n\n return json.dumps(response)\n\n return \"Sensor with port \" + str(port) + \" not found\", 404\n\n\n@app.route(\"/delete_sensor\", methods=[\"POST\"])\ndef delete_sensor():\n body = request.get_json()\n\n print(\"Delete sensor called:\", body)\n\n port = body[\"port\"]\n\n if port.lower() in sensor_cache:\n del sensor_cache[port.lower()]\n\n return \"OK\", 200\n\n\n@app.route(\"/delete_actuator\", methods=[\"POST\"])\ndef delete_actuator():\n body = request.get_json()\n\n print(\"Delete actuator called:\", body)\n\n port = body[\"port\"]\n\n if port.lower() in actuator_cache:\n del actuator_cache[port.lower()]\n\n return \"OK\", 200\n\n\n@app.route(\"/float_sensor_settings\", methods=[\"POST\"])\ndef set_float_sensor_settings():\n body = request.get_json()\n\n print(\"Float sensor settings called:\", body)\n\n port = body[\"port\"]\n value = body[\"value\"]\n is_random = body[\"is_random\"]\n random_min = body[\"random_min\"]\n random_max = body[\"random_max\"]\n\n if port.lower() in sensor_cache:\n sensor = sensor_cache[port.lower()]\n sensor.value = value\n sensor.random = is_random\n sensor.random_min = random_min\n sensor.random_max = random_max\n\n return \"OK\", 200\n\n\n@app.route(\"/integer_sensor_settings\", methods=[\"POST\"])\ndef set_integer_sensor_settings():\n body = request.get_json()\n\n print(\"Integer sensor settings called:\", body)\n\n port = body[\"port\"]\n value = body[\"value\"]\n is_random = body[\"is_random\"]\n random_min = body[\"random_min\"]\n random_max = body[\"random_max\"]\n\n if port.lower() in sensor_cache:\n sensor = sensor_cache[port.lower()]\n sensor.value = value\n sensor.random = is_random\n sensor.random_min = random_min\n sensor.random_max = random_max\n\n return \"OK\", 200\n\n\n@app.route(\"/led_actuator_settings\", methods=[\"POST\"])\ndef set_led_actuator_settings():\n body = request.get_json()\n\n print(\"LED actuator settings called:\", body)\n\n port = body[\"port\"]\n color = body[\"color\"]\n\n if port.lower() in actuator_cache:\n actuator = actuator_cache[port.lower()]\n actuator.color = color\n\n return \"OK\", 200\n\n\n@app.route(\"/boolean_sensor_settings\", methods=[\"POST\"])\ndef set_boolean_sensor_settings():\n body = request.get_json()\n\n print(\"Boolean sensor settings called:\", body)\n\n port = body[\"port\"]\n value = body[\"value\"]\n is_random = body[\"is_random\"]\n\n if port.lower() in sensor_cache:\n sensor = sensor_cache[port.lower()]\n sensor.value = value\n sensor.random = is_random\n\n return \"OK\", 200\n\n\n@app.route(\"/gps_sensor_settings\", methods=[\"POST\"])\ndef set_gps_sensor_settings():\n body = request.get_json()\n\n print(\"GPS sensor settings called:\", body)\n\n port = body[\"port\"]\n\n if port.lower() in sensor_cache:\n sensor: GPSSensor = sensor_cache[port.lower()]\n sensor.repeat = body[\"repeat\"]\n source = body[\"source\"]\n\n if source == \"latlon\":\n sensor.value_type = GPSValueType.LATLON\n sensor.lat = body[\"lat\"]\n sensor.lon = body[\"lon\"]\n sensor.number_of_satellites = body[\"number_of_satellites\"]\n elif source == \"nmeasentences\":\n sensor.value_type = GPSValueType.NMEA\n sensor.raw_nmea = body[\"nmea\"]\n else:\n sensor.value_type = GPSValueType.GPX\n sensor.gpx_file_contents = body[\"gpx\"]\n sensor.gpx_file_name = body[\"gpx_file_name\"]\n\n return \"OK\", 200\n\n\n@app.route(\"/camera_sensor_settings\", methods=[\"POST\"])\ndef set_camera_sensor_settings():\n body = request.get_json()\n\n print(\"Camera sensor settings called:\", str(body)[0:500])\n\n port = body[\"port\"]\n\n if port.lower() in sensor_cache:\n sensor: CameraSensor = sensor_cache[port.lower()]\n sensor.image_source = (\n CameraImageSource.FILE\n if body[\"source\"] == \"File\"\n else CameraImageSource.WEBCAM\n )\n\n if sensor.image_source == CameraImageSource.FILE:\n sensor.image_file_name = body[\"image_file_name\"]\n msg = b64decode(body[\"file_contents\"])\n sensor.value = io.BytesIO(msg)\n else:\n sensor.web_cam_device_id = body[\"web_cam_device_id\"]\n\n return \"OK\", 200\n\n\n@app.route(\"/sensor_units\", methods=[\"POST\"])\ndef get_sensor_units():\n body = request.get_json()\n\n print(\"Sensor units called:\", body)\n\n sensor_type = body[\"type\"]\n\n # pylint: disable=R1705\n for sensor in all_sensors:\n if sensor.sensor_name() == sensor_type:\n if (\n sensor.sensor_type() == SensorType.FLOAT\n or sensor.sensor_type() == SensorType.INTEGER\n or sensor.sensor_type() == SensorType.I2C\n ):\n return {\"units\": sensor.sensor_units()}\n else:\n return {\"units\": []}\n\n return \"Not found\", 404\n\n\n@app.route(\"/actuator_value\", methods=[\"POST\"])\ndef set_actuator_value():\n set_and_send_connected()\n port = str(request.args.get(\"port\", \"\"))\n body = request.get_json()\n\n print(\"Actuator value called:\", body, \"for port\", port)\n\n value = body[\"value\"]\n\n if port.lower() in actuator_cache:\n actuator = actuator_cache[port.lower()]\n actuator.value = value\n\n socketio.emit(\"actuator_change\" + str(port), {\"port\": port, \"value\": value})\n\n return \"OK\", 200\n\n\ndef open_browser(port):\n webbrowser.open_new(f\"http://127.0.0.1:{port}/\")\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument(\n \"--port\", metavar=\"port\", type=int, default=5000, help=\"the port to run on\"\n )\n parser.add_argument(\n \"--dontopen\",\n action=\"store_true\",\n help=\"If this is present, CounterFit is not automatically opened in a browser\",\n )\n\n args = parser.parse_args()\n\n print(f\"CounterFit - virtual IoT hardware running on port {args.port}\")\n\n if args.dontopen is None:\n print(\"Loading browser...\")\n Timer(3, open_browser, [args.port]).start()\n\n socketio.run(app, host=\"0.0.0.0\", port=args.port)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": "counterfit-app/src/CounterFit/i2c_sensors.py", "content": "from abc import abstractmethod\nfrom enum import Enum\nfrom typing import List\nimport random\n\nfrom CounterFit.sensors import SensorBase, SensorType\n\n\nclass I2CSensorBase(SensorBase):\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.I2C\n\n @staticmethod\n @abstractmethod\n def sensor_unit_type() -> SensorType:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @property\n def id(self) -> str:\n return self.port\n\n @property\n def address(self) -> str:\n return f\"0x{int(self.port):02x}\"\n\n\nclass FloatI2CSensorBase(I2CSensorBase):\n def __init__(self, port: str, valid_min: float, valid_max: float):\n super().__init__(port)\n\n self.__valid_min = valid_min\n self.__valid_max = valid_max\n self.value = valid_min\n self.random_min = float(valid_min)\n self.random_max = float(valid_max)\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_units() -> List[str]:\n pass\n\n @staticmethod\n def sensor_unit_type() -> SensorType:\n return SensorType.FLOAT\n\n @property\n @abstractmethod\n def unit(self) -> str:\n pass\n\n @property\n def value(self) -> float:\n if self._random:\n return round(random.uniform(self.__random_min, self.__random_max), 2)\n\n return self.__value\n\n @value.setter\n def value(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__value = val\n\n @property\n def random_min(self) -> float:\n return self.__random_min\n\n @random_min.setter\n def random_min(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_min = val\n\n @property\n def random_max(self) -> float:\n return self.__random_max\n\n @random_max.setter\n def random_max(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_max = val\n\n @property\n def valid_min(self) -> float:\n return self.__valid_min\n\n @property\n def valid_max(self) -> float:\n return self.__valid_max\n\n\nclass IntegerI2CSensorBase(I2CSensorBase):\n def __init__(self, port: str, valid_min: int, valid_max: int):\n super().__init__(port)\n\n self.__valid_min = valid_min\n self.__valid_max = valid_max\n self.value = valid_min\n self.random_min = int(valid_min)\n self.random_max = int(valid_max)\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_units() -> List[str]:\n pass\n\n @staticmethod\n def sensor_unit_type() -> SensorType:\n return SensorType.INTEGER\n\n @property\n @abstractmethod\n def unit(self) -> str:\n pass\n\n @property\n def value(self) -> int:\n if self._random:\n return random.randint(self.__random_min, self.__random_max)\n\n return self.__value\n\n @value.setter\n def value(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__value = val\n\n @property\n def random_min(self) -> int:\n return self.__random_min\n\n @random_min.setter\n def random_min(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_min = val\n\n @property\n def random_max(self) -> int:\n return self.__random_max\n\n @random_max.setter\n def random_max(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_max = val\n\n @property\n def valid_min(self) -> int:\n return self.__valid_min\n\n @property\n def valid_max(self) -> int:\n return self.__valid_max\n\n\n# pylint: disable=C0103\nclass DistanceUnit(Enum):\n Millimeter = 1\n\n\nclass DistanceSensor(IntegerI2CSensorBase):\n def __init__(self, port: str, unit):\n if isinstance(unit, str):\n unit = DistanceUnit[unit]\n\n self.__unit = unit\n\n super().__init__(port, 0, 999999)\n\n @staticmethod\n def sensor_name() -> str:\n return \"Distance\"\n\n @property\n def unit(self) -> str:\n return self.__unit.name\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [DistanceUnit.Millimeter.name]\n" }, { "path": "counterfit-app/src/CounterFit/sensors.py", "content": "from abc import ABC, abstractmethod\nfrom enum import Enum\nfrom typing import List\nimport random\n\n\nclass SensorType(Enum):\n FLOAT = 1\n INTEGER = 2\n BOOLEAN = 3\n SERIAL = 4\n BINARY = 5\n I2C = 6\n\n\nclass SensorBase(ABC):\n def __init__(self, port: str):\n self.__port = port\n self._random = False\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_type() -> SensorType:\n pass\n\n @property\n # pylint: disable=invalid-name\n def id(self) -> str:\n return self.__port\n\n @property\n def port(self) -> str:\n return self.__port\n\n @property\n def random(self) -> bool:\n return self._random\n\n @random.setter\n def random(self, val: bool):\n self._random = val\n\n\n# pylint: disable=C0103\nclass DefaultUnit(Enum):\n NoUnits = 1\n\n\n# pylint: disable=C0103\nclass PercentUnit(Enum):\n Percent = 1\n\n\nclass FloatSensorBase(SensorBase):\n def __init__(self, port: str, valid_min: float, valid_max: float):\n super().__init__(port)\n\n self.__valid_min = valid_min\n self.__valid_max = valid_max\n self.value = valid_min\n self.random_min = float(valid_min)\n self.random_max = float(valid_max)\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_units() -> List[str]:\n pass\n\n @property\n @abstractmethod\n def unit(self) -> str:\n pass\n\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.FLOAT\n\n @property\n def value(self) -> float:\n if self._random:\n return round(random.uniform(self.__random_min, self.__random_max), 2)\n\n return self.__value\n\n @value.setter\n def value(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__value = val\n\n @property\n def random_min(self) -> float:\n return self.__random_min\n\n @random_min.setter\n def random_min(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_min = val\n\n @property\n def random_max(self) -> float:\n return self.__random_max\n\n @random_max.setter\n def random_max(self, val: float):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_max = val\n\n @property\n def valid_min(self) -> float:\n return self.__valid_min\n\n @property\n def valid_max(self) -> float:\n return self.__valid_max\n\n\nclass IntegerSensorBase(SensorBase):\n def __init__(self, port: str, valid_min: int, valid_max: int):\n super().__init__(port)\n\n self.__valid_min = valid_min\n self.__valid_max = valid_max\n self.value = valid_min\n self.random_min = int(valid_min)\n self.random_max = int(valid_max)\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n @abstractmethod\n def sensor_units() -> List[str]:\n pass\n\n @property\n @abstractmethod\n def unit(self) -> str:\n pass\n\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.INTEGER\n\n @property\n def value(self) -> int:\n if self._random:\n return random.randint(self.__random_min, self.__random_max)\n\n return self.__value\n\n @value.setter\n def value(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__value = val\n\n @property\n def random_min(self) -> int:\n return self.__random_min\n\n @random_min.setter\n def random_min(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_min = val\n\n @property\n def random_max(self) -> int:\n return self.__random_max\n\n @random_max.setter\n def random_max(self, val: int):\n if val < self.__valid_min or val > self.__valid_max:\n raise ValueError()\n self.__random_max = val\n\n @property\n def valid_min(self) -> int:\n return self.__valid_min\n\n @property\n def valid_max(self) -> int:\n return self.__valid_max\n\n\nclass BooleanSensorBase(SensorBase):\n def __init__(self, port: str):\n super().__init__(port)\n\n self.value = False\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.BOOLEAN\n\n @property\n def value(self) -> bool:\n if self._random:\n return random.choice([True, False])\n\n return self.__value\n\n @value.setter\n def value(self, val: bool):\n self.__value = val\n\n\n# pylint: disable=C0103\nclass TemperatureUnit(Enum):\n Celsius = 1\n Fahrenheit = 2\n Kelvin = 3\n\n\nclass TemperatureSensor(FloatSensorBase):\n def __init__(self, port: str, unit):\n if isinstance(unit, str):\n unit = TemperatureUnit[unit]\n\n self.__unit = unit\n\n if self.__unit == TemperatureUnit.Celsius:\n valid_min = -273.15\n elif self.__unit == TemperatureUnit.Fahrenheit:\n valid_min = -459.67\n else:\n valid_min = 0\n\n super().__init__(port, valid_min, 999999999.0)\n\n @staticmethod\n def sensor_name() -> str:\n return \"Temperature\"\n\n @property\n def unit(self) -> str:\n return self.__unit.name\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [\n TemperatureUnit.Celsius.name,\n TemperatureUnit.Fahrenheit.name,\n TemperatureUnit.Kelvin.name,\n ]\n\n\nclass HumiditySensor(FloatSensorBase):\n def __init__(self, port: str, unit):\n if isinstance(unit, str):\n unit = PercentUnit[unit]\n\n self.__unit = unit\n\n super().__init__(port, 0.0, 100.0)\n\n @staticmethod\n def sensor_name() -> str:\n return \"Humidity\"\n\n @property\n def unit(self) -> str:\n return self.__unit.name\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [PercentUnit.Percent.name]\n\n\n# pylint: disable=C0103,C0102\nclass PressureUnit(Enum):\n kPa = 1\n torr = 2\n atm = 3\n bar = 4\n\n\nclass PressureSensor(FloatSensorBase):\n def __init__(self, port: str, unit):\n if isinstance(unit, str):\n unit = PressureUnit[unit]\n\n self.__unit = unit\n\n super().__init__(port, 0, 999999999.0)\n\n @staticmethod\n def sensor_name() -> str:\n return \"Pressure\"\n\n @property\n def unit(self) -> str:\n return self.__unit.name\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [\n PressureUnit.kPa.name,\n PressureUnit.torr.name,\n PressureUnit.atm.name,\n PressureUnit.bar.name,\n ]\n\n\nclass AnalogSensor(IntegerSensorBase):\n # pylint: disable=W0613\n def __init__(self, port: str, unit):\n super().__init__(port, 0, 1023)\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @property\n def unit(self) -> str:\n return DefaultUnit.NoUnits.name\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [DefaultUnit.NoUnits.name]\n\n\nclass LightSensor(AnalogSensor):\n @staticmethod\n def sensor_name() -> str:\n return \"Light\"\n\n\nclass UVSensor(AnalogSensor):\n @staticmethod\n def sensor_name() -> str:\n return \"UV\"\n\n\nclass IRSensor(AnalogSensor):\n @staticmethod\n def sensor_name() -> str:\n return \"IR\"\n\n\nclass SoilMoistureSensor(AnalogSensor):\n @staticmethod\n def sensor_name() -> str:\n return \"Soil Moisture\"\n\n\nclass ButtonSensor(BooleanSensorBase):\n @staticmethod\n def sensor_name() -> str:\n return \"Button\"\n\n @staticmethod\n def sensor_units() -> List[str]:\n return [DefaultUnit.NoUnits.name]\n" }, { "path": "counterfit-app/src/CounterFit/serial_sensors.py", "content": "from abc import abstractmethod\nfrom enum import Enum\nimport datetime\nimport re\nfrom xml.dom.minidom import Element, parseString\n\nfrom CounterFit.sensors import SensorBase, SensorType\n\n\nclass SerialSensorBase(SensorBase):\n def __init__(self, port: str):\n super().__init__(port)\n\n self.__value = \"\"\n self.__repeat = False\n self._next_repeat_time = None\n self._value_position = 0\n\n @staticmethod\n def sensor_type() -> SensorType:\n return SensorType.SERIAL\n\n @staticmethod\n @abstractmethod\n def sensor_name() -> str:\n pass\n\n @property\n def id(self) -> str:\n return self.port.replace(\"/\", \"\").replace(\" \", \"\")\n\n @property\n def value(self) -> str:\n return self.__value\n\n @value.setter\n def value(self, val: str):\n self.__value = val\n self._value_position = 0\n\n @property\n def repeat(self) -> bool:\n return self.__repeat\n\n @repeat.setter\n def repeat(self, val: bool):\n self.__repeat = val\n\n def read(self):\n current_utc = datetime.datetime.utcnow()\n if self._next_repeat_time is None:\n self._next_repeat_time = current_utc + datetime.timedelta(0, 1)\n\n if self._value_position >= len(self.value):\n if self.repeat and current_utc > self._next_repeat_time:\n self._next_repeat_time = current_utc\n self._value_position = 0\n\n if self._value_position >= len(self.value):\n return \"\"\n\n char = self.value[self._value_position]\n self._value_position += 1\n return char\n\n def read_line(self):\n line = \"\"\n char = self.read()\n\n while char not in (\"\\n\", \"\"):\n line = line + char\n char = self.read()\n\n return line\n\n\nclass GPSValueType(Enum):\n LATLON = 1\n NMEA = 2\n GPX = 3\n\n\n# pylint: disable=too-many-instance-attributes\nclass GPSSensor(SerialSensorBase):\n def __init__(self, port: str):\n super().__init__(port)\n self.__value_type = GPSValueType.LATLON\n self.__lat = 0.0\n self.__lon = 0.0\n self.__number_of_satellites = 0\n self.__raw_nmea = \"\"\n self.__gpx_file_name = \"\"\n self.__gpx_file_contents = \"\"\n self.__substitute_value = \"\"\n self.__substitute_start_position = 0\n self.__substitute_end_position = 0\n self.__next_gpgga_line_time = None\n\n @staticmethod\n def sensor_name() -> str:\n return \"UART GPS\"\n\n @staticmethod\n def _decimal_decrees_to_ddmmm(decimal_degrees: float) -> str:\n decimal_degrees = abs(decimal_degrees)\n degrees = int(decimal_degrees)\n minutes = (float(decimal_degrees) - float(degrees)) * 60\n\n minutes_string = f\"{minutes:.8f}\".zfill(11).rstrip(\"0\")\n if minutes_string.endswith(\".\"):\n minutes_string += \"0\"\n\n return f\"{degrees}{minutes_string}\"\n\n @staticmethod\n def _build_checksum(sentence: str) -> str:\n checksum_data = re.sub(\n \"(\\n|\\r\\n)\", \"\", sentence[sentence.find(\"$\") + 1 : sentence.find(\"*\")]\n )\n\n checksum = 0\n\n for character in checksum_data:\n checksum ^= ord(character)\n\n return hex(checksum).replace(\"0x\", \"\").upper().zfill(2)\n\n @staticmethod\n def _build_sentence_from_lat_lon_num_satellites(\n lat: float, lon: float, num_satellites: int\n ) -> str:\n converted_lat = GPSSensor._decimal_decrees_to_ddmmm(lat)\n converted_lon = GPSSensor._decimal_decrees_to_ddmmm(lon)\n lat_dir = \"N\" if lat > 0 else \"S\"\n lon_dir = \"E\" if lon > 0 else \"W\"\n\n # use a timestamp of xxxxxx.xx, and this will be replaced with the current time when the value is requested\n # Use a checksum of zz, and again it will be replaces\n return f\"$GPGGA,xxxxxx.xx,{converted_lat},{lat_dir},{converted_lon},{lon_dir},1,{num_satellites},,0,M,0,M,,*zz\\n\"\n\n def _build_value(self) -> None:\n if self.value_type == GPSValueType.LATLON:\n self.value = GPSSensor._build_sentence_from_lat_lon_num_satellites(\n self.lat, self.lon, self.number_of_satellites\n )\n if self.value_type == GPSValueType.NMEA:\n self.value = self.raw_nmea\n if not self.value.endswith(\"\\n\"):\n self.value += \"\\n\"\n if self.value_type == GPSValueType.GPX:\n self.value = \"\"\n\n if self.gpx_file_contents:\n document = parseString(self.gpx_file_contents)\n track_parts = document.getElementsByTagName(\"trkpt\")\n track_part: Element\n for track_part in track_parts:\n self.value += GPSSensor._build_sentence_from_lat_lon_num_satellites(\n float(track_part.getAttribute(\"lat\")),\n float(track_part.getAttribute(\"lon\")),\n 3,\n )\n\n def read(self):\n current_utc = datetime.datetime.utcnow()\n\n if self._next_repeat_time is None:\n self._next_repeat_time = current_utc + datetime.timedelta(0, 1)\n\n if self.__next_gpgga_line_time is None:\n self.__next_gpgga_line_time = current_utc + datetime.timedelta(0, 1)\n\n # only repeat after a delay\n if self._value_position >= len(self.value):\n if self.repeat and current_utc > self._next_repeat_time:\n self._next_repeat_time = current_utc + datetime.timedelta(0, 1)\n self._value_position = 0\n\n if self._value_position >= len(self.value):\n return \"\"\n\n chars_from_position = self.value[self._value_position :]\n\n # if we are a newline right before a $GPGGA then wait one second before sending it to space out GPX files or long NMEA data files\n if (\n self._value_position > 0\n and chars_from_position.startswith(\"$\")\n and chars_from_position[3:].startswith(\"GGA\")\n ):\n if current_utc > self.__next_gpgga_line_time:\n self.__next_gpgga_line_time = current_utc + datetime.timedelta(0, 1)\n else:\n return \"\"\n\n if chars_from_position.startswith(\"$GPGGA,xxxxxx.xx\"):\n self.__substitute_start_position = self._value_position\n\n # Find the end checksum\n self.__substitute_end_position = self.value.find(\n \"*zz\", self._value_position\n ) + len(\"*zz\")\n\n # find the block the right length\n self.__substitute_value = self.value[\n self.__substitute_start_position : self.__substitute_end_position\n ]\n\n current_utc = datetime.datetime.utcnow()\n time_stamp = f\"{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00\"\n self.__substitute_value = self.__substitute_value.replace(\n \"xxxxxx.xx\", time_stamp\n )\n\n checksum = GPSSensor._build_checksum(self.__substitute_value)\n self.__substitute_value = self.__substitute_value.replace(\n \"*zz\", \"*\" + checksum\n )\n\n if (\n self.__substitute_start_position <= self._value_position\n and self.__substitute_end_position > self._value_position\n ):\n next_char = self.__substitute_value[\n self._value_position - self.__substitute_start_position\n ]\n self._value_position += 1\n return next_char\n\n self.__substitute_start_position = 0\n self.__substitute_end_position = 0\n self.__substitute_value = \"\"\n\n return super().read()\n\n @property\n def value_type(self) -> GPSValueType:\n return self.__value_type\n\n @value_type.setter\n def value_type(self, val: GPSValueType):\n self.__value_type = val\n self._build_value()\n\n @property\n def lat(self) -> float:\n return self.__lat\n\n @lat.setter\n def lat(self, val: float):\n self.__lat = val\n self._build_value()\n\n @property\n def lon(self) -> float:\n return self.__lon\n\n @lon.setter\n def lon(self, val: float):\n self.__lon = val\n self._build_value()\n\n @property\n def number_of_satellites(self) -> int:\n return self.__number_of_satellites\n\n @number_of_satellites.setter\n def number_of_satellites(self, val: int):\n self.__number_of_satellites = val\n self._build_value()\n\n @property\n def raw_nmea(self) -> str:\n return self.__raw_nmea\n\n @raw_nmea.setter\n def raw_nmea(self, val: str):\n self.__raw_nmea = val\n self._build_value()\n\n @property\n def gpx_file_name(self) -> str:\n return self.__gpx_file_name\n\n @gpx_file_name.setter\n def gpx_file_name(self, val: str):\n self.__gpx_file_name = val\n self._build_value()\n\n @property\n def gpx_file_contents(self) -> str:\n return self.__gpx_file_contents\n\n @gpx_file_contents.setter\n def gpx_file_contents(self, val: str):\n self.__gpx_file_contents = val\n self._build_value()\n" }, { "path": "counterfit-app/src/CounterFit/static/style.css", "content": ".sensor_container {\n}\n\n.actuator_container {\n}\n\n#circle {\n width: 50px;\n height: 50px;\n -webkit-border-radius: 25px;\n -moz-border-radius: 25px;\n border-radius: 25px;\n background: red;\n }" }, { "path": "counterfit-app/src/CounterFit/templates/binary_sensor_create_settings.html", "content": "
\n
\n \n
\n
\n \n
\n
" }, { "path": "counterfit-app/src/CounterFit/templates/boolean_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

Pin {{sensor.port}}

\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
" }, { "path": "counterfit-app/src/CounterFit/templates/camera_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

{{sensor.port}}

\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n\n
\n
\n\n
\n \n
\n
\n {{sensor.image_file_name}}\n
\n
\n
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n \n
\n
\n\n
\n \n
\n
\n\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/float_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

Pin {{sensor.port}}

\n
\n
\n
\n
\n
\n
\n Units:\n
\n
\n {{ sensor.unit }}\n
\n
\n
\n
\n Value range:\n
\n
\n {{ \"{:,.2f}\".format(sensor.valid_min) }} to {{ \"{:,.2f}\".format(sensor.valid_max) }}\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/gps_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

Port {{sensor.port}}

\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n\n
\n
\n\n
\n \n
\n
\n {{sensor.gpx_file_name}}\n
\n
\n
\n \n
\n
\n\n
\n
\n \n
\n
\n \n
\n
\n\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/home.html", "content": "\n\n\n\n CounterFit\n \n\n \n \n\n \n\n \n \n\n\n\n
\n
\n

\n \"CounterFit\n CounterFit - Fake IoT Hardware\n

\n\n
\n Connected\n {% else %}\n style=\"color:grey;\">Disconnected\n {% endif %}\n \n \n Disconnected\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n
\n\n
\n
\n

Sensors

\n
\n
\n
\n
\n
\n
\n
\n

Create sensor

\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n \n
\n {% include \"pin_sensor_create_settings.html\" %}\n
\n \n
\n {% include \"serial_sensor_create_settings.html\" %}\n
\n \n
\n {% include \"binary_sensor_create_settings.html\" %}\n
\n \n
\n {% include \"i2c_sensor_create_settings.html\" %}\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n {% for sensor in sensors %}\n \n
\n {% if sensor.sensor_type().name == \"FLOAT\": %}\n {% with sensor=sensor %}\n {% include \"float_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% if sensor.sensor_type().name == \"INTEGER\": %}\n {% with sensor=sensor %}\n {% include \"integer_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% if sensor.sensor_type().name == \"BOOLEAN\": %}\n {% with sensor=sensor %}\n {% include \"boolean_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% if sensor.sensor_type().name == \"I2C\": %}\n {% if sensor.sensor_unit_type().name == \"FLOAT\" %}\n {% with sensor=sensor %}\n {% include \"i2c_float_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% if sensor.sensor_unit_type().name == \"INTEGER\" %}\n {% with sensor=sensor %}\n {% include \"i2c_integer_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% endif %}\n {% if sensor.sensor_name() == \"UART GPS\": %}\n {% with sensor=sensor %}\n {% include \"gps_sensor.html\" %}\n {% endwith %}\n {% endif %}\n {% if sensor.sensor_name() == \"Camera\": %}\n {% with sensor=sensor %}\n {% include \"camera_sensor.html\" %}\n {% endwith %}\n {% endif %}\n
\n \n {% endfor %}\n
\n
\n
\n
\n
\n
\n
\n\n
\n
\n

Actuators

\n
\n
\n
\n
\n
\n
\n
\n

Create actuator

\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n {% for actuator in actuators %}\n\n
\n {% if actuator.actuator_name() == \"LED\": %}\n {% with actuator=actuator %}\n {% include \"led_actuator.html\" %}\n {% endwith %}\n {% elif actuator.actuator_name() == \"Relay\": %}\n {% with actuator=actuator %}\n {% include \"relay_actuator.html\" %}\n {% endwith %}\n {% endif %}\n
\n\n {% endfor %}\n
\n
\n
\n
\n
\n
\n
\n\n \n\n\n\n" }, { "path": "counterfit-app/src/CounterFit/templates/i2c_float_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

I2C: {{sensor.address}}

\n
\n
\n
\n
\n
\n
\n Units:\n
\n
\n {{ sensor.unit }}\n
\n
\n
\n
\n Value range:\n
\n
\n {{ \"{:,.2f}\".format(sensor.valid_min) }} to {{ \"{:,.2f}\".format(sensor.valid_max) }}\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/i2c_integer_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

I2C: {{sensor.address}}

\n
\n
\n
\n
\n
\n
\n Units:\n
\n
\n {{ sensor.unit }}\n
\n
\n
\n
\n Value range:\n
\n
\n {{ \"{:,d}\".format(sensor.valid_min) }} to {{ \"{:,d}\".format(sensor.valid_max) }}\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/i2c_sensor_create_settings.html", "content": "
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
" }, { "path": "counterfit-app/src/CounterFit/templates/integer_sensor.html", "content": "
\n
\n
\n

{{ sensor.sensor_name() }}

\n

Pin {{sensor.port}}

\n
\n
\n
\n
\n
\n
\n Units:\n
\n
\n {{ sensor.unit }}\n
\n
\n
\n
\n Value range:\n
\n
\n {{ \"{:,d}\".format(sensor.valid_min) }} to {{ \"{:,d}\".format(sensor.valid_max) }}\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n\n \n
\n" }, { "path": "counterfit-app/src/CounterFit/templates/led_actuator.html", "content": "\n
\n
\n
\n

{{ actuator.actuator_name() }}

\n

Pin {{actuator.port}}

\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n {% if actuator.value: %}LED on{% else %}LED off{% endif %}\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n \n
" }, { "path": "counterfit-app/src/CounterFit/templates/pin_sensor_create_settings.html", "content": "
\n
\n \n
\n
\n \n
\n
\n
\n
\n \n
\n
\n \n
\n
" }, { "path": "counterfit-app/src/CounterFit/templates/relay_actuator.html", "content": "\n
\n
\n
\n

{{ actuator.actuator_name() }}

\n

Pin {{actuator.port}}

\n
\n
\n
\n
\n
\n
\n \n
\n
\n \n Relay off\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n \n \n
" }, { "path": "counterfit-app/src/CounterFit/templates/serial_sensor_create_settings.html", "content": "
\n
\n \n
\n
\n \n
\n
" }, { "path": "counterfit-app/src/__main__.py", "content": "from CounterFit.counterfit import main\n\nmain()\n" }, { "path": "counterfit-app/src/tests/__init__.py", "content": "" }, { "path": "counterfit-app/src/tests/route.gpx", "content": "\n\n \n \n \n \n AllTrails, LLC\n \n \n \n \n \n \n AllTrails\n \n \n 107.05\n \n \n 107.05\n \n \n 108.0\n \n \n \n\n" }, { "path": "counterfit-app/src/tests/test_serial_sensors.py", "content": "# pylint: disable=protected-access,line-too-long\nimport datetime\nimport time\n\nfrom CounterFit.serial_sensors import GPSSensor, GPSValueType\n\n\ndef test_decimal_degree_conversion():\n assert GPSSensor._decimal_decrees_to_ddmmm(47.653814) == \"4739.22884\"\n assert GPSSensor._decimal_decrees_to_ddmmm(-47.09565) == \"4705.739\"\n assert GPSSensor._decimal_decrees_to_ddmmm(-47) == \"4700.0\"\n\n\ndef test_checksum():\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005206.768,5227.561,N,01230.806,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"68\"\n )\n assert (\n GPSSensor._build_checksum(\n \"GPGGA,005207.768,5249.958,N,01308.049,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"6E\"\n )\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005208.768,5310.190,N,01409.023,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"6A\"\n )\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005209.768,5300.094,N,01450.881,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"63\"\n )\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005210.768,5148.313,N,01608.005,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"62\"\n )\n assert (\n GPSSensor._build_checksum(\n \"# $GPGGA,005211.768,5142.192,N,01454.836,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"61\"\n )\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005212.768,5135.443,N,01332.439,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"6F\"\n )\n assert (\n GPSSensor._build_checksum(\n \"$GPGGA,005213.768,5153.810,N,01259.150,E,1,12,1.0,0.0,M,0.0,M,,*00\"\n )\n == \"62\"\n )\n\n\ndef test_gps_empty_read_line():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n line = gps.read_line()\n assert line == \"\"\n\n\ndef test_gps_empty_read():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n char = gps.read()\n assert char == \"\"\n\n\ndef add_checksum_to_expected(expected: str) -> str:\n checksum = GPSSensor._build_checksum(expected)\n expected += checksum\n return expected\n\n\ndef test_gps_time_setting_when_using_lat_lon_n_e():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.LATLON\n\n gps.lat = 47\n gps.lon = 122\n gps.number_of_satellites = 3\n\n current_utc = datetime.datetime.utcnow()\n\n line = gps.read_line()\n\n expected = add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4700.0,N,12200.0,E,1,3,,0,M,0,M,,*\"\n )\n\n assert line == expected\n assert gps.read_line() == \"\"\n\n\ndef test_gps_time_setting_when_using_lat_lon_s_w():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.LATLON\n\n gps.lat = -47\n gps.lon = -122\n gps.number_of_satellites = 3\n\n current_utc = datetime.datetime.utcnow()\n\n expected = add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4700.0,S,12200.0,W,1,3,,0,M,0,M,,*\"\n )\n\n assert gps.read_line() == expected\n assert gps.read_line() == \"\"\n\n\ndef test_gps_nmea():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n assert (\n gps.read_line()\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n assert gps.read_line() == \"\"\n\n\ndef test_gps_nmea_repeat():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n gps.repeat = True\n\n for _ in range(0, 20):\n line = gps.read_line()\n if line == \"\":\n time.sleep(1)\n line = gps.read_line()\n\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n\ndef test_gps_nmea_repeat_has_delay():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n gps.repeat = True\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n time.sleep(1)\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n\ndef test_gps_nmea_multiple_sentences_has_delay():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n + \"\\n\"\n + \"$GNGGA,020604.001,4739.228833333,S,12207.031866667,E,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n time.sleep(1.5)\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,S,12207.031866667,E,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n\ndef test_gps_nmea_multiple_sentences_has_delay_only_for_gga():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n + \"\\n\"\n + \"$GPGSA,A,3,01,02,03,04,05,06,07,08,09,10,11,12,1.0,1.0,1.0*30\"\n + \"\\n\"\n + \"$GNGGA,020604.001,4739.228833333,S,12207.031866667,E,1,3,,164.7,M,-17.1,M,,*67\"\n + \"\\n\"\n + \"$GPGSA,A,3,01,02,03,04,05,06,07,08,09,10,11,12,1.0,1.0,1.0*30\"\n )\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n line = gps.read_line()\n assert line == \"$GPGSA,A,3,01,02,03,04,05,06,07,08,09,10,11,12,1.0,1.0,1.0*30\"\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n time.sleep(1)\n\n line = gps.read_line()\n assert (\n line\n == \"$GNGGA,020604.001,4739.228833333,S,12207.031866667,E,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n line = gps.read_line()\n assert line == \"$GPGSA,A,3,01,02,03,04,05,06,07,08,09,10,11,12,1.0,1.0,1.0*30\"\n\n line = gps.read_line()\n assert line == \"\"\n\n line = gps.read_line()\n assert line == \"\"\n\n\ndef test_gps_gpx():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.GPX\n\n with open(\"./src/tests/route.gpx\", \"r\", encoding=\"UTF-8\") as gpx_file:\n gps.gpx_file_contents = gpx_file.read()\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.42,W,1,3,,0,M,0,M,,*\"\n )\n\n time.sleep(2)\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.4206,W,1,3,,0,M,0,M,,*\"\n )\n\n time.sleep(2)\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0856,N,12215.4092,W,1,3,,0,M,0,M,,*\"\n )\n\n assert gps.read_line() == \"\"\n\n\ndef test_gps_gpx_repeat():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.GPX\n\n with open(\"./src/tests/route.gpx\", \"r\", encoding=\"UTF-8\") as gpx_file:\n gps.gpx_file_contents = gpx_file.read()\n\n gps.repeat = True\n\n for _ in range(0, 20):\n line = gps.read_line()\n if line == \"\":\n time.sleep(1)\n line = gps.read_line()\n\n current_utc = datetime.datetime.utcnow()\n assert line == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.42,W,1,3,,0,M,0,M,,*\"\n )\n\n line = gps.read_line()\n if line == \"\":\n time.sleep(1)\n line = gps.read_line()\n\n current_utc = datetime.datetime.utcnow()\n assert line == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.4206,W,1,3,,0,M,0,M,,*\"\n )\n\n line = gps.read_line()\n if line == \"\":\n time.sleep(1)\n line = gps.read_line()\n\n current_utc = datetime.datetime.utcnow()\n assert line == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0856,N,12215.4092,W,1,3,,0,M,0,M,,*\"\n )\n\n\ndef test_setting_lat_lon_clears_value():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n gps.value_type = GPSValueType.LATLON\n\n gps.lat = -47\n gps.lon = -122\n gps.number_of_satellites = 3\n\n current_utc = datetime.datetime.utcnow()\n\n expected = add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4700.0,S,12200.0,W,1,3,,0,M,0,M,,*\"\n )\n\n assert gps.read_line() == expected\n assert gps.read_line() == \"\"\n\n\ndef test_setting_gpx_clears_value():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n gps.value_type = GPSValueType.GPX\n\n with open(\"./src/tests/route.gpx\", \"r\", encoding=\"UTF-8\") as gpx_file:\n gps.gpx_file_contents = gpx_file.read()\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.42,W,1,3,,0,M,0,M,,*\"\n )\n\n time.sleep(2)\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0886,N,12215.4206,W,1,3,,0,M,0,M,,*\"\n )\n\n time.sleep(2)\n\n current_utc = datetime.datetime.utcnow()\n assert gps.read_line() == add_checksum_to_expected(\n f\"$GPGGA,{current_utc.hour:02d}{current_utc.minute:02d}{current_utc.second:02}.00,4744.0856,N,12215.4092,W,1,3,,0,M,0,M,,*\"\n )\n\n assert gps.read_line() == \"\"\n\n\ndef test_setting_nmea_clears_value():\n gps = GPSSensor(\"/dev/ttyAMA0\")\n\n gps.value_type = GPSValueType.GPX\n\n with open(\"./src/tests/route.gpx\", \"r\", encoding=\"UTF-8\") as gpx_file:\n gps.gpx_file_contents = gpx_file.read()\n\n gps.value_type = GPSValueType.NMEA\n\n gps.raw_nmea = (\n \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n\n assert (\n gps.read_line()\n == \"$GNGGA,020604.001,4739.228833333,N,12207.031866667,W,1,3,,164.7,M,-17.1,M,,*67\"\n )\n assert gps.read_line() == \"\"\n" }, { "path": "counterfit-app/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "requirements.txt", "content": "twine=4.0.2\nblack=23.1.0" }, { "path": "samples/grove/button-temperature-sensor-controlled-relay/README.md", "content": "# Relay controlled by temperature sensor and button sample\n\nThis sample shows how to use the CounterFit Grove shims to simulate a relay controlled by a temperature sensor and button setup.\nThe temperature value is read whenever the button is pressed, and the relay is activated if the temperature is under 38 degrees celsius.\n\n## Setup\n\n* Create a Python virtual environment:\n\n ```sh\n python3 -m venv .venv\n ```\n\n* Activate the environment:\n\n macOS/Linux:\n\n ```sh\n source ./.venv/bin/activate\n ```\n\n Windows:\n\n ```cmd\n .venv\\Scripts\\activate.bat\n ```\n\n* Install the required pip packages:\n\n ```sh\n pip install -r requirements.txt\n ```\n\nThis will install the [CounterFit](https://github.com/CounterFit-IoT/CounterFit/tree/main/counterfit-app) app and the [CounterFit Grove Shims](https://github.com/CounterFit-IoT/CounterFit/tree/main/shims).\n\n## Configure the hardware\n\n* Launch the CounterFit app:\n\n ```sh\n CounterFit\n ```\n\n This will launch the app in a web browser, running on port 5000.\n\n > If you want to change the port, pass it is as the `--port` parameter when launching `CounterFit`\n\n* Create a **button** on **pin 1**, and a **temperature sensor** on **pin 2**, and a **relay** on **pin 3**\n![Screenshot of the used setup](https://github.com/AChillFeeder/CounterFit/blob/temperature_button_relay_example/samples/grove/button-temperature-sensor-controlled-relay/assets/HardwareSetup.png)\n\n## Run the code\n\n* Run the `app.py` file in the same virtual environment (you will need a new terminal or CMD)\n\n > If you used a different port, then you will need to edit the port use to initialize the CounterFit connection:\n >\n > ```python\n > CounterFitConnection.init('127.0.0.1', )\n > ```\n >\n > Replace `` with the port you used.\n\n* Adjust the values in CounterFit for the temperature level. When the value is less than 38 and the button is pressed, the relay will activate." }, { "path": "samples/grove/button-temperature-sensor-controlled-relay/main.py", "content": "\n\n# In this example:\n# We will create a circuit where, when a button is pressed, we will check the current temperature\n# If the recorded temperature is under 38 celsius, the relay will be activated\n\n\n# PIN 1: Button\n# PIN 2: Temperature sensor\n# PIN 3: Relay\n\nimport time\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_grove.grove_relay import GroveRelay\n\nCounterFitConnection.init('127.0.0.1', 5000)\n\nrelay = GroveRelay(3)\n\nwhile True:\n \n button = CounterFitConnection.get_sensor_boolean_value(1) # The button returns boolean values, True for pressed and False for released\n\n if button:\n print(\"The button has been pressed\")\n temperature = CounterFitConnection.get_sensor_float_value(2) # Get temperature value\n\n print(f\"Recorded temperature is {temperature}\")\n\n if temperature < 38:\n print(\"Activate relay\")\n relay.on()\n time.sleep(5)\n relay.off()\n\n time.sleep(0.5) # Used a short sleep timer as not to miss a button press when the script is on break\n" }, { "path": "samples/grove/button-temperature-sensor-controlled-relay/requirements.txt", "content": "counterfit\ncounterfit_shims_grove" }, { "path": "samples/grove/light-sensor-controlled-led/README.md", "content": "# Light sensor controlled LED sample\n\nThis sample shows how to use the CounterFit Grove shims to simulate an LED and a light sensor, controlling the LED based on the light levels read from the sensor.\n\n## Setup\n\n* Create a Python virtual environment:\n\n ```sh\n python3 -m venv .venv\n ```\n\n* Activate the environment:\n\n macOS/Linux:\n\n ```sh\n source ./.venv/bin/activate\n ```\n\n Windows:\n\n ```cmd\n .venv\\Scripts\\activate.bat\n ```\n\n* Install the required pip packages:\n\n ```sh\n pip install -r requirements.txt\n ```\n\nThis will install the [CounterFit](https://github.com/CounterFit-IoT/CounterFit/tree/main/counterfit-app) app and the [CounterFit Grove Shims](https://github.com/CounterFit-IoT/CounterFit/tree/main/shims/grove).\n\n## Configure the hardware\n\n* Launch the CounterFit app:\n\n ```sh\n CounterFit\n ```\n\n This will launch the app in a web browser, running on port 5000.\n\n > If you want to change the port, pass it is as the `--port` parameter when launching `CounterFit`\n\n* Create a light sensor on pin 1, and an LED actuator on pin 2\n\n## Run the code\n\n* Run the `app.py` file in the same virtual environment (you will need a new terminal or CMD)\n\n > If you used a different port, then you will need to edit the port use to initialize the CounterFit connection:\n >\n > ```python\n > CounterFitConnection.init('127.0.0.1', )\n > ```\n >\n > Replace `` with the port you used.\n\n* Adjust the values in CounterFit for the light level. When the value is less than 200, the LED will light up.\n" }, { "path": "samples/grove/light-sensor-controlled-led/app.py", "content": "import time\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_grove.grove_light_sensor_v1_2 import GroveLightSensor\nfrom counterfit_shims_grove.grove_led import GroveLed\n\nCounterFitConnection.init('127.0.0.1', 5000)\n\nlight_sensor = GroveLightSensor(1)\nled = GroveLed(2)\n\nwhile True:\n sensor_value = light_sensor.light\n print(f'Light sensor reading: {sensor_value}')\n\n if sensor_value > 200:\n print('Turning LED off')\n led.off()\n else:\n print('Turning LED on')\n led.on()\n\n time.sleep(2)" }, { "path": "samples/grove/light-sensor-controlled-led/requirements.txt", "content": "counterfit\ncounterfit_shims_grove" }, { "path": "shims/CounterFitConnection/.gitignore", "content": "test_image.png" }, { "path": "shims/CounterFitConnection/.pylintrc", "content": "[FORMAT]\n\n# Maximum number of characters on a single line.\nmax-line-length=140\n\n[MESSAGES CONTROL]\ndisable=trailing-whitespace" }, { "path": "shims/CounterFitConnection/README.md", "content": "# CounterFit Shims - CounterFit connection\n\n![CounterFit Connection](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-connection)](https://pypi.org/project/counterfit-connection)\n\nA core connection library to use with the [CounterFit virtual IoT device app](https://github.com/CounterFit-IoT/CounterFit).\n\nUse this when writing a shim library.\n" }, { "path": "shims/CounterFitConnection/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/CounterFitConnection/counterfit_connection.py", "content": "'''\nProvides a connection to the CounterFit Virtual IoT Device app. This connection is re-used by all the virtual sensors.\n\nExamples:\n\n When connecting to localhost on the default port:\n\n .. code-block:: python\n\n from counterfit_shims_grove.counterfit_connection import CounterFitConnection\n\n CounterFitConnection.init()\n\n\n When connection to another computer on a different port:\n\n .. code-block:: python\n\n from counterfit_shims_grove.counterfit_connection import CounterFitConnection\n\n CounterFitConnection.init('192.168.197.1', 5050)\n'''\n# pylint: disable=duplicate-code,bare-except\n\nfrom base64 import b64decode\nimport io\nimport requests\n\nclass CounterFitConnection:\n '''\n Connects to the CounterFit Virtual IoT device on a give host and port, and allows the value of sensors to be read,\n as well as setting the value of actuators.\n '''\n base_url = ''\n\n @staticmethod\n def init(hostname: str = 'localhost', port: int = 5000) -> None:\n '''\n Initializes the connection to the Virtual IoT Device running on the given url and port\n '''\n CounterFitConnection.base_url = f'http://{hostname}:{str(port)}/'\n requests.post(CounterFitConnection.base_url + 'connect')\n \n @staticmethod\n def get_sensor_float_value(port: int) -> float:\n '''\n Reads a float value from the sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'sensor_value?port=' + str(port))\n return float(response.json()['value'])\n \n @staticmethod\n def get_sensor_int_value(port: int) -> int:\n '''\n Reads an integer value from the sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'sensor_value?port=' + str(port))\n return int(response.json()['value'])\n \n @staticmethod\n def get_sensor_boolean_value(port: int) -> bool:\n '''\n Reads a bool value from the sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'sensor_value?port=' + str(port))\n return bool(response.json()['value'])\n \n @staticmethod\n def read_serial_sensor_char(port: str) -> str:\n '''\n Reads a character from the serial sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'serial_sensor_character?port=' + port)\n return str(response.json()['value'])\n \n @staticmethod\n def read_serial_sensor_line(port: str) -> str:\n '''\n Reads a line from the serial sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'serial_sensor_line?port=' + port)\n return str(response.json()['value'])\n \n @staticmethod\n def read_binary_sensor(port: str) -> io.BytesIO:\n '''\n Reads a character from the serial sensor on the given port\n '''\n response = requests.get(CounterFitConnection.base_url + 'binary_sensor_data?port=' + port)\n msg = b64decode(response.json()['value'])\n return io.BytesIO(msg)\n \n @staticmethod\n def set_actuator_float_value(port: int, value: float) -> None:\n '''\n Sends a float value to the actuator on the given port\n '''\n requests.post(CounterFitConnection.base_url + 'actuator_value?port=' + str(port), json= {'value':value})\n \n @staticmethod\n def set_actuator_boolean_value(port: int, value: bool) -> None:\n '''\n Sends a bool value to the actuator on the given port\n '''\n requests.post(CounterFitConnection.base_url + 'actuator_value?port=' + str(port), json= {'value':value})\n \n @staticmethod\n def is_connected() -> bool:\n '''\n Determines if CounterFit is running\n '''\n try:\n requests.post(CounterFitConnection.base_url + 'connect')\n return True\n except:\n return False\n" }, { "path": "shims/CounterFitConnection/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\n" }, { "path": "shims/CounterFitConnection/setup.py", "content": "'''\nConnection library for use with the CounterFit Virtual IoT Device app\n'''\n\n# pylint: disable=redefined-builtin\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-connection',\n py_modules=['counterfit_connection'],\n version='0.1.0.dev5',\n description='Connection library for use with the CounterFit Virtual IoT Device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot grove seeed virtual hardware\",\n install_requires=['requests'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/CounterFitConnection/tests/__init__.py", "content": "" }, { "path": "shims/CounterFitConnection/tests/test_counterfit_connection.py", "content": "'''\nTests the CounterFit app connection\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument,duplicate-code\n\nimport pytest\nimport time\n\nfrom counterfit_connection import CounterFitConnection\n\ndef test_init_counterfit_device():\n '''\n Tests the connection. You should see the CounterFit app status change to connected\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\n# def test_get_sensor_bool_value():\n# '''\n# Tests reading a True boolean value from a boolean sensor on port 0\n# '''\n# CounterFitConnection.init('127.0.0.1', 5000)\n# assert CounterFitConnection.get_sensor_boolean_value(0)\n\n# def test_read_serial_char():\n# '''\n# Tests reading a character from a serial sensor on port /dev/ttyAMA0 containing the text 'hello'\n# '''\n# CounterFitConnection.init('127.0.0.1', 5000)\n# assert CounterFitConnection.read_serial_sensor_char('/dev/ttyAMA0') == 'h'\n# assert CounterFitConnection.read_serial_sensor_char('/dev/ttyAMA0') == 'e'\n# assert CounterFitConnection.read_serial_sensor_char('/dev/ttyAMA0') == 'l'\n# assert CounterFitConnection.read_serial_sensor_char('/dev/ttyAMA0') == 'l'\n# assert CounterFitConnection.read_serial_sensor_char('/dev/ttyAMA0') == 'o'\n\n# def test_read_serial_line():\n# '''\n# Tests reading a line from a serial sensor on port /dev/ttyAMA0 containing the text 'hello\\nworld'\n# '''\n# CounterFitConnection.init('127.0.0.1', 5000)\n# assert CounterFitConnection.read_serial_sensor_line('/dev/ttyAMA0') == 'hello'\n# assert CounterFitConnection.read_serial_sensor_line('/dev/ttyAMA0') == 'world'\n\ndef test_camera_image():\n '''\n Tests reading an image from a camera sensor. The image is saved locally\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n image_data = CounterFitConnection.read_binary_sensor('Picamera')\n\n with open('test_image.png', 'wb') as image_file:\n image_file.write(image_data.read())\n\ndef test_is_connected():\n '''\n Tests is connected. Make sure counterfit is running\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n assert CounterFitConnection.is_connected()\n\ndef test_is_connected_is_false():\n '''\n Tests is connected. Make sure counterfit is running until you see a message telling you to close it\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n print(\"Please close counterfit\")\n time.sleep(10)\n assert not CounterFitConnection.is_connected()\n" }, { "path": "shims/CounterFitConnection/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/.pylintrc", "content": "[FORMAT]\n\n# Maximum number of characters on a single line.\nmax-line-length=140\n\n[MESSAGES CONTROL]\ndisable=trailing-whitespace" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/README.md", "content": "# CounterFit Shims - Grove\n\n![Grove Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-seeed-python-dht)](https://pypi.org/project/counterfit-shims-seeed-python-dht)\n\nShims for the Seeed Grove DHT digital temperature and humidity sensor to use with the [CounterFit virtual IoT device app](https://github.com/CounterFit-IoT/CounterFit).\n\nSee the [Seeed Python DHT Docs](https://github.com/Seeed-Studio/Seeed_Python_DHT) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate hardware created.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-seeed-python-dht\n ```\n\n* Import the Grove modules as normal, but using the `counterfit_shims_seeed_python_dht` package instead of the `seeed-python-dht` package, as well as importing the `CounterFitConnection` from the `counterfit_shims_grove.counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_seeed_python_dht import DHT\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your Grove code as usual, setting the pins to match the ones you set in the CounterFit app. To keep to the interface that the `DHT` specifies, only one pin can be passed to the constructor. The sensor assumes the pin given is for the humidity sensor, and the temperature is on the next pin.\n\n For example, create a humidity sensor on pin 1, and a temperature sensor on pin 2. Then pass 1 to the `DHT` constructor.\n\n ```python\n sensor =.DHT(\"11\", 1)\n humi, temp = sensor.read()\n ```\n" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/counterfit_shims_seeed_python_dht.py", "content": "'''\nThis is the code for\n - `Grove - DHT11 digital temperature and humidity sensor `_\n\nExamples:\n\n .. code-block:: python\n import time\n from counterfit_shims_seeed_python_dht.counterfit_connection import CounterFitConnection\n import counterfit_shims_seeed_python_dht.seeed_dht\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n # connect to a humidity sensor on pin 12 and a temperature sensor on pin 13\n PIN = 12\n sensor = seeed_dht.DHT(\"11\", 12)\n\n humi, temp = sensor.read()\n'''\n# pylint: disable=too-few-public-methods,unused-argument\n\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['DHT']\n\nclass DHT():\n '''\n Class for Grove DHT\n Args:\n pin(int): The pin for the humidity sensor. The temperature sensor needs to be on the next pin.\n '''\n def __init__(self, dht_type, pin = 12,bus_num = 1):\n self.__humidity_pin = pin\n self.__temperature_pin = pin + 1\n\n def read(self, retries = 15):\n '''\n Read the humidity and temperature from the sensor\n '''\n humidity = CounterFitConnection.get_sensor_float_value(self.__humidity_pin)\n temperature = CounterFitConnection.get_sensor_float_value(self.__temperature_pin)\n\n return humidity, temperature\n" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/setup.py", "content": "'''\nShims for the Seeed Python DHT library for use with the CounterFit Virtual IoT Device app\n'''\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-seeed-python-dht',\n py_modules=['counterfit_shims_seeed_python_dht'],\n version='0.1.0.dev1',\n description='Shims for the Seeed Grove DHT for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot grove seeed virtual hardware\",\n install_requires=['requests','counterfit-connection'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/tests/__init__.py", "content": "" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/tests/test_counterfit_shims_seeed_python_dht.py", "content": "'''\nTests the Grove DHT.\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running, with a humidity sensor\non pin 0 and a temperature sensor on pin 1.\n\nThe humidity sensor should be set to 50%, and the temperature sensor to 25°C\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_seeed_python_dht import DHT\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_humidity_and_temperature(init_counterfit_device):\n '''\n Tests values returned from the DHT sensor\n '''\n sensor = DHT(\"11\", 12)\n\n humi, temp = sensor.read()\n\n\n assert humi == 50.0\n assert temp == 25.0\n" }, { "path": "shims/SeeedStudios/Seeed_Python_DHT/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/SeeedStudios/grove_py/.gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\npip-wheel-metadata/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n.python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n\n.vscode" }, { "path": "shims/SeeedStudios/grove_py/.pylintrc", "content": "[FORMAT]\n\n# Maximum number of characters on a single line.\nmax-line-length=140\n\n[MESSAGES CONTROL]\ndisable=trailing-whitespace\n\n[SIMILARITIES]\ndisable=duplicate-code" }, { "path": "shims/SeeedStudios/grove_py/README.md", "content": "# CounterFit Shims - Grove\n\n![Grove Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-grove)](https://pypi.org/project/counterfit-shims-grove)\n\nShims for the Seeed Grove sensors and actuators to use with the [CounterFit virtual IoT device app](https://github.com/CounterFit-IoT/CounterFit).\n\nSee the [Grove Py Docs](https://github.com/Seeed-Studio/grove.py) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate hardware created.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-grove\n ```\n\n* Import the Grove modules as normal, but using the `counterfit_shims_grove` package instead of the `grove` package, as well as importing the `CounterFitConnection` from the `counterfit_shims_grove.counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_grove.grove_light_sensor_v1_2 import GroveLightSensor\n from counterfit_shims_grove.grove_led import GroveLed\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your Grove code as usual, setting the pins to match the ones you set in the CounterFit app:\n\n ```python\n light_sensor = GroveLightSensor(2)\n sensor_value = light_sensor.light\n ```\n\n## Implemented shims\n\nNot all the Grove sensor and actuators are currently implemented:\n\n| Sensor/Actuator |\n| ------ |\n| grove_led |\n| grove_light_sensor_v1_2 |\n" }, { "path": "shims/SeeedStudios/grove_py/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/SeeedStudios/grove_py/counterfit_shims_grove/__init__.py", "content": "'''\nCounterFit Virtual IoT Device shims for Grove sensors.\n\nThis library provides shims that mimic the Grove Python libraries from:\n https://github.com/Seeed-Studio/grove.py\n\nThese shims don't communicate with real hardware, instead they communicate with a running instance of\nthe CounterFit Virtual IoT Device app\n'''\n\nfrom .grove_light_sensor_v1_2 import GroveLightSensor\nfrom .grove_led import GroveLed\n" }, { "path": "shims/SeeedStudios/grove_py/counterfit_shims_grove/adc.py", "content": "'''\nThis is the code for\n - `Grove Base Hat for RPi `_\n - `Grove Base Hat for RPi Zero `_\n\nGrove Base Hat incorporates a micro controller STM32F030F4.\n\nRaspberry Pi does not have ADC unit, so we use an external chip\nto transmit analog data to raspberry pi.\n\nExamples:\n .. code-block:: python\n\n import time\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_grove.adc import ADC\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n adc = ADC()\n while True:\n # Read channel 0(Slot A0)\n print(adc.read(0))\n time.sleep(1)\n\n'''\n# pylint: disable=no-self-use\n\n# pylint: disable=import-error\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = [\"ADC\"]\n\nclass ADC():\n '''\n Class ADC for the ADC unit on Grove Base Hat for RPi.\n\n Args:\n address(int): optional, i2c address of the ADC unit, default 0x04\n '''\n def __init__(self, address = 0x04):\n pass\n\n def read_raw(self, channel):\n '''\n Read the raw data of ADC unit, with 12 bits resolution.\n\n Args:\n channel (int): 0 - 7, specify the channel to read\n\n Returns:\n (int): the adc result, in [0 - 4095]\n '''\n raise NotImplementedError()\n\n # read input voltage (mV)\n def read_voltage(self, channel):\n '''\n Read the voltage data of ADC unit.\n\n Args:\n channel (int): 0 - 7, specify the channel to read\n\n Returns:\n (int): the voltage result, in mV\n '''\n raise NotImplementedError()\n\n # input voltage / output voltage (%)\n def read(self, channel):\n '''\n Read the ratio between channel input voltage and power voltage (most time it's 3.3V).\n\n Args:\n channel (int): 0 - 7, specify the channel to read\n\n Returns:\n (int): the ratio, in 0.1%\n '''\n return CounterFitConnection.get_sensor_int_value(channel)\n\n @property\n def name(self):\n '''\n Get the Hat name.\n\n Returns:\n (string): could be :class:`RPI_HAT_NAME` or :class:`RPI_ZERO_HAT_NAME`\n '''\n return 'Virtual Grove Hat'\n\n @property\n def version(self):\n '''\n Get the Hat firmware version.\n\n Returns:\n (int): firmware version\n '''\n return 1\n\n # pylint: disable=invalid-name\n def read_register(self, n):\n '''\n Read the ADC Core (through I2C) registers\n\n Grove Base Hat for RPI I2C Registers\n\n - 0x00 ~ 0x01: \n - 0x10 ~ 0x17: ADC raw data\n - 0x20 ~ 0x27: input voltage\n - 0x29: output voltage (Grove power supply voltage)\n - 0x30 ~ 0x37: input voltage / output voltage\n\n Args:\n n(int): register address.\n\n Returns:\n (int) : 16-bit register value.\n '''\n raise NotImplementedError()\n" }, { "path": "shims/SeeedStudios/grove_py/counterfit_shims_grove/grove_led.py", "content": "'''\nThis is the code for\n - `Grove - Red LED `_\n - `Grove - Green LED `_\n - `Grove - Purple LED `_\n - `Grove - White LED `_\n\nExamples:\n\n .. code-block:: python\n import time\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_grove.grove_light_sensor_v1_2 import GroveLightSensor\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n # connect to pin 5(slot D5)\n PIN = 5\n led = GroveLed(PIN)\n while True:\n led.on()\n time.sleep(1)\n led.off()\n time.sleep(1)\n'''\n\n# pylint: disable=import-error\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['GroveLed']\n\nclass GroveLed():\n '''\n Class for Grove - XXXX Led\n Args:\n pin(int): number of digital pin the led connected.\n '''\n def __init__(self, pin):\n self.__pin = pin\n\n # pylint: disable=invalid-name\n def on(self) -> None:\n '''\n light on the led\n '''\n CounterFitConnection.set_actuator_boolean_value(self.__pin, True)\n\n def off(self) -> None:\n '''\n light off the led\n '''\n CounterFitConnection.set_actuator_boolean_value(self.__pin, False)\n" }, { "path": "shims/SeeedStudios/grove_py/counterfit_shims_grove/grove_light_sensor_v1_2.py", "content": "'''\nThis is the shim code for\n - `Grove - Light Sensor `_\n\nExamples:\n\n .. code-block:: python\n\n import time\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_grove.grove_light_sensor_v1_2 import GroveLightSensor\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n # connect to alalog pin 2(slot A2)\n PIN = 2\n\n sensor = GroveLightSensor(pin)\n\n print('Detecting light...')\n while True:\n print('Light value: {0}'.format(sensor.light))\n time.sleep(1)\n'''\n# pylint: disable=too-few-public-methods\n\n# pylint: disable=import-error\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['GroveLightSensor']\n\nclass GroveLightSensor:\n '''\n Grove Light Sensor class\n\n Args:\n pin(int): number of analog pin/channel the sensor connected.\n '''\n def __init__(self, pin: int):\n self.__pin = pin\n\n @property\n def light(self) -> int:\n '''\n Get the light strength value, maximum value is 1023\n '''\n return CounterFitConnection.get_sensor_int_value(self.__pin)\n" }, { "path": "shims/SeeedStudios/grove_py/counterfit_shims_grove/grove_relay.py", "content": "'''\nThis is the code for\n - `Grove - Relay `_\n\nExamples:\n\n .. code-block:: python\n\n import time\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_grove.grove_relay import GroveRelay\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n # connect to pin 5(slot D5)\n PIN = 5\n relay = GroveRelay(PIN)\n\n while True:\n relay.on()\n time.sleep(1)\n relay.off()\n time.sleep(1)\n'''\n\n# pylint: disable=import-error\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = [\"GroveRelay\"]\n\nclass GroveRelay():\n '''\n Class for Grove - Relay\n\n Args:\n pin(int): number of digital pin the relay connected.\n '''\n def __init__(self, pin):\n self.__pin = pin\n\n # pylint: disable=invalid-name\n def on(self) -> None:\n '''\n light on the led\n '''\n CounterFitConnection.set_actuator_boolean_value(self.__pin, True)\n\n def off(self) -> None:\n '''\n light off the led\n '''\n CounterFitConnection.set_actuator_boolean_value(self.__pin, False)\n" }, { "path": "shims/SeeedStudios/grove_py/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection\n" }, { "path": "shims/SeeedStudios/grove_py/setup.py", "content": "'''\nShims for the Seeed Grove Py library for use with the CounterFit Virtual IoT Device app\n'''\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import find_packages, setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-grove',\n packages=find_packages(include=['counterfit_shims_grove']),\n version='0.1.4.dev5',\n description='Shims for the Seeed Grove sensors for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot grove seeed virtual hardware\",\n install_requires=['requests','counterfit-connection'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/SeeedStudios/grove_py/tests/__init__.py", "content": "" }, { "path": "shims/SeeedStudios/grove_py/tests/test_grove_led.py", "content": "'''\nTests the Grove LED shim.\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running, with an LED actuator\non pin 1.\n\nUncomment the relevant test below and run it to see the LED change state\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_grove.grove_led import GroveLed\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_turn_led_on(init_counterfit_device):\n '''\n Tests the on method of the Grove LED shim\n '''\n sensor = GroveLed(1)\n sensor.on()\n\ndef test_turn_led_off(init_counterfit_device):\n '''\n Tests the off method of the Grove LED shim\n '''\n sensor = GroveLed(1)\n sensor.off()\n" }, { "path": "shims/SeeedStudios/grove_py/tests/test_grove_light_sensor_v1_2.py", "content": "'''\nTests the Grove light sensor shim.\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running, with a light sensor\non pin 1 set to a value of 50\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_grove.grove_light_sensor_v1_2 import GroveLightSensor\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_light_sensor_light_is_50(init_counterfit_device):\n '''\n Tests the light property of the Grove Light Sensor shim\n '''\n sensor = GroveLightSensor(0)\n assert sensor.light == 50\n" }, { "path": "shims/SeeedStudios/grove_py/tests/test_grove_relay.py", "content": "'''\nTests the Grove Relay shim.\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running, with a relay actuator\non pin 1.\n\nUncomment the relevant test below and run it to see the relay change state\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_grove.grove_relay import GroveRelay\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\n# def test_turn_relay_on(init_counterfit_device):\n# '''\n# Tests the on method of the Grove relay shim\n# '''\n# sensor = GroveRelay(1)\n# sensor.on()\n\ndef test_turn_relay_off(init_counterfit_device):\n '''\n Tests the off method of the Grove relay shim\n '''\n sensor = GroveRelay(1)\n sensor.off()\n" }, { "path": "shims/SeeedStudios/grove_py/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/SeeedStudios/seeed-python-si114x/README.md", "content": "# CounterFit Shims - Grove\n\n![Grove Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-seeed-python-si114x)](https://pypi.org/project/counterfit-shims-seeed-python-si114x)\n\nShims for the Seeed Grove SI114X sunlight sensor to use with the [CounterFit virtual IoT device app](https://github.com/CounterFit-IoT/CounterFit).\n\nSee the [Seeed Python SI114X Docs](https://github.com/Seeed-Studio/Seeed_Python_SI114X) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate hardware created.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-seeed-python-si114x\n ```\n\n* Import the Grove modules as normal, but using the `counterfit_shims_seeed_python_si114x` package instead of the `seeed-python-si114x` package, as well as importing the `CounterFitConnection` from the `counterfit_shims_grove.counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_seeed_python_si114x import si114x\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your Grove code as usual. The default assumes you have a light sensor on pin 0, IR on pin 1 and UV on pin 2. You can change these passing additional arguments to the init\n\n ```python\n sensor =.si114x()\n light = sensor.ReadVisible()\n ir = sensor.ReadIR()\n uv = sensor.ReadUV()\n ```\n" }, { "path": "shims/SeeedStudios/seeed-python-si114x/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/SeeedStudios/seeed-python-si114x/counterfit_shims_seeed_si114x.py", "content": "'''\nThis is the code for\n - `Grove - Sunlight sensor `_\n\nExamples:\n\n .. code-block:: python\n import time\n from counterfit_connection import CounterFitConnection\n import counterfit_shims_seeed_si114x\n\n # Init the connection to the CounterFit Virtual IoT Device app\n CounterFitConnection.init('127.0.0.1', 5000)\n\n light_sensor = seeed_si114x.grove_si114x()\n\n light = light_sensor.ReadVisible\n'''\n# pylint: disable=too-few-public-methods,unused-argument\n\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['grove_si114x']\n\nclass grove_si114x():\n '''\n Class for Grove SI114X\n Args:\n light_pin(int): The pin for the light sensor\n ir_pin(int): The pin for the IR sensor\n uv_pin(int): The pin for the UV sensor\n '''\n def __init__(self, light_pin = 0, ir_pin = 1, uv_pin = 2):\n self.__light_pin = light_pin\n self.__ir_pin = ir_pin\n self.__uv_pin = uv_pin\n\n @property\n def ReadVisible(self):\n '''\n Read the visible light from the sensor\n '''\n return CounterFitConnection.get_sensor_int_value(self.__light_pin)\n\n @property\n def ReadIR(self):\n '''\n Read the IR light from the sensor\n '''\n return CounterFitConnection.get_sensor_int_value(self.__ir_pin)\n\n @property\n def ReadUV(self):\n '''\n Read the IR light from the sensor\n '''\n return CounterFitConnection.get_sensor_int_value(self.__uv_pin)\n" }, { "path": "shims/SeeedStudios/seeed-python-si114x/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection" }, { "path": "shims/SeeedStudios/seeed-python-si114x/setup.py", "content": "'''\nShims for the Seeed Python SI144X library for use with the CounterFit Virtual IoT Device app\n'''\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-seeed-python-si114x',\n py_modules=['counterfit_shims_seeed_python_si114x'],\n version='0.1.0.dev1',\n description='Shims for the Seeed Grove SI144X Sunlight sensor for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot grove seeed virtual hardware\",\n install_requires=['requests','counterfit-connection'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/SeeedStudios/seeed-python-si114x/tests/__init__.py", "content": "" }, { "path": "shims/SeeedStudios/seeed-python-si114x/tests/test_counterfit_shims_seeed_si114x.py", "content": "'''\nTests the Grove SI114X.\n\nTo run this test, ensure you have the CounterFit Virtual IoT Device app running, with a light sensor\non pin 0, a IR sensor on pin 1, and a UV sensor on pin 2.\n\nThe light sensor should be set to 500, the IR sensor to 750, and the UV sensor to 1000\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_seeed_si114x import grove_si114x\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_humidity_and_temperature(init_counterfit_device):\n '''\n Tests values returned from the SI114X sensor\n '''\n sensor = grove_si114x()\n\n assert sensor.ReadVisible == 500\n assert sensor.ReadIR == 750\n assert sensor.ReadUV == 1000\n" }, { "path": "shims/SeeedStudios/seeed-python-si114x/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/picamera/.gitignore", "content": "test_image*.*" }, { "path": "shims/picamera/README.md", "content": "# CounterFit Shims - Picamera\n\n![Picamera Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-picamera)](https://pypi.org/project/counterfit-shims-picamera)\n\nShims for the Picamera to read from a virtual camera\n\nSee the [Picamera Docs](https://picamera.readthedocs.io/) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate camera hardware created. Create the camera with a name of `Picamera`.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-picamera\n ```\n\n* Import Picamera using the `counterfit_shims_picamera` package instead of the `picamera` package, as well as importing the `CounterFitConnection` from the `counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n import counterfit_shims_picamera\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your Picamera code as usual.\n\n For example, to capture an image as a JPEG:\n\n ```python\n camera = PiCamera()\n image = io.BytesIO()\n camera.capture(image, 'jpeg')\n ```\n" }, { "path": "shims/picamera/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/picamera/counterfit_shims_picamera/__init__.py", "content": "'''\nThe picamera package consists of several modules which provide a pure Python\ninterface to the Raspberry Pi's camera module.\n'''\n\nfrom counterfit_shims_picamera.camera import PiCamera\n" }, { "path": "shims/picamera/counterfit_shims_picamera/camera.py", "content": "'''\nThe picamera package consists of several modules which provide a pure Python\ninterface to the Raspberry Pi's camera module.\n'''\n# pylint: disable=import-error\nfrom counterfit_connection import CounterFitConnection\nfrom PIL import Image\n\nclass PiCamera():\n '''\n Provides a pure Python interface to a virtual Raspberry Pi camera module.\n '''\n # pylint: disable=unused-argument\n def __init__(self, resolution = None, **kwargs):\n if resolution is not None:\n self.__width: int = resolution[0]\n self.__height: int = resolution[1]\n else:\n self.__width = -1\n self.__height = -1\n\n self.__rotation = 0\n\n @property\n def resolution(self):\n '''\n Retrieves or sets the resolution at which image captures, video\n recordings, and previews will be captured.\n '''\n return (self.__width, self.__height)\n\n @resolution.setter\n def resolution(self, val):\n '''\n Retrieves or sets the resolution at which image captures, video\n recordings, and previews will be captured.\n '''\n self.__width = int(val[0])\n self.__height = int(val[1])\n\n @property\n def rotation(self):\n '''\n Retrieves or sets the current rotation of the camera's image.\n '''\n return self.__rotation\n\n @rotation.setter\n def rotation(self, val: int):\n '''\n Retrieves or sets the current rotation of the camera's image.\n '''\n self.__rotation = val\n\n def __resize_and_crop(self, image: Image) -> Image:\n width_adjust = self.__width / image.size[0]\n height_adjust = self.__height / image.size[1]\n\n max_adjust = max([width_adjust, height_adjust])\n\n new_width = int(image.size[0] * max_adjust)\n new_height = int(image.size[1] * max_adjust)\n\n image = image.resize((new_width, new_height))\n\n left = 0\n bottom = 0\n\n if image.size[0] > self.__width:\n left = int((image.size[0] - self.__width) / 2)\n if image.size[1] > self.__height:\n bottom = int((image.size[1] - self.__height) / 2)\n\n image = image.crop((left, bottom, self.__width + left, self.__height + bottom))\n\n return image\n\n def capture(self, output, image_format=None):\n '''\n Capture an image from the camera, storing it in *output*.\n '''\n # read the image from Counterfit\n raw_image = CounterFitConnection.read_binary_sensor('Picamera')\n raw_image.seek(0)\n\n image = Image.open(raw_image)\n\n if self.__rotation > 0:\n image = image.rotate(self.__rotation, expand=True)\n\n if self.__width > 0 and self.__height > 0:\n image = self.__resize_and_crop(image)\n\n image.save(output, format=image_format)\n" }, { "path": "shims/picamera/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection\npillow=9.4.0\n" }, { "path": "shims/picamera/setup.py", "content": "'''\nShims for the Picamera library for use with the CounterFit Virtual IoT Device app\n'''\n# pylint: disable=redefined-builtin\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import find_packages, setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-picamera',\n packages=find_packages(include=['counterfit_shims_picamera']),\n version='0.1.0.dev5',\n description='Shims for the PiCamera library for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot picamera camera virtual hardware\",\n install_requires=['requests','counterfit-connection','pillow'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/picamera/tests/__init__.py", "content": "" }, { "path": "shims/picamera/tests/test_counterfit_shims_picamera.py", "content": "'''\nTests the PySerial connection.\n\nTo test this, launch CounterFit, and add 2 GPS sensors, one on /dev/tty0 and one on /dev/tty1.\nSet them both to NMEA data, and the data as hello\\nworld\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nimport counterfit_shims_picamera\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_capture(init_counterfit_device):\n '''\n Tests capturing an image\n '''\n camera = counterfit_shims_picamera.PiCamera()\n camera.capture('test_image.png')\n camera.capture('test_image.jpeg')\n \ndef test_rotate(init_counterfit_device):\n '''\n Tests capturing an image\n '''\n camera = counterfit_shims_picamera.PiCamera()\n camera.rotation = 90\n camera.capture('test_image_rotate_90.jpeg')\n \n camera.rotation = 180\n camera.capture('test_image_rotate_180.jpeg')\n \n camera.rotation = 270\n camera.capture('test_image_rotate_270.jpeg')\n \ndef test_resolution_init(init_counterfit_device):\n '''\n Tests capturing an image\n '''\n camera = counterfit_shims_picamera.PiCamera((1024,768))\n camera.capture('test_image_resolution_1024_768_init.jpeg')\n \ndef test_resolution(init_counterfit_device):\n '''\n Tests capturing an image\n '''\n camera = counterfit_shims_picamera.PiCamera()\n camera.resolution = (1024,768)\n camera.capture('test_image_resolution_1024_768.jpeg')\n \ndef test_resolution_and_rotate(init_counterfit_device):\n '''\n Tests capturing an image\n '''\n camera = counterfit_shims_picamera.PiCamera()\n camera.rotation = 90\n camera.resolution = (1024,768)\n camera.capture('test_image_rotate_resolution_1024_768.jpeg')\n" }, { "path": "shims/picamera/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/pyserial/README.md", "content": "# CounterFit Shims - PySerial\n\n![PySerial Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-serial)](https://pypi.org/project/counterfit-shims-serial)\n\nShims for the PySerial to read sensors that use a virtual serial port\n\nSee the [PySerial Docs](https://pyserial.readthedocs.io/en/latest/pyserial.html) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate hardware created.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-serial\n ```\n\n* Import PySerial using the `counterfit_shims_serial` package instead of the `serial` package, as well as importing the `CounterFitConnection` from the `counterfit_shims_grove.counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n import counterfit_shims_serial\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your PySerial code as usual, setting the port to match the one you set in the CounterFit app.\n\n For example, create a UART sensor on port `/dev/ttyAMA0`:\n\n ```python\n serial = counterfit_shims_serial.Serial('/dev/ttyAMA0', 9600, timeout=1)\n ```\n\n The baud and timeout settings are ignored.\n" }, { "path": "shims/pyserial/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/pyserial/counterfit_shims_serial.py", "content": "# pylint: disable=unused-argument,import-error\n'''Shims for PySerial\n'''\n\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['Serial']\n\nclass Serial():\n '''Shims for the PySerial Serial class\n '''\n def __init__(self, port: str, baud: int = 9600, **kwargs):\n self.__port = port\n\n def read(self, **kwargs) -> bytes:\n '''Reads a character from the serial port\n '''\n return CounterFitConnection.read_serial_sensor_char(self.__port).encode('utf-8')\n\n def readline(self, **kwargs) -> bytes:\n '''Reads a line from the serial port\n '''\n return CounterFitConnection.read_serial_sensor_line(self.__port).encode('utf-8')\n\n def reset_input_buffer(self):\n '''Does nothing - here for PySerial compatability\n '''\n\n def flush(self):\n '''Does nothing - here for PySerial compatability\n '''\n" }, { "path": "shims/pyserial/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection\n" }, { "path": "shims/pyserial/setup.py", "content": "'''\nShims for the PySerial library for use with the CounterFit Virtual IoT Device app\n'''\n# pylint: disable=redefined-builtin\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-serial',\n py_modules=['counterfit_shims_serial'],\n version='0.1.0.dev3',\n description='Shims for the PySerial library for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot pyserial serial virtual hardware\",\n install_requires=['requests','counterfit-connection'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/pyserial/tests/__init__.py", "content": "" }, { "path": "shims/pyserial/tests/test_counterfit_shims_serial.py", "content": "'''\nTests the PySerial connection.\n\nTo test this, launch CounterFit, and add 2 GPS sensors, one on /dev/tty0 and one on /dev/tty1.\nSet them both to NMEA data, and the data as hello\\nworld\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nimport counterfit_shims_serial\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_read(init_counterfit_device):\n '''\n Tests values returned from the Serial port\n '''\n serial = counterfit_shims_serial.Serial('/dev/tty0')\n assert serial.read().decode('utf-8') == 'h'\n assert serial.read().decode('utf-8') == 'e'\n assert serial.read().decode('utf-8') == 'l'\n assert serial.read().decode('utf-8') == 'l'\n assert serial.read().decode('utf-8') == 'o'\n assert serial.read().decode('utf-8') == '\\n'\n assert serial.read().decode('utf-8') == 'w'\n assert serial.read().decode('utf-8') == 'o'\n assert serial.read().decode('utf-8') == 'r'\n assert serial.read().decode('utf-8') == 'l'\n assert serial.read().decode('utf-8') == 'd'\n\ndef test_read_line(init_counterfit_device):\n '''\n Tests values returned from the Serial port\n '''\n serial = counterfit_shims_serial.Serial('/dev/tty1', 9600, timeout=1)\n assert serial.readline().decode('utf-8') == 'hello'\n assert serial.readline().decode('utf-8') == 'world'\n" }, { "path": "shims/pyserial/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" }, { "path": "shims/rpi_vl53l0x/README.md", "content": "# CounterFit Shims - VL53L0X distance sensor\n\n![RPI_VL53L0X Shim](https://img.shields.io/badge/Platform-Python-green) [![PyPI](https://img.shields.io/pypi/v/counterfit-shims-rpi-vl53l0x)](https://pypi.org/project/counterfit-shims-rpi-vl53l0x)\n\nShims for the Rpi-VL53L0X distance sensor.\n\nSee the [Rpi-VL53L0X Docs](https://github.com/turmary/VL53L0X_rasp) for the API documentation.\n\n## Getting started\n\nTo use these shims, you will need to install [CounterFit](https://github.com/CounterFit-IoT/CounterFit) and have it running, with the appropriate hardware created.\n\n* Install this package from pip:\n\n ```sh\n pip install counterfit-shims-rpi-vl53l0x\n ```\n\n* Import VL53L0X using the `counterfit_shims_rpi-vl53l0x` package instead of the `rpi-vl53l0x` package, as well as importing the `CounterFitConnection` from the `counterfit_connection` module:\n\n ```python\n from counterfit_connection import CounterFitConnection\n from counterfit_shims_rpi_vl53l0x.vl53l0x import VL53L0X\n ```\n\n* Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:\n\n ```python\n CounterFitConnection.init('127.0.0.1', 5000)\n ```\n\n* Write your VL53L0X code as usual, setting the I2C address to match the one you set in the CounterFit app.\n\n For example, create a distance sensor on port `0x29`:\n\n ```python\n distance_sensor = VL53L0X(0x29)\n ```\n\n" }, { "path": "shims/rpi_vl53l0x/build.sh", "content": "rm ./dist/*\npython3 setup.py bdist_wheel" }, { "path": "shims/rpi_vl53l0x/counterfit_shims_rpi_vl53l0x/__init__.py", "content": "'''\nThe picamera package consists of several modules which provide a pure Python\ninterface to the Raspberry Pi's camera module.\n'''\n\nfrom counterfit_shims_rpi_vl53l0x.vl53l0x import VL53L0X\n" }, { "path": "shims/rpi_vl53l0x/counterfit_shims_rpi_vl53l0x/vl53l0x.py", "content": "# pylint: disable=unused-argument,import-error\n'''Shims for PySerial\n'''\n\nfrom counterfit_connection import CounterFitConnection\n\n__all__ = ['VL53L0X']\n\nclass VL53L0X(object):\n def __init__(self, address:int = 0x29):\n self.__address = address\n\n def get_libver(self):\n return 'VL53L0X for CounterFit'\n\n def get_devver(self):\n return 'VL53L0X for CounterFit'\n\n def begin(self):\n return 0\n\n def wait_ready(self):\n '''\n return None -- Error status\n False -- Timeout\n True -- Ready\n '''\n return CounterFitConnection.is_connected()\n\n def get_distance(self):\n return CounterFitConnection.get_sensor_int_value(self.__address)" }, { "path": "shims/rpi_vl53l0x/requirements.txt", "content": "wheel=0.38.4\nsetuptools=65.5.0\ntwine=4.0.2\npytest=7.2.2\npytest-runner=6.0.0\nrequests=2.28.2\npylint=2.16.2\ncounterfit-connection\n" }, { "path": "shims/rpi_vl53l0x/setup.py", "content": "'''\nShims for the rpi_vl53l0x library for use with the CounterFit Virtual IoT Device app\n'''\n# pylint: disable=redefined-builtin\n\nfrom codecs import open\nfrom os import path\nfrom setuptools import find_packages, setup\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name='counterfit-shims-rpi-vl53l0x',\n packages=find_packages(include=['counterfit_shims_rpi_vl53l0x']),\n version='0.1.0.dev3',\n description='Shims for the rpi_vl53l0x library for the CounterFit virtual IoT device app',\n long_description=long_description,\n long_description_content_type='text/markdown',\n author='Jim Bennett',\n url=\"https://github.com/CounterFit-IoT/CounterFit\",\n license='MIT',\n classifiers=[\n \"Development Status :: 2 - Pre-Alpha\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: System :: Hardware\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\"\n ],\n keywords=\"iot rpi_vl53l0x vl53l0x virtual hardware\",\n install_requires=['requests','counterfit-connection'],\n setup_requires=['pytest-runner'],\n tests_require=['pytest==4.4.1'],\n test_suite='tests',\n)\n" }, { "path": "shims/rpi_vl53l0x/tests/__init__.py", "content": "" }, { "path": "shims/rpi_vl53l0x/tests/test_counterfit_shims_rpi_vl53l0x.py", "content": "'''\nTests the RPI VL53L0X connection\n\nCreate a distance sensor at the address 0x29 and set the distance to 100mm\n\n'''\n# pylint: disable=redefined-outer-name,unused-argument\n\nimport pytest\n\nfrom counterfit_connection import CounterFitConnection\nfrom counterfit_shims_rpi_vl53l0x.vl53l0x import VL53L0X\n\n@pytest.fixture\ndef init_counterfit_device():\n '''\n Test fixture to initialise the connection to the CounterFit Virtual IoT device running on localhost on port 5000\n '''\n CounterFitConnection.init('127.0.0.1', 5000)\n\ndef test_get_distance(init_counterfit_device):\n '''\n Tests values returned from the Serial port\n '''\n distance_sensor = VL53L0X()\n distance_sensor.begin()\n\n if distance_sensor.wait_ready():\n assert distance_sensor.get_distance() == 100\n\n" }, { "path": "shims/rpi_vl53l0x/upload.sh", "content": "python3 -m twine upload --repository pypi dist/*" } ]