xdr-cli/xdrctl.py at main · mediainbox/xdr-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import os
import socket
import hashlib
import json
import re
import string
import click

from xdr_core import xdr_status, xdr_listen, xdr_raw, xdr_scan, xdr_init_full
from xdr_core import xdr_tune, xdr_bandwidth, xdr_mode, xdr_volume, xdr_deemp
from xdr_core import xdr_agc, xdr_antenna, xdr_gain, xdr_daa, xdr_squelch, xdr_rotator
from xdr_core import xdr_interval, xdr_init_cmd, xdr_shutdown, xdr_state

DEFAULT_HOST = "127.0.0.1"
DEFAULT_PORT = 7373  # xdrd default


# -----------------------------
# CLI
# -----------------------------
@click.group(help="xdrd CLI: AUTH via SHA1(salt+password) and ASCII commands.")
@click.option("--host", default=DEFAULT_HOST, show_default=True)
@click.option("--port", default=DEFAULT_PORT, type=int, show_default=True)
@click.option("--password", default=None, help="xdrd password (or XDRD_PASS / --password-file).")
@click.option("--password-file", type=click.Path(exists=True), default=None, help="Read password from file.")
@click.pass_context
def cli(ctx, host, port, password, password_file):
    pwd = password
    if pwd is None and password_file:
        with open(password_file, "r", encoding="utf-8", errors="ignore") as f:
            pwd = f.read().strip()
    if pwd is None:
        pwd = os.environ.get("XDRD_PASS")
    ctx.ensure_object(dict)
    ctx.obj.update(host=host, port=port, password=pwd)

# -----------------------------
# High-level commands
# -----------------------------
@cli.command(help="Show current status")
@click.option("--read-seconds", default=1.0, show_default=True, type=float, help="How long to read after AUTH.")
@click.option("--json", "as_json", is_flag=True, default=False, help="Emit JSON.")
@click.pass_context
def status(ctx, read_seconds, as_json):
    status = xdr_status(ctx, read_seconds, as_json)
    print(status)

@cli.command(help="Show current state (reads the dump after AUTH).")
@click.option("--read-seconds", default=1.0, show_default=True, type=float, help="How long to read after AUTH.")
@click.option("--json", "as_json", is_flag=True, default=False, help="Emit JSON.")
@click.pass_context
def state(ctx, read_seconds, as_json):
    state = xdr_state(ctx, read_seconds, as_json)
    print(state)

@cli.command(help="Listen and decode events (Ctrl+C to exit).")
@click.option("--json", "as_json", is_flag=True, default=False, help="One JSON object per event.")
@click.pass_context
def listen(ctx, as_json):
    xdr_listen(ctx, as_json)

@cli.command(help="Send a raw line (no auto newline unless you include it).")
@click.argument("text", nargs=-1, required=True)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def raw(ctx, text, read_seconds, as_json):
    result = xdr_raw(ctx, text, read_seconds, as_json)
    print(result)


@cli.command(help="Send a scan command")
@click.option("--read-seconds", default=5, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=True)
@click.pass_context
def scan(ctx, read_seconds, as_json):
    result = xdr_scan(ctx, read_seconds, as_json)
    print(result)


@cli.command(help="Tune in kHz. Example: 101700 means 101.7 MHz.")
@click.argument("khz", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def tune(ctx, khz, read_seconds, as_json):
    xdr_tune(ctx, khz, read_seconds, as_json)

@cli.command(help="IF bandwidth (W).")
@click.argument("code", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def bandwidth(ctx, code, read_seconds, as_json):
    xdr_bandwidth(ctx, code, read_seconds, as_json)

@cli.command(help="Mode (M).")
@click.argument("mode", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def mode(ctx, mode, read_seconds, as_json):
    xdr_mode(ctx, mode, read_seconds, as_json)

@cli.command(help="Volume (Y). 0..100.")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def volume(ctx, value, read_seconds, as_json):
    xdr_volume(ctx, value, read_seconds, as_json)

@cli.command(help="De-emphasis (D).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def deemp(ctx, value, read_seconds, as_json):
    xdr_deemp(ctx, value, read_seconds, as_json)

@cli.command(help="AGC (A).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def agc(ctx, value, read_seconds, as_json):
    xdr_agc(ctx, value, read_seconds, as_json)

@cli.command(help="Antenna (Z).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def antenna(ctx, value, read_seconds, as_json):
    xdr_antenna(ctx, value, read_seconds, as_json)

@cli.command(help="Gain (G).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def gain(ctx, value, read_seconds, as_json):
    xdr_gain(ctx, value, read_seconds, as_json)

@cli.command(help="DAA (V).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def daa(ctx, value, read_seconds, as_json):
    xdr_daa(ctx, value, read_seconds, as_json)

@cli.command(help="Squelch (Q).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def squelch(ctx, value, read_seconds, as_json):
    xdr_squelch(ctx, value, read_seconds, as_json)

@cli.command(help="Rotator (C).")
@click.argument("value", type=int)
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def rotator(ctx, value, read_seconds, as_json):
    xdr_rotator(ctx, value, read_seconds, as_json)

@cli.command(help="Interval (I). Accepts either '--sampling N --detector M' or just '--sampling N'.")
@click.option("--sampling", required=True, type=int)
@click.option("--detector", type=int, default=None, help="If omitted, send only sampling.")
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def interval(ctx, sampling, detector, read_seconds, as_json):
    xdr_interval(ctx, sampling, detector, read_seconds, as_json)

# -----------------------------
# Startup / Shutdown / Init-full
# -----------------------------
@cli.command(name="init", help="Initializer (sends 'x' and expects 'OK').")
@click.option("--read-seconds", default=1.0, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def init_cmd(ctx, read_seconds, as_json):
    xdr_init_cmd(ctx, read_seconds, as_json)

@cli.command(help="Shutdown (sends 'X').")
@click.option("--read-seconds", default=0.6, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def shutdown(ctx, read_seconds, as_json):
    xdr_shutdown(ctx, read_seconds, as_json)

@cli.command(name="init-full", help="x + defaults (override via flags), optional tune and status.")
@click.option("--mode", default=0, show_default=True, type=int)
@click.option("--volume", default=100, show_default=True, type=int)
@click.option("--deemp", default=0, show_default=True, type=int)
@click.option("--agc", default=2, show_default=True, type=int)
@click.option("--bandwidth", default=0, show_default=True, type=int)
@click.option("--antenna", default=0, show_default=True, type=int)
@click.option("--gain", default=0, show_default=True, type=int)
@click.option("--daa", default=0, show_default=True, type=int)
@click.option("--squelch", default=0, show_default=True, type=int)
@click.option("--rotator", default=0, show_default=True, type=int)
@click.option("--sampling", default=0, show_default=True, type=int)
@click.option("--detector", default=0, show_default=True, type=int)
@click.option("--freq-khz", type=int, default=None)
@click.option("--status", is_flag=True, default=False)
@click.option("--read-seconds", default=2.0, show_default=True, type=float)
@click.option("--json", "as_json", is_flag=True, default=False)
@click.pass_context
def init_full(ctx, mode, volume, deemp, agc, bandwidth, antenna, gain, daa,
              squelch, rotator, sampling, detector, freq_khz, status, read_seconds, as_json):
    xdr_init_full(ctx, mode, volume, deemp, agc, bandwidth, antenna, gain, daa,
              squelch, rotator, sampling, detector, freq_khz, status, read_seconds, as_json)


if __name__ == "__main__":
    cli()