| Name | indipyclient JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Pure python package, providing a terminal client and a set of classes which can be used to create scripts or clients to control remote instruments using the INDI protocol. |
| upload_time | 2024-05-05 14:36:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
indi
client
astronomy
instrument
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# indipyclient
Terminal client to communicate to an INDI service.
This is a pure python package, with no dependencies, providing an INDI terminal client.
It also provides a set of classes which can be used to create an INDI client. Either a script, or a GUI implementation could use this to generate the INDI protocol XML, and to create the connection to a port serving INDI drivers.
The client can be run with
indipyclient [options]
or with
python3 -m indipyclient [options]
The package help is:
usage: indipyclient [options]
Terminal client to communicate to an INDI service.
options:
-h, --help show this help message and exit
-p PORT, --port PORT Port of the INDI server (default 7624).
--host HOST Hostname/IP of the INDI server (default localhost).
-b BLOBS, --blobs BLOBS
Optional folder where BLOB's will be saved.
--loglevel LOGLEVEL Enables logging, value 1, 2, 3 or 4.
--logfile LOGFILE File where logs will be saved
--version show program's version number and exit
The BLOB's folder can also be set from within the session.
Setting loglevel and logfile should only be used for brief
diagnostic purposes, the logfile could grow very big.
loglevel:1 Information and error messages only,
loglevel:2 As 1 plus xml vector tags without members or contents,
loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,
loglevel:4 As 1 plus xml vectors and all contents
A typical sesssion would look like:
This is a companion package to 'indipydriver' which can be used to create INDI drivers.
INDI - Instrument Neutral Distributed Interface.
See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
The INDI protocol is defined so that drivers should operate with any INDI client.
The protocol defines the format of the data sent, such as light, number, text, switch or BLOB (Binary Large Object) and the client can send commands to control the instrument. The client can be general purpose, taking the format of switches, numbers etc., from the protocol.
INDI is often used with astronomical instruments, but is a general purpose protocol which can be used for any instrument control providing drivers are available.
Further documentation is available at:
https://indipyclient.readthedocs.io
If you are only using the terminal client, I recommend pipx, so to install you would use:
pipx install indipyclient
or if you want to run it, without installing:
pipx run indipyclient
Raw data
{
"_id": null,
"home_page": null,
"name": "indipyclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"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/d1/0e/6e4d78326a433e7da6370ddd55c3b5f96a1805d799c73e99343d8e1df246/indipyclient-0.1.1.tar.gz",
"platform": null,
"description": "# indipyclient\nTerminal client to communicate to an INDI service.\n\nThis is a pure python package, with no dependencies, providing an INDI terminal client.\n\nIt also provides a set of classes which can be used to create an INDI client. Either a script, or a GUI implementation could use this to generate the INDI protocol XML, and to create the connection to a port serving INDI drivers.\n\nThe client can be run with\n\nindipyclient [options]\n\nor with\n\npython3 -m indipyclient [options]\n\nThe package help is:\n\n usage: indipyclient [options]\n\n Terminal client to communicate to an INDI service.\n\n options:\n -h, --help show this help message and exit\n -p PORT, --port PORT Port of the INDI server (default 7624).\n --host HOST Hostname/IP of the INDI server (default localhost).\n -b BLOBS, --blobs BLOBS\n Optional folder where BLOB's will be saved.\n --loglevel LOGLEVEL Enables logging, value 1, 2, 3 or 4.\n --logfile LOGFILE File where logs will be saved\n --version show program's version number and exit\n\n The BLOB's folder can also be set from within the session.\n Setting loglevel and logfile should only be used for brief\n diagnostic purposes, the logfile could grow very big.\n loglevel:1 Information and error messages only,\n loglevel:2 As 1 plus xml vector tags without members or contents,\n loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,\n loglevel:4 As 1 plus xml vectors and all contents\n\n\nA typical sesssion would look like:\n\n\n\n\nThis is a companion package to 'indipydriver' which can be used to create INDI drivers.\n\nINDI - Instrument Neutral Distributed Interface.\n\nSee https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface\n\nThe INDI protocol is defined so that drivers should operate with any INDI client.\n\nThe protocol defines the format of the data sent, such as light, number, text, switch or BLOB (Binary Large Object) and the client can send commands to control the instrument. The client can be general purpose, taking the format of switches, numbers etc., from the protocol.\n\nINDI is often used with astronomical instruments, but is a general purpose protocol which can be used for any instrument control providing drivers are available.\n\nFurther documentation is available at:\n\nhttps://indipyclient.readthedocs.io\n\nIf you are only using the terminal client, I recommend pipx, so to install you would use:\n\npipx install indipyclient\n\nor if you want to run it, without installing:\n\npipx run indipyclient\n",
"bugtrack_url": null,
"license": null,
"summary": "Pure python package, providing a terminal client and a set of classes which can be used to create scripts or clients to control remote instruments using the INDI protocol.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://indipyclient.readthedocs.io",
"Source": "https://github.com/bernie-skipole/indipyclient"
},
"split_keywords": [
"indi",
" client",
" astronomy",
" instrument"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d1d63acb3fec618d3f72807c4426bafb8e47bba79ee39f28792a757e194f9ec9",
"md5": "5f304a71bc9d57a7200a0f7ce32f8c09",
"sha256": "0a055f4f42207090532d52828222029c5eb0a33695c90d0734790b35d0d116b2"
},
"downloads": -1,
"filename": "indipyclient-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f304a71bc9d57a7200a0f7ce32f8c09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 58509,
"upload_time": "2024-05-05T14:36:55",
"upload_time_iso_8601": "2024-05-05T14:36:55.440178Z",
"url": "https://files.pythonhosted.org/packages/d1/d6/3acb3fec618d3f72807c4426bafb8e47bba79ee39f28792a757e194f9ec9/indipyclient-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d10e6e4d78326a433e7da6370ddd55c3b5f96a1805d799c73e99343d8e1df246",
"md5": "1c8fce12c51e90be528e3eb54409de3b",
"sha256": "b571e890b77c475e58f98c3cbd8a5bb35c3ea655157617049f2b198da22ea3e5"
},
"downloads": -1,
"filename": "indipyclient-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1c8fce12c51e90be528e3eb54409de3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 53656,
"upload_time": "2024-05-05T14:36:57",
"upload_time_iso_8601": "2024-05-05T14:36:57.463344Z",
"url": "https://files.pythonhosted.org/packages/d1/0e/6e4d78326a433e7da6370ddd55c3b5f96a1805d799c73e99343d8e1df246/indipyclient-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-05 14:36:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bernie-skipole",
"github_project": "indipyclient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "indipyclient"
}
