# omnipyrig
A package that allows the deveplopment of amateur radio applications using the amazing Omni-Rig library
# prerequisite
1. OmniRig (http://dxatlas.com/omnirig/)
2. python (https://www.python.org/downloads/)
# Installation
PyPi:<br>
https://pypi.org/project/omnipyrig/<br>
pip install omnipyrig
# usage
```
import omnipyrig
#create a new instance
OmniClient = omnipyrig.OmniRigWrapper()
#set the frequency
OmniClient.setFrequency("A",14222000)
#set the mode
OmniClient.setMode(OmniClient.MODE_SSB_U)
```
# how it works?
the package uses win32com to dispatch omnirig object<br/>
it then wrap it's properties and methods<br/>
# constants & methods
## constants:</br>
***mode enumeration***
- MODE_SSB_L
- MODE_SSB_U
- MODE_CW_U
- MODE_FM
- MODE_AM
- MODE_RTTY_L
- MODE_CW_L
- MODE_DATA_L
- MODE_RTTY_U
- MODE_DATA_FM
- MODE_FM_N
- MODE_DATA_U
- MODE_AM_N
- MODE_PSK
- MODE_DATA_FM_N
***rit/xit***
- RIT_ON
- RIT_OFF
- XIT_ON
- XIT_OFF
***split***
- SPLIT_ON
- SPLIT_OFF
***vfo***
- VFO_AA
- VFO_AB
- VFO_BB
- VFO_BA
## methods:
- client.showParams()
- client.setFrequency(vfo_selector, frequency)
- client.setMode(mode)
- client.setRit(state)
- client.setXit(state)
- client.setRitOffset(offset)
- client.setSplit(state)
- client.setPitch(pitch)
- client.setVfoA()
- client.setVfoB()
- client.setVfoAB()
- client.setVfoBA()
73,<br/>
Gil 4Z1KD
Raw data
{
"_id": null,
"home_page": "",
"name": "omnipyrig",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,amateur radio,ham,omni-rig,omnirig,radio",
"author": "4Z1KD (Gil)",
"author_email": "<4z1kd@iarc.org>",
"download_url": "https://files.pythonhosted.org/packages/0a/87/e7c80a85e5774c89d6ce492cee663aebb4eb70803097cbe4db087bd079c2/omnipyrig-0.0.10.tar.gz",
"platform": null,
"description": "# omnipyrig\r\n\r\nA package that allows the deveplopment of amateur radio applications using the amazing Omni-Rig library\r\n\r\n# prerequisite\r\n1. OmniRig (http://dxatlas.com/omnirig/)\r\n2. python (https://www.python.org/downloads/)\r\n\r\n# Installation\r\nPyPi:<br>\r\nhttps://pypi.org/project/omnipyrig/<br>\r\npip install omnipyrig\r\n\r\n\r\n# usage\r\n```\r\n\r\nimport omnipyrig\r\n\r\n#create a new instance\r\nOmniClient = omnipyrig.OmniRigWrapper()\r\n#set the frequency\r\nOmniClient.setFrequency(\"A\",14222000)\r\n#set the mode\r\nOmniClient.setMode(OmniClient.MODE_SSB_U)\r\n\r\n```\r\n\r\n# how it works? \r\nthe package uses win32com to dispatch omnirig object<br/>\r\nit then wrap it's properties and methods<br/>\r\n\r\n# constants & methods\r\n\r\n## constants:</br>\r\n***mode enumeration***\r\n- MODE_SSB_L\r\n- MODE_SSB_U\r\n- MODE_CW_U\r\n- MODE_FM\r\n- MODE_AM\r\n- MODE_RTTY_L\r\n- MODE_CW_L\r\n- MODE_DATA_L\r\n- MODE_RTTY_U\r\n- MODE_DATA_FM\r\n- MODE_FM_N\r\n- MODE_DATA_U\r\n- MODE_AM_N\r\n- MODE_PSK\r\n- MODE_DATA_FM_N\r\n\r\n***rit/xit***\r\n- RIT_ON\r\n- RIT_OFF\r\n- XIT_ON\r\n- XIT_OFF\r\n\r\n***split***\r\n- SPLIT_ON\r\n- SPLIT_OFF\r\n\r\n***vfo***\r\n- VFO_AA\r\n- VFO_AB\r\n- VFO_BB\r\n- VFO_BA\r\n\r\n## methods:\r\n- client.showParams()\r\n- client.setFrequency(vfo_selector, frequency)\r\n- client.setMode(mode)\r\n- client.setRit(state)\r\n- client.setXit(state)\r\n- client.setRitOffset(offset)\r\n- client.setSplit(state)\r\n- client.setPitch(pitch)\r\n- client.setVfoA()\r\n- client.setVfoB()\r\n- client.setVfoAB()\r\n- client.setVfoBA()\r\n\r\n\r\n73,<br/>\r\nGil 4Z1KD\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A python wrapper for Omni-Rig",
"version": "0.0.10",
"project_urls": {
"github": "https://github.com/4Z1KD/omnipyrig"
},
"split_keywords": [
"python",
"amateur radio",
"ham",
"omni-rig",
"omnirig",
"radio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9eb05234ec95db8c6b81452169bb456e15d052790b8dd53fe39c240ada420821",
"md5": "efe226fdbe88ed1ea1b609c27de34654",
"sha256": "5e881d7b1ac6dffe490245986377c7e2e94ce7b372eb3d2520e42cb67ba3a1ec"
},
"downloads": -1,
"filename": "omnipyrig-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "efe226fdbe88ed1ea1b609c27de34654",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4146,
"upload_time": "2023-08-10T18:55:11",
"upload_time_iso_8601": "2023-08-10T18:55:11.706882Z",
"url": "https://files.pythonhosted.org/packages/9e/b0/5234ec95db8c6b81452169bb456e15d052790b8dd53fe39c240ada420821/omnipyrig-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a87e7c80a85e5774c89d6ce492cee663aebb4eb70803097cbe4db087bd079c2",
"md5": "f3cb2b2bd8838ae7b699306a5887e33c",
"sha256": "819b4eb6df5e5f257b6677bd8c0f42a001fca1b78c6537c596d778fa74720819"
},
"downloads": -1,
"filename": "omnipyrig-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "f3cb2b2bd8838ae7b699306a5887e33c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4078,
"upload_time": "2023-08-10T18:55:13",
"upload_time_iso_8601": "2023-08-10T18:55:13.854995Z",
"url": "https://files.pythonhosted.org/packages/0a/87/e7c80a85e5774c89d6ce492cee663aebb4eb70803097cbe4db087bd079c2/omnipyrig-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-10 18:55:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4Z1KD",
"github_project": "omnipyrig",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "omnipyrig"
}
JSON
