| Name | indiredis JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | None |
| Summary | An INDI web client for general Instrument control. If the package is run, it provides a web service for controlling instruments. If imported, it provides functions which can be adapted to your own web server. |
| upload_time | 2023-07-20 11:45:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
indi
client
astronomy
instrument
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
indi-mr
paho-mqtt
redis
skipole
waitress
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# indiredis
This Python3 package provides an INDI web client for general Instrument control.
INDI - Instrument Neutral Distributed Interface.
See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
The package does not include indiserver or drivers, but is compatable with them, indiserver is an application (debian package indi-bin) which runs instrument drivers, and listens on port 7624. This client can connect to this port, and then serves web pages allowing the user to control the connected instruments.
Though the INDI protocol is generally used for astronomical instruments, it can work with any instrument if appropriate INDI drivers are available.
If this indiredis package is imported it provides functions for running a web client connected to either: an INDI server port; an MQTT server; or directly to INDI instrument drivers.
If indiredis is run with the python -m option, then the web client is started and connects to an INDI server port.
This web client uses a redis database to hold instrument values, so a redis instance is needed, generally running on the same host as indiredis.
For example:
Your host typically has instruments connected by appropriate drivers and indiserver. For example, in one terminal, run:
> indiserver -v indi_simulator_telescope indi_simulator_ccd
Usage of this client is then:
> python3 -m indiredis /path/to/blobfolder
The directory /path/to/blobfolder should be a path to a directory of your choice, where BLOB's (Binary Large Objects), such as images will be stored, it will be created if it does not exist. Then connecting with a browser to http://localhost:8000 should enable you to view and control the connected instruments.
For further usage information, including setting ports and hosts, try:
> python3 -m indiredis --help
If the package is imported into your own scripts, it provides a runclient function which accepts a configuration file. This file specifies the INDI drivers to run, or the MQTT or indiserver connections to use. The function then runs the web client.
## Installation
Server dependencies: A redis server (For debian systems; apt-get install redis-server), and indiserver with drivers (apt-get install indi-bin).
For debian systems you may need apt-get install python3-pip, and then use whichever variation of the pip command required by your environment, one example being:
> python3 -m pip install indiredis
Or - if you just want to install it with your own user permissions only:
> python3 -m pip install --user indiredis
Using a virtual environment may be preferred, if you need further information on pip and virtual environments, try:
https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
The above pip command should automatically pull in the following packages:
indi-mr - converts between the XML data received via the indiserver port and redis storage
skipole - framework used to build the web pages.
waitress - Python web server.
redis - Python redis client.
paho-mqtt - Python mqtt client.
## Documentation
Detailed information is available at:
https://indiredis.readthedocs.io
Raw data
{
"_id": null,
"home_page": null,
"name": "indiredis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "indi,client,astronomy,instrument",
"author": null,
"author_email": "Bernard Czenkusz <bernie@skipole.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/d0/e8/9e31f74d16ff7b6d4e1dca4d84dd8d39c875533daafdbbc915529b2562d9/indiredis-0.7.2.tar.gz",
"platform": null,
"description": "# indiredis\n\n\nThis Python3 package provides an INDI web client for general Instrument control.\n\nINDI - Instrument Neutral Distributed Interface.\n\nSee https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface\n\nThe package does not include indiserver or drivers, but is compatable with them, indiserver is an application (debian package indi-bin) which runs instrument drivers, and listens on port 7624. This client can connect to this port, and then serves web pages allowing the user to control the connected instruments.\n\nThough the INDI protocol is generally used for astronomical instruments, it can work with any instrument if appropriate INDI drivers are available.\n\nIf this indiredis package is imported it provides functions for running a web client connected to either: an INDI server port; an MQTT server; or directly to INDI instrument drivers.\n\nIf indiredis is run with the python -m option, then the web client is started and connects to an INDI server port.\n\nThis web client uses a redis database to hold instrument values, so a redis instance is needed, generally running on the same host as indiredis.\n\n For example:\n\nYour host typically has instruments connected by appropriate drivers and indiserver. For example, in one terminal, run:\n\n> indiserver -v indi_simulator_telescope indi_simulator_ccd\n\nUsage of this client is then:\n\n> python3 -m indiredis /path/to/blobfolder\n\nThe directory /path/to/blobfolder should be a path to a directory of your choice, where BLOB's (Binary Large Objects), such as images will be stored, it will be created if it does not exist. Then connecting with a browser to http://localhost:8000 should enable you to view and control the connected instruments.\n\nFor further usage information, including setting ports and hosts, try:\n\n> python3 -m indiredis --help\n\nIf the package is imported into your own scripts, it provides a runclient function which accepts a configuration file. This file specifies the INDI drivers to run, or the MQTT or indiserver connections to use. The function then runs the web client.\n\n\n## Installation\n\nServer dependencies: A redis server (For debian systems; apt-get install redis-server), and indiserver with drivers (apt-get install indi-bin).\n\nFor debian systems you may need apt-get install python3-pip, and then use whichever variation of the pip command required by your environment, one example being:\n\n> python3 -m pip install indiredis\n\nOr - if you just want to install it with your own user permissions only:\n\n> python3 -m pip install --user indiredis\n\nUsing a virtual environment may be preferred, if you need further information on pip and virtual environments, try:\n\nhttps://packaging.python.org/guides/installing-using-pip-and-virtual-environments/\n\nThe above pip command should automatically pull in the following packages:\n\nindi-mr - converts between the XML data received via the indiserver port and redis storage\n\nskipole - framework used to build the web pages.\n\nwaitress - Python web server.\n\nredis - Python redis client.\n\npaho-mqtt - Python mqtt client.\n\n\n## Documentation\n\nDetailed information is available at:\n\nhttps://indiredis.readthedocs.io\n",
"bugtrack_url": null,
"license": null,
"summary": "An INDI web client for general Instrument control. If the package is run, it provides a web service for controlling instruments. If imported, it provides functions which can be adapted to your own web server.",
"version": "0.7.2",
"project_urls": {
"Documentation": "https://indiredis.readthedocs.io",
"Source": "https://github.com/bernie-skipole/indi"
},
"split_keywords": [
"indi",
"client",
"astronomy",
"instrument"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d43cea9d2f99d0e57d4bea3c011f19f6aabfa4abb3f2950ee4c82c94ccaa5837",
"md5": "469a81043bedb5173447005cfaf442ad",
"sha256": "91454488732094c0079b81f1dcbab8e2c92ce8eba198e0ed321398d9dcba4eb6"
},
"downloads": -1,
"filename": "indiredis-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "469a81043bedb5173447005cfaf442ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 38959,
"upload_time": "2023-07-20T11:45:19",
"upload_time_iso_8601": "2023-07-20T11:45:19.392828Z",
"url": "https://files.pythonhosted.org/packages/d4/3c/ea9d2f99d0e57d4bea3c011f19f6aabfa4abb3f2950ee4c82c94ccaa5837/indiredis-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d0e89e31f74d16ff7b6d4e1dca4d84dd8d39c875533daafdbbc915529b2562d9",
"md5": "aa7825610635af32168ed0d86d4d7ab4",
"sha256": "83106d4e132c28fb9acacfbcd1b4d20464973df7e61effc2e657aaf50d453139"
},
"downloads": -1,
"filename": "indiredis-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "aa7825610635af32168ed0d86d4d7ab4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 35383,
"upload_time": "2023-07-20T11:45:26",
"upload_time_iso_8601": "2023-07-20T11:45:26.530267Z",
"url": "https://files.pythonhosted.org/packages/d0/e8/9e31f74d16ff7b6d4e1dca4d84dd8d39c875533daafdbbc915529b2562d9/indiredis-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 11:45:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bernie-skipole",
"github_project": "indi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "indi-mr",
"specs": [
[
">=",
"0.2.3"
]
]
},
{
"name": "paho-mqtt",
"specs": [
[
">=",
"1.5.1"
]
]
},
{
"name": "redis",
"specs": [
[
">=",
"3.5.3"
]
]
},
{
"name": "skipole",
"specs": [
[
">=",
"5.5.2"
]
]
},
{
"name": "waitress",
"specs": [
[
">=",
"1.4.4"
]
]
}
],
"lcname": "indiredis"
}
