{"id":13834456,"url":"https://github.com/avantec-iot/avantec-thingsboard","last_synced_at":"2025-07-10T04:32:21.869Z","repository":{"id":169223108,"uuid":"280077695","full_name":"avantec-iot/avantec-thingsboard","owner":"avantec-iot","description":"Using Avantec Thermostat with ThingsBoard","archived":false,"fork":false,"pushed_at":"2024-11-18T05:41:32.000Z","size":60674,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-18T06:34:44.332Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avantec-iot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-16T06:53:40.000Z","updated_at":"2024-11-18T05:41:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"f80ede9d-45f4-4608-9190-72ff2bee8fbd","html_url":"https://github.com/avantec-iot/avantec-thingsboard","commit_stats":null,"previous_names":["avantec-iot/avantec-thingsboard"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avantec-iot%2Favantec-thingsboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avantec-iot%2Favantec-thingsboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avantec-iot%2Favantec-thingsboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avantec-iot%2Favantec-thingsboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avantec-iot","download_url":"https://codeload.github.com/avantec-iot/avantec-thingsboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225618850,"owners_count":17497592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T14:00:35.023Z","updated_at":"2024-11-20T19:32:05.765Z","avatar_url":"https://github.com/avantec-iot.png","language":null,"funding_links":[],"categories":["Integrations"],"sub_categories":["Hardware"],"readme":"# Using Avantec HVAC devices with ThingsBoard\n\n* [Read document](https://avantec-thingsboard.readthedocs.org)\n* [Install tools](#install-tools)\n* [Build document](#generate-web-pages)\n\n\nThis technical document is in the format of [reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html) and Markdown/[CommonMark](https://commonmark.org/). It's generated using [Sphinx](https://www.sphinx-doc.org/).\n\n## Install tools\n\n### Prerequisites\n\n* Install Python 3.5+ (for Sphinx).\n\n\u003c!-- * Install Java 8 or later (for sphinxcontrib-plantuml). --\u003e\n\n\u003c!-- ### Step 1. Install Graphviz on Windows (for plantuml)\n\n1. Download **Graphviz 2.38 Stable Release** from this [link](https://graphviz.org/_pages/Download/Download_windows.html).\n\n2. Execute this windows installation package. The default installation path is: ***C:\\Program Files (x86)\\GraphvizX.XX\\bin*** (Example: Graphviz**X.XX** → Graphviz**2.38**).\n\n3. Set the PATH system variable and add `C:\\Program Files (x86)\\GraphvizX.XX\\bin` to the existing path, eg: `C:\\Program Files (x86)\\Graphviz2.38\\bin`.\n\n4. Check with `dot -version` at the command prompt whether your changes are reflected:\n\n    ```log\n    C:\\Users\\Avantec\u003edot -version\n    dot - graphviz version 2.38.0 (20140413.2041)\n    libdir = \"C:\\Program Files (x86)\\Graphviz2.38\\bin\"\n    Activated plugin library: gvplugin_dot_layout.dll\n    Using layout: dot:dot_layout\n    Activated plugin library: gvplugin_core.dll\n    ...\n    ``` --\u003e\n\n### Step 1. Install Sphinx\n\nSphinx is a tool that makes it easy to create documentation.\n\nSphinx_intl is a useful tool for internationalization and localization.\n\n1. On Windows, you should open Command Prompt (⊞Win-r and type **cmd**) and run the same command.\n    \n    It is a good moment to create a Python virtual environment and install the required tools. For that, open a command line terminal, `cd` into the directory you just created, and run the following commands \u003chttps://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment\u003e:\n\n    * Windows:\n\n    ```cmd\n    \u003e cd /path/to/project\n    \u003e python -m venv .venv                               # Creating a virtual environment\n    \u003e .\\.venv\\Scripts\\activate                           # Activating a virtual environment\n    (.venv) \u003e where python                               # ...\\.venv\\Scripts\\python.exe\n    (.venv) \u003e python -m pip install sphinx sphinx_intl   # Installing packages\n    (.venv) \u003e ...\n    (.venv) \u003e deactivate                                 # Leaving the virtual environment\n    ```\n\n    * Linux:\n\n    ```sh\n    $ cd /path/to/project\n    $ python -m venv .venv                               # Creating a virtual environment\n    $ source .venv/bin/activate                          # Activating a virtual environment\n    (.venv) $ which python                               # .../env/bin/python\n    (.venv) $ python -m pip install sphinx sphinx_intl   # Installing packages\n    (.venv) $ ...\n    (.venv) $ deactivate                                 # Leaving the virtual environment\n    ```\n\n    ***Note: venv will create a virtual Python installation in the `.venv` folder. You should exclude your virtual environment directory from your version control system using `.gitignore` or similar.***\n\n2. After installation, type `sphinx-build --version` on the command prompt. If everything worked fine, you will see the version number for the Sphinx package you just installed.\n\n3. Sphinx comes with a script called **sphinx-quickstart** that sets up a source directory and creates a default **conf.py** with the most useful configuration values from a few questions it asks you. To use this, run:\n\n    ```sh\n    cd /path/to/project\n    (.venv) $ sphinx-quickstart docs\n    cd docs\n    ```\n\n    We will be presented with a series of questions, the answer to which can depend from project to project.\n\n    Now we can see that some foldes and files have been autogenerated for us:\n\n    * `conf.py` : This is the file where all Sphinx configuration settings (including the settings we specified during the sphinx-quickstart setup) are specified.\n    * `index.rst` : This is the file which tells Sphinx how to render our index.html page.\n    * `_static` : image, script, etc.\n    * `_build` : This is the directory where the output of any builder is stored when a `make \u003cbuilder\u003e` is called.\n\n### Step 2. Install recommonmark\n\nYou can use **Markdown** and reStructuredText in the same Sphinx project.\n\n1. Run the following command (using Command Prompt):\n\n    ```sh\n    (.venv) $ pip install recommonmark\n    ```\n\n2. Then in your `conf.py`:\n\n    ```python\n    extensions = ['recommonmark']\n    extensions = ['sphinx.ext.autodoc']\n    ```\n\n    **Note**: You should skip this step(2). The above code is already in you `conf.py`.\n\n**warning**: Markdown doesn’t support a lot of the features of Sphinx, like inline markup and directives. However, it works for basic prose content. reStructuredText is the preferred format for technical documentation\n\n### Step 3. Install sphinx_rtd_theme\n\nSphinx_rtd_theme is a html theme.\n\n1. Run the following command (using Command Prompt):\n\n    ```sh\n    (.venv) $ pip install sphinx_rtd_theme\n    ```\n\n2. Add this theme extension module in ```conf.py```\n\n    ```python\n    html_theme = 'alabaster'\n    ```\n\n    to\n\n    ```python\n    # html_theme = 'alabaster'\n    import sphinx_rtd_theme\n    html_theme = \"sphinx_rtd_theme\"\n    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n    ```\n\n    **Note**: You should skip this step(2). The above code is already in you `conf.py`.\n\n### Step 5. Install PlantUML\n\nPlantuml is a library for generating UML diagrams from a simple text markup language.\n\n1. On Windows, run the following command (using Command Prompt):\n\n    ```sh\n    (.venv) $ pip install plantweb\n    ```\n\u003c!--\n2. Add this *UML* extension modules in ```conf.py```:\n\n    ```python\n    extensions = ['plantweb.directive']\n    ```\n\n    **Note**: You may skip this step(2). The above code is already in you `conf.py`.\n--\u003e\n\n\u003c!-- ### Step 5. Install sphinxcontrib-plantuml\n\nPlantuml is a library for generating UML diagrams from a simple text markup language.\n\n1. On Windows, run the following command (using Command Prompt):\n\n    ```sh\n    pip install sphinxcontrib-plantuml\n    # pip install plantweb\n    ```\n\n    **note**: When you install **sphinxcontrib-plantuml**, you may get a error: *attributeerror '_namespacepath' object has no attribute 'sort'*. Please execute command `python -m pip install --upgrade pip setuptools wheel` to fixed it.\n\n2. Download plantuml.xxx.jar from this [link](https://plantuml.com/en/download), then save it to `docs\\tool\\`.\n\n    **Note**: You may skip this step(2), because we already save `plantuml.xxx.jar` in `docs/tool/`.\n\n3. Check with `java -jar docs\\tool\\plantuml.xxx.jar -version` at the command prompt whether your changes are reflected:\n\n    ```log\n    PlantUML version 1.2020.15 (Sun Jun 28 19:39:45 CST 2020)\n    (GPL source distribution)\n    Java Runtime: OpenJDK Runtime Environment\n    JVM: OpenJDK 64-Bit Server VM\n    Default Encoding: MS950_HKSCS\n    Language: zh\n    Country: HK\n\n    PLANTUML_LIMIT_SIZE: 4096\n\n    Dot version: dot - graphviz version 2.38.0 (20140413.2041)\n    Installation seems OK. File generation OK\n    ```\n\n4. Add this *UML* extension modules in ```conf.py```:\n\n    ```python\n    extensions = ['sphinxcontrib.plantuml']\n\n    import os\n    plantuml_relative_path_ = r'tool\\plantuml.1.2020.15.jar'\n    plantuml = 'java -jar ' + os.path.join(os.path.abspath(os.getcwd()), plantuml_relative_path_)\n    ```\n\n    **Note**: You may skip this step(4). The above code is already in you `conf.py`. --\u003e\n\n## Generate web pages\n\nYou can following this command to build HTML document at `docs\\`:\n\n```shell\nmake html  #.\\make html #windows\n```\n\nYour `index.rst` has been built into `index.html` in your documentation output directory (typically `_build/html/index.html`). Open this file in your web browser to see your docs.\n\n## Licenses\n\nThis project is released under [Apache 2.0 License](./LICENSE).\n\n\u003c!-- [plantuml.jar](https://plantuml.com/) is released under [Apache 2.0 License](./docs/tool/COPYING). --\u003e\n\n\u003c!-- [ThingsBoard document](https://github.com/thingsboard/thingsboard.github.io) is released under [Apache 2.0 License](https://github.com/thingsboard/thingsboard.github.io/blob/master/LICENSE). --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favantec-iot%2Favantec-thingsboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favantec-iot%2Favantec-thingsboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favantec-iot%2Favantec-thingsboard/lists"}