| Name | ESIRemote JSON |
| Version |
0.5
JSON |
| download |
| home_page | None |
| Summary | Python library for remote controlling the environment in FwESI |
| upload_time | 2024-09-05 08:29:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 dieser-niko (dieserniko.link) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
fwesi
api
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ESIRemote
A Python library to remotely control the environment in [FwESI](https://fwesi.de/)
## Functionality
### FwESI
<details><summary>expand</summary>
FwESI has a remote control (basically a local web server) where the user can control the application without having to interact with the computer itself.
This includes actions such as
- loading save file/sub save
- controlling variables of a fire engine (such as the height and length of the ladder)
- start a fire (in FwESI)
- check state of door
- show/hide elements
The last action is still quite buggy with smoke in the latest tested version (1.10.1) and needs to be fixed by the FwESI developers.
Actions like video control are also a bit unstable.
What **CAN'T** be done:
- read/change coordinates of elements (like the user himself)
- get a livestream of the situation
- detect button presses (there are no buttons)
</details>
### ESIRemote
The library automatically parses the available objects (also called OperatorActors), parameters and save files as Python objects.
By default, ESIRemote allows the user to modify the attributes of these objects.
Changes are applied automatically, but this can be turned off.
Anything available on the remote server can be used with this library.
## Installation
ESIRemote is still in early development, but can already be installed using PyPI:
```console
pip install esiremote
```
## Quick Start
Check out the (TODO) examples directory to get an idea of how you can use ESIRemote.
Before you can use this library, make sure the remote server is enabled. You can enable it by default in the settings.
Also make sure you have objects with the remote option enabled.
```python3
from esiremote import ESIRemote
remote = ESIRemote()
for operatoractor in remote.operatoractors:
print(operatoractor.name)
```
This little example lists all elements available.
---
<details><summary>TODO list</summary>
- [ ] Add more docstrings and comments
- [x] Add more to readme (stuff like installation and usage)
- [x] Add more helper functions (like search by ID, name, type, etc)
- Maybe do something like a custom list object with a function called "search_by_attribute" or something
- [ ] remove test code
- [ ] add some examples (and maybe supply scenes)
- [ ] make sure it works flawlessly (check the models especially)
- [x] add `setup.py` or `pyproject.toml`
- [x] publish to PyPi with GH Actions
- [ ] add unittests
- [ ] Feature: load external save file (might not work at all)
</details>
Raw data
{
"_id": null,
"home_page": null,
"name": "ESIRemote",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "fwesi, api, wrapper",
"author": null,
"author_email": "\"@dieserniko\" <hello@dieserniko.link>",
"download_url": "https://files.pythonhosted.org/packages/3c/f3/6f2db5b0f2b09d07450be44f87cf95e4769671ff30abcd87a2388ce5b4ff/esiremote-0.5.tar.gz",
"platform": null,
"description": "# ESIRemote\n\nA Python library to remotely control the environment in [FwESI](https://fwesi.de/)\n\n## Functionality\n\n### FwESI\n<details><summary>expand</summary>\n\nFwESI has a remote control (basically a local web server) where the user can control the application without having to interact with the computer itself.\n\nThis includes actions such as\n- loading save file/sub save\n- controlling variables of a fire engine (such as the height and length of the ladder)\n- start a fire (in FwESI)\n- check state of door\n- show/hide elements\n\nThe last action is still quite buggy with smoke in the latest tested version (1.10.1) and needs to be fixed by the FwESI developers.\nActions like video control are also a bit unstable.\n\nWhat **CAN'T** be done:\n- read/change coordinates of elements (like the user himself)\n- get a livestream of the situation\n- detect button presses (there are no buttons)\n</details>\n\n### ESIRemote\nThe library automatically parses the available objects (also called OperatorActors), parameters and save files as Python objects.\n\nBy default, ESIRemote allows the user to modify the attributes of these objects.\nChanges are applied automatically, but this can be turned off.\n\nAnything available on the remote server can be used with this library.\n\n\n## Installation\n\nESIRemote is still in early development, but can already be installed using PyPI:\n```console\npip install esiremote\n```\n\n## Quick Start\nCheck out the (TODO) examples directory to get an idea of how you can use ESIRemote.\n\nBefore you can use this library, make sure the remote server is enabled. You can enable it by default in the settings.\n\nAlso make sure you have objects with the remote option enabled.\n```python3\nfrom esiremote import ESIRemote\n\nremote = ESIRemote()\nfor operatoractor in remote.operatoractors:\n print(operatoractor.name)\n```\nThis little example lists all elements available. \n\n---\n<details><summary>TODO list</summary>\n\n- [ ] Add more docstrings and comments\n- [x] Add more to readme (stuff like installation and usage)\n- [x] Add more helper functions (like search by ID, name, type, etc)\n - Maybe do something like a custom list object with a function called \"search_by_attribute\" or something\n- [ ] remove test code\n- [ ] add some examples (and maybe supply scenes)\n- [ ] make sure it works flawlessly (check the models especially)\n- [x] add `setup.py` or `pyproject.toml`\n- [x] publish to PyPi with GH Actions\n- [ ] add unittests\n- [ ] Feature: load external save file (might not work at all)\n</details>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 dieser-niko (dieserniko.link) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python library for remote controlling the environment in FwESI",
"version": "0.5",
"project_urls": {
"Homepage": "https://github.com/dieser-niko/ESIRemote",
"Issues": "https://github.com/dieser-niko/ESIRemote/issues",
"Repository": "https://github.com/dieser-niko/ESIRemote"
},
"split_keywords": [
"fwesi",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "568c182dae5a403874a8f26c2d0a16b9452e2c68a6b249f420884ecc6f0eb4f7",
"md5": "a9d6388320cfb2c5edf304c2356c20d9",
"sha256": "561f4ffbc00accafe261b02be4917d13b5830d361da37d62dac5157cbb62b647"
},
"downloads": -1,
"filename": "ESIRemote-0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9d6388320cfb2c5edf304c2356c20d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10757,
"upload_time": "2024-09-05T08:29:56",
"upload_time_iso_8601": "2024-09-05T08:29:56.547816Z",
"url": "https://files.pythonhosted.org/packages/56/8c/182dae5a403874a8f26c2d0a16b9452e2c68a6b249f420884ecc6f0eb4f7/ESIRemote-0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cf36f2db5b0f2b09d07450be44f87cf95e4769671ff30abcd87a2388ce5b4ff",
"md5": "5f18ffd7251fa133b3e7b8ec02141faa",
"sha256": "de6da7d3a55905a33651b401ced3395211c3030af9372a9619884320b093bec6"
},
"downloads": -1,
"filename": "esiremote-0.5.tar.gz",
"has_sig": false,
"md5_digest": "5f18ffd7251fa133b3e7b8ec02141faa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9303,
"upload_time": "2024-09-05T08:29:58",
"upload_time_iso_8601": "2024-09-05T08:29:58.525967Z",
"url": "https://files.pythonhosted.org/packages/3c/f3/6f2db5b0f2b09d07450be44f87cf95e4769671ff30abcd87a2388ce5b4ff/esiremote-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 08:29:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dieser-niko",
"github_project": "ESIRemote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "esiremote"
}
