# 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<br>
<br>
if you need to update:
pip install omnipyrig --update<br>
# usage
```
import omnipyrig
#create a new instance
OmniClient = omnipyrig.OmniRigWrapper()
#set the active rig to 1 (as defined in OmniRig GUI)
OmniClient.setActiveRig(1)
RigType = OmniClient.getParam("RigType")
print(f'Rig 1: {RigType}')
#set frequency of VFO A to 14.255MHz
OmniClient.setFrequency("A",14255000)
#set the mode to USB
OmniClient.setMode(OmniClient.MODE_SSB_U)
#get and print some parameters from the radio
StatusStr = OmniClient.getParam("StatusStr")
print(StatusStr)
ClearRit = OmniClient.getParam("ClearRit")
print(ClearRit)
Freq = OmniClient.getParam("Freq")
print(Freq)
FreqA = OmniClient.getParam("FreqA")
print(FreqA)
FreqB = OmniClient.getParam("FreqB")
print(FreqB)
FrequencyOfTone = OmniClient.getParam("FrequencyOfTone")
print(FrequencyOfTone)
GetRxFrequency = OmniClient.getParam("GetRxFrequency")
print(GetRxFrequency)
GetTxFrequency = OmniClient.getParam("GetTxFrequency")
print(GetTxFrequency)
IsParamReadable = OmniClient.getParam("IsParamReadable")
print(IsParamReadable)
Mode = OmniClient.getParam("Mode")
print(Mode)
Pitch = OmniClient.getParam("Pitch")
print(Pitch)
cts,dsr,dtr,rts = OmniClient.getParam("PortBits")
print(f'{cts},{dsr},{dtr},{rts}')
ReadableParams = OmniClient.getParam("ReadableParams")
print(ReadableParams)
RigType = OmniClient.getParam("RigType")
print(RigType)
Rit = OmniClient.getParam("Rit")
print(Rit)
RitOffset = OmniClient.getParam("RitOffset")
print(RitOffset)
Split = OmniClient.getParam("Split")
print(Split)
Status = OmniClient.getParam("Status")
print(Status)
Tx = OmniClient.getParam("Tx")
print(Tx)
Vfo = OmniClient.getParam("Vfo")
print(Vfo)
WriteableParams = OmniClient.getParam("WriteableParams")
print(WriteableParams)
Xit = OmniClient.getParam("Xit")
print(Xit)
```
# 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": null,
"name": "omnipyrig",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, amateur radio, ham, omni-rig, omnirig, radio",
"author": "4Z1KD (Gil)",
"author_email": "<4z1kd@iarc.org>",
"download_url": "https://files.pythonhosted.org/packages/1b/f1/bf1f886be7b52e8a86e2dcf3c70a9798c173b73ea3aa1e0bd2e0cbb036cd/omnipyrig-0.0.13.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<br>\r\n<br>\r\nif you need to update:\r\npip install omnipyrig --update<br>\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\r\n#set the active rig to 1 (as defined in OmniRig GUI)\r\nOmniClient.setActiveRig(1)\r\nRigType = OmniClient.getParam(\"RigType\")\r\nprint(f'Rig 1: {RigType}')\r\n\r\n#set frequency of VFO A to 14.255MHz\r\nOmniClient.setFrequency(\"A\",14255000)\r\n#set the mode to USB\r\nOmniClient.setMode(OmniClient.MODE_SSB_U)\r\n\r\n#get and print some parameters from the radio\r\nStatusStr = OmniClient.getParam(\"StatusStr\")\r\nprint(StatusStr)\r\nClearRit = OmniClient.getParam(\"ClearRit\")\r\nprint(ClearRit)\r\nFreq = OmniClient.getParam(\"Freq\")\r\nprint(Freq)\r\nFreqA = OmniClient.getParam(\"FreqA\")\r\nprint(FreqA)\r\nFreqB = OmniClient.getParam(\"FreqB\")\r\nprint(FreqB)\r\nFrequencyOfTone = OmniClient.getParam(\"FrequencyOfTone\")\r\nprint(FrequencyOfTone)\r\nGetRxFrequency = OmniClient.getParam(\"GetRxFrequency\")\r\nprint(GetRxFrequency)\r\nGetTxFrequency = OmniClient.getParam(\"GetTxFrequency\")\r\nprint(GetTxFrequency)\r\nIsParamReadable = OmniClient.getParam(\"IsParamReadable\")\r\nprint(IsParamReadable)\r\nMode = OmniClient.getParam(\"Mode\")\r\nprint(Mode)\r\nPitch = OmniClient.getParam(\"Pitch\")\r\nprint(Pitch)\r\ncts,dsr,dtr,rts = OmniClient.getParam(\"PortBits\")\r\nprint(f'{cts},{dsr},{dtr},{rts}')\r\nReadableParams = OmniClient.getParam(\"ReadableParams\")\r\nprint(ReadableParams)\r\nRigType = OmniClient.getParam(\"RigType\")\r\nprint(RigType)\r\nRit = OmniClient.getParam(\"Rit\")\r\nprint(Rit)\r\nRitOffset = OmniClient.getParam(\"RitOffset\")\r\nprint(RitOffset)\r\nSplit = OmniClient.getParam(\"Split\")\r\nprint(Split)\r\nStatus = OmniClient.getParam(\"Status\")\r\nprint(Status)\r\nTx = OmniClient.getParam(\"Tx\")\r\nprint(Tx)\r\nVfo = OmniClient.getParam(\"Vfo\")\r\nprint(Vfo)\r\nWriteableParams = OmniClient.getParam(\"WriteableParams\")\r\nprint(WriteableParams)\r\nXit = OmniClient.getParam(\"Xit\")\r\nprint(Xit)\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": null,
"summary": "A python wrapper for Omni-Rig",
"version": "0.0.13",
"project_urls": {
"github": "https://github.com/4Z1KD/omnipyrig"
},
"split_keywords": [
"python",
" amateur radio",
" ham",
" omni-rig",
" omnirig",
" radio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1bf1bf1f886be7b52e8a86e2dcf3c70a9798c173b73ea3aa1e0bd2e0cbb036cd",
"md5": "bd54f0b1b77dd04b7661b244b7329e8c",
"sha256": "f81c3d6404513cefc87e0f197c69ccb4c941eda4c15cbac90a7d8c37e6a53144"
},
"downloads": -1,
"filename": "omnipyrig-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "bd54f0b1b77dd04b7661b244b7329e8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4623,
"upload_time": "2024-06-11T04:54:52",
"upload_time_iso_8601": "2024-06-11T04:54:52.092934Z",
"url": "https://files.pythonhosted.org/packages/1b/f1/bf1f886be7b52e8a86e2dcf3c70a9798c173b73ea3aa1e0bd2e0cbb036cd/omnipyrig-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 04:54:52",
"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
