# yaqc-bluesky
[![CI](https://img.shields.io/github/actions/workflow/status/bluesky/yaqc-bluesky/.github/workflows/python-test.yml)](https://github.com/bluesky/yaqc-bluesky/actions?query=workflow%3Apython-test)
[![PyPI](https://img.shields.io/pypi/v/yaqc-bluesky)](https://pypi.org/project/yaqc-bluesky)
[![Conda](https://img.shields.io/conda/vn/conda-forge/yaqc-bluesky)](https://anaconda.org/conda-forge/yaqc-bluesky)
[![yaq](https://img.shields.io/badge/framework-yaq-orange)](https://yaq.fyi/)
[![black](https://img.shields.io/badge/code--style-black-black)](https://black.readthedocs.io/)
[![ver](https://img.shields.io/badge/calver-YYYY.M.MICRO-blue)](https://calver.org/)
[![log](https://img.shields.io/badge/change-log-informational)](https://github.com/bluesky/yaqc-bluesky/blob/master/CHANGELOG.md)
A bluesky interface to the [yaq instrument control framework](https://yaq.fyi/).
To communicate with a yaq daemon, simply create a device::
```python
import yaqc_bluesky
device = yaqc_bluesky.Device(port=39000)
```
`yaqc_bluesky` will read the traits from the daemon and return an appropriate device instance based on what it finds.
Of course, you may also provide `host` as an argument (default localhost).
You may also optionally provide `name`, if you wish the bluesky device to have a different name than the yaq daemon.
`yaqc_bluesky` only exposes a subset of the functionality of yaq daemons.
Python users wishing to communicate with yaq may also be interested in [yaqc](https://python.yaq.fyi/yaqc/).
You can play with yaq on bluesky using our binder:
[![binder]( https://mybinder.org/badge.svg)]( https://mybinder.org/v2/gh/bluesky/yaqc-bluesky/master?urlpath=lab)
## happi support
`yaqc_bluesky` provides support for [Happi](https://github.com/pcdshub/happi).
Read more about yaq and Happi at [yaq.fyi/blog/happi/](https://yaq.fyi/blog/happi/).
Raw data
{
"_id": null,
"home_page": "https://github.com/bluesky/yaqc-bluesky",
"name": "yaqc-bluesky",
"maintainer": null,
"docs_url": null,
"requires_python": ">3.7",
"maintainer_email": null,
"keywords": null,
"author": "Blaise Thompson",
"author_email": "blaise@untzag.com",
"download_url": "https://files.pythonhosted.org/packages/b4/2b/a6c9a632fed7297290654181f84f3be6eca53bf97af84b32ec18031c3727/yaqc_bluesky-2023.8.0.tar.gz",
"platform": null,
"description": "# yaqc-bluesky\n\n[![CI](https://img.shields.io/github/actions/workflow/status/bluesky/yaqc-bluesky/.github/workflows/python-test.yml)](https://github.com/bluesky/yaqc-bluesky/actions?query=workflow%3Apython-test)\n[![PyPI](https://img.shields.io/pypi/v/yaqc-bluesky)](https://pypi.org/project/yaqc-bluesky)\n[![Conda](https://img.shields.io/conda/vn/conda-forge/yaqc-bluesky)](https://anaconda.org/conda-forge/yaqc-bluesky)\n[![yaq](https://img.shields.io/badge/framework-yaq-orange)](https://yaq.fyi/)\n[![black](https://img.shields.io/badge/code--style-black-black)](https://black.readthedocs.io/)\n[![ver](https://img.shields.io/badge/calver-YYYY.M.MICRO-blue)](https://calver.org/)\n[![log](https://img.shields.io/badge/change-log-informational)](https://github.com/bluesky/yaqc-bluesky/blob/master/CHANGELOG.md)\n\nA bluesky interface to the [yaq instrument control framework](https://yaq.fyi/).\n\nTo communicate with a yaq daemon, simply create a device::\n\n```python\nimport yaqc_bluesky\ndevice = yaqc_bluesky.Device(port=39000)\n```\n\n`yaqc_bluesky` will read the traits from the daemon and return an appropriate device instance based on what it finds.\nOf course, you may also provide `host` as an argument (default localhost).\nYou may also optionally provide `name`, if you wish the bluesky device to have a different name than the yaq daemon.\n\n`yaqc_bluesky` only exposes a subset of the functionality of yaq daemons.\nPython users wishing to communicate with yaq may also be interested in [yaqc](https://python.yaq.fyi/yaqc/).\n\nYou can play with yaq on bluesky using our binder:\n\n[![binder]( https://mybinder.org/badge.svg)]( https://mybinder.org/v2/gh/bluesky/yaqc-bluesky/master?urlpath=lab)\n\n## happi support\n\n`yaqc_bluesky` provides support for [Happi](https://github.com/pcdshub/happi).\nRead more about yaq and Happi at [yaq.fyi/blog/happi/](https://yaq.fyi/blog/happi/).\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A bluesky interface to the yaq instrument control framework.",
"version": "2023.8.0",
"project_urls": {
"Homepage": "https://github.com/bluesky/yaqc-bluesky"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dc77b67b2ee41370dc624863b571264f4540027387c230c44e665ec296c76108",
"md5": "b896222bbeaf2614612c35b562e04a93",
"sha256": "8298365b8bdc296240dd1ea6a372c9825c11daddea8bd89551c048f9433e27fb"
},
"downloads": -1,
"filename": "yaqc_bluesky-2023.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b896222bbeaf2614612c35b562e04a93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7",
"size": 17563,
"upload_time": "2023-08-14T22:28:26",
"upload_time_iso_8601": "2023-08-14T22:28:26.814672Z",
"url": "https://files.pythonhosted.org/packages/dc/77/b67b2ee41370dc624863b571264f4540027387c230c44e665ec296c76108/yaqc_bluesky-2023.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b42ba6c9a632fed7297290654181f84f3be6eca53bf97af84b32ec18031c3727",
"md5": "b0511825841624a8b19d0f8ed0fb5d08",
"sha256": "ccece1fd67efb25e483371a9afd5448664f76952e82ef0449b47b0c73c17cd20"
},
"downloads": -1,
"filename": "yaqc_bluesky-2023.8.0.tar.gz",
"has_sig": false,
"md5_digest": "b0511825841624a8b19d0f8ed0fb5d08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7",
"size": 47714,
"upload_time": "2023-08-14T22:28:28",
"upload_time_iso_8601": "2023-08-14T22:28:28.380690Z",
"url": "https://files.pythonhosted.org/packages/b4/2b/a6c9a632fed7297290654181f84f3be6eca53bf97af84b32ec18031c3727/yaqc_bluesky-2023.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 22:28:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bluesky",
"github_project": "yaqc-bluesky",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yaqc-bluesky"
}