commands.json 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  1. {
  2. "commands": [{
  3. "help": "WiFi",
  4. "hascb": true,
  5. "argtable": [{
  6. "datatype": "Fast|Comprehensive",
  7. "glossary": "Sets the WiFi Scan Mode. Use Comprehensive where more than one AP has the same name on different channels. This will ensure that the AP with the strongest signal is chosen.",
  8. "longopts": "scanmode",
  9. "checkbox": false,
  10. "hasvalue": true,
  11. "mincount": 0,
  12. "maxcount": 1
  13. }],
  14. "hint": " [--scanmode=Fast|Comprehensive]",
  15. "name": "cfg-syst-wifi"
  16. }, {
  17. "help": "Get the current size of free heap memory",
  18. "hascb": false,
  19. "name": "free"
  20. }, {
  21. "help": "Services",
  22. "hascb": true,
  23. "argtable": [{
  24. "glossary": "Bluetooth Speaker",
  25. "longopts": "BT_Speaker",
  26. "checkbox": true,
  27. "hasvalue": false,
  28. "mincount": 0,
  29. "maxcount": 1
  30. }, {
  31. "glossary": "AirPlay",
  32. "longopts": "AirPlay",
  33. "checkbox": true,
  34. "hasvalue": false,
  35. "mincount": 0,
  36. "maxcount": 1
  37. }, {
  38. "datatype": "Disabled|Telnet Only|Telnet and Serial",
  39. "glossary": "Telnet server. Use only for troubleshooting",
  40. "longopts": "telnet",
  41. "shortopts": "t",
  42. "checkbox": false,
  43. "hasvalue": true,
  44. "mincount": 0,
  45. "maxcount": 1
  46. }],
  47. "hint": " [--BT_Speaker] [--AirPlay] [-t Disabled|Telnet Only|Telnet and Serial]",
  48. "name": "cfg-syst-services"
  49. }, {
  50. "help": "Get minimum size of free heap memory found during execution",
  51. "hascb": false,
  52. "name": "heap"
  53. }, {
  54. "help": "Device Name",
  55. "hascb": true,
  56. "argtable": [{
  57. "datatype": "Bureau-OLED",
  58. "glossary": "New Name",
  59. "longopts": "name",
  60. "shortopts": "n",
  61. "checkbox": false,
  62. "hasvalue": true,
  63. "mincount": 0,
  64. "maxcount": 1
  65. }],
  66. "hint": " [-n Bureau-OLED]",
  67. "name": "cfg-syst-name"
  68. }, {
  69. "help": "Get version of chip and SDK",
  70. "hascb": false,
  71. "name": "version"
  72. }, {
  73. "help": "Reboot system",
  74. "hascb": false,
  75. "name": "restart"
  76. }, {
  77. "help": "Reboot system to Recovery",
  78. "hascb": false,
  79. "name": "recovery"
  80. }, {
  81. "help": "Reboot system to Squeezelite",
  82. "hascb": false,
  83. "name": "restart_ota"
  84. }, {
  85. "help": "General Audio Options",
  86. "hascb": true,
  87. "argtable": [{
  88. "datatype": "Headphones|Subwoofer",
  89. "glossary": "On supported DAC, determines the audio jack behavior. Selecting headphones will cause the external amp to be muted on insert, while selecting Subwoofer will keep the amp active all the time.",
  90. "longopts": "jack_behavior",
  91. "shortopts": "j",
  92. "checkbox": false,
  93. "hasvalue": true,
  94. "mincount": 0,
  95. "maxcount": 1
  96. }],
  97. "hint": " [-j Headphones|Subwoofer]",
  98. "name": "cfg-audio-general"
  99. }, {
  100. "help": "Bluetooth Audio Output Options",
  101. "hascb": true,
  102. "argtable": [{
  103. "datatype": "name",
  104. "glossary": "Bluetooth audio device name. This applies when output mode is Bluetooth",
  105. "longopts": "sink_name",
  106. "shortopts": "n",
  107. "checkbox": false,
  108. "hasvalue": true,
  109. "mincount": 1,
  110. "maxcount": 1
  111. }, {
  112. "datatype": "pin",
  113. "glossary": "Bluetooth security/pin code. Usually 0000. This applies when output mode is Bluetooth",
  114. "longopts": "pin_code",
  115. "shortopts": "p",
  116. "checkbox": false,
  117. "hasvalue": true,
  118. "mincount": 1,
  119. "maxcount": 1
  120. }],
  121. "hint": " -n name -p pin",
  122. "name": "cfg-audio-bt_source"
  123. }, {
  124. "help": "DAC Options",
  125. "hascb": true,
  126. "argtable": [{
  127. "datatype": "TAS57xx|TAS5713|AC101|WM8978|I2S",
  128. "glossary": "DAC Model Name",
  129. "longopts": "model_name",
  130. "checkbox": false,
  131. "hasvalue": true,
  132. "mincount": 1,
  133. "maxcount": 1
  134. }, {
  135. "datatype": "<n>",
  136. "glossary": "Clock GPIO. e.g. 33",
  137. "longopts": "clock",
  138. "checkbox": false,
  139. "hasvalue": true,
  140. "mincount": 1,
  141. "maxcount": 1
  142. }, {
  143. "datatype": "<n>",
  144. "glossary": "Word Select GPIO. e.g. 25",
  145. "longopts": "wordselect",
  146. "checkbox": false,
  147. "hasvalue": true,
  148. "mincount": 1,
  149. "maxcount": 1
  150. }, {
  151. "datatype": "<n>",
  152. "glossary": "Data GPIO. e.g. 32",
  153. "longopts": "data",
  154. "checkbox": false,
  155. "hasvalue": true,
  156. "mincount": 1,
  157. "maxcount": 1
  158. }, {
  159. "datatype": "<n>",
  160. "glossary": "Mute GPIO. e.g. 14",
  161. "longopts": "mute_gpio",
  162. "checkbox": false,
  163. "hasvalue": true,
  164. "mincount": 0,
  165. "maxcount": 1
  166. }, {
  167. "glossary": "Mute GPIO level. Checked=HIGH, Unchecked=LOW",
  168. "longopts": "mute_level",
  169. "checkbox": true,
  170. "hasvalue": false,
  171. "mincount": 0,
  172. "maxcount": 1
  173. }, {
  174. "datatype": "<n>",
  175. "glossary": "SDA GPIO. e.g. 27",
  176. "longopts": "dac_sda",
  177. "checkbox": false,
  178. "hasvalue": true,
  179. "mincount": 0,
  180. "maxcount": 1
  181. }, {
  182. "datatype": "<n>",
  183. "glossary": "SCL GPIO. e.g. 26",
  184. "longopts": "dac_scl",
  185. "checkbox": false,
  186. "hasvalue": true,
  187. "mincount": 0,
  188. "maxcount": 1
  189. }, {
  190. "datatype": "<n>",
  191. "glossary": "I2C device address. e.g. 106",
  192. "longopts": "dac_i2c",
  193. "checkbox": false,
  194. "hasvalue": true,
  195. "mincount": 0,
  196. "maxcount": 1
  197. }, {
  198. "glossary": "Clear configuration",
  199. "longopts": "clear",
  200. "checkbox": true,
  201. "hasvalue": false,
  202. "mincount": 0,
  203. "maxcount": 1
  204. }],
  205. "hint": " --model_name=TAS57xx|TAS5713|AC101|WM8978|I2S --clock=<n> --wordselect=<n> --data=<n> [--mute_gpio=<n>] [--mute_level] [--dac_sda=<n>] [--dac_scl=<n>] [--dac_i2c=<n>] [--clear]",
  206. "name": "cfg-hw-dac"
  207. }, {
  208. "help": "SPDIF Options",
  209. "hascb": true,
  210. "argtable": [{
  211. "datatype": "<n>",
  212. "glossary": "Clock GPIO. e.g. 33",
  213. "longopts": "clock",
  214. "checkbox": false,
  215. "hasvalue": true,
  216. "mincount": 1,
  217. "maxcount": 1
  218. }, {
  219. "datatype": "<n>",
  220. "glossary": "Word Select GPIO. e.g. 25",
  221. "longopts": "wordselect",
  222. "checkbox": false,
  223. "hasvalue": true,
  224. "mincount": 1,
  225. "maxcount": 1
  226. }, {
  227. "datatype": "<n>",
  228. "glossary": "Data GPIO. e.g. 32",
  229. "longopts": "data",
  230. "checkbox": false,
  231. "hasvalue": true,
  232. "mincount": 1,
  233. "maxcount": 1
  234. }, {
  235. "glossary": "Clear configuration",
  236. "longopts": "clear",
  237. "checkbox": true,
  238. "hasvalue": false,
  239. "mincount": 0,
  240. "maxcount": 1
  241. }],
  242. "hint": " --clock=<n> --wordselect=<n> --data=<n> [--clear]",
  243. "name": "cfg-hw-spdif"
  244. }, {
  245. "help": "I2C Bus Parameters",
  246. "hascb": true,
  247. "argtable": [{
  248. "datatype": "0|1",
  249. "glossary": "Port",
  250. "longopts": "port",
  251. "shortopts": "p",
  252. "checkbox": false,
  253. "hasvalue": true,
  254. "mincount": 0,
  255. "maxcount": 1
  256. }, {
  257. "datatype": "int",
  258. "glossary": "Frequency (Hz) e.g. 100000",
  259. "longopts": "speed",
  260. "shortopts": "f",
  261. "checkbox": false,
  262. "hasvalue": true,
  263. "mincount": 0,
  264. "maxcount": 1
  265. }, {
  266. "datatype": "<n>",
  267. "glossary": "SDA GPIO. e.g. 19",
  268. "longopts": "sda",
  269. "shortopts": "d",
  270. "checkbox": false,
  271. "hasvalue": true,
  272. "mincount": 0,
  273. "maxcount": 1
  274. }, {
  275. "datatype": "<n>",
  276. "glossary": "SCL GPIO. e.g. 18",
  277. "longopts": "scl",
  278. "shortopts": "c",
  279. "checkbox": false,
  280. "hasvalue": true,
  281. "mincount": 0,
  282. "maxcount": 1
  283. }, {
  284. "glossary": "Clear configuration",
  285. "longopts": "clear",
  286. "checkbox": true,
  287. "hasvalue": false,
  288. "mincount": 0,
  289. "maxcount": 1
  290. }],
  291. "hint": " [-p 0|1] [-f int] [-d <n>] [-c <n>] [--clear]",
  292. "name": "cfg-hw-i2c"
  293. }, {
  294. "help": "SPI Bus Parameters",
  295. "hascb": true,
  296. "argtable": [{
  297. "datatype": "<n>",
  298. "glossary": "Data GPIO",
  299. "longopts": "data",
  300. "shortopts": "d",
  301. "checkbox": false,
  302. "hasvalue": true,
  303. "mincount": 0,
  304. "maxcount": 1
  305. }, {
  306. "datatype": "<n>",
  307. "glossary": "Clock GPIO",
  308. "longopts": "clk",
  309. "shortopts": "k",
  310. "checkbox": false,
  311. "hasvalue": true,
  312. "mincount": 0,
  313. "maxcount": 1
  314. }, {
  315. "datatype": "<n>",
  316. "glossary": "DC GPIO",
  317. "longopts": "dc",
  318. "shortopts": "c",
  319. "checkbox": false,
  320. "hasvalue": true,
  321. "mincount": 0,
  322. "maxcount": 1
  323. }, {
  324. "datatype": "1|2",
  325. "glossary": "SPI Host Number",
  326. "longopts": "host",
  327. "shortopts": "h",
  328. "checkbox": false,
  329. "hasvalue": true,
  330. "mincount": 0,
  331. "maxcount": 1
  332. }, {
  333. "glossary": "Clear configuration",
  334. "longopts": "clear",
  335. "checkbox": true,
  336. "hasvalue": false,
  337. "mincount": 0,
  338. "maxcount": 1
  339. }],
  340. "hint": " [-d <n>] [-k <n>] [-c <n>] [-h 1|2] [--clear]",
  341. "name": "cfg-hw-spi"
  342. }, {
  343. "help": "Scan I2C bus for devices",
  344. "hascb": false,
  345. "name": "i2cdetect"
  346. }, {
  347. "help": "Read registers visible through the I2C bus",
  348. "hascb": false,
  349. "argtable": [{
  350. "datatype": "<chip_addr>",
  351. "glossary": "Specify the address of the chip on that bus",
  352. "longopts": "chip",
  353. "shortopts": "c",
  354. "checkbox": false,
  355. "hasvalue": true,
  356. "mincount": 1,
  357. "maxcount": 1
  358. }, {
  359. "datatype": "<register_addr>",
  360. "glossary": "Specify the address on that chip to read from",
  361. "longopts": "register",
  362. "shortopts": "r",
  363. "checkbox": false,
  364. "hasvalue": true,
  365. "mincount": 0,
  366. "maxcount": 1
  367. }, {
  368. "datatype": "<length>",
  369. "glossary": "Specify the length to read from that data address",
  370. "longopts": "length",
  371. "shortopts": "l",
  372. "checkbox": false,
  373. "hasvalue": true,
  374. "mincount": 0,
  375. "maxcount": 1
  376. }],
  377. "hint": " -c <chip_addr> [-r <register_addr>] [-l <length>]",
  378. "name": "i2cget"
  379. }, {
  380. "help": "Set registers visible through the I2C bus",
  381. "hascb": false,
  382. "argtable": [{
  383. "datatype": "<chip_addr>",
  384. "glossary": "Specify the address of the chip on that bus",
  385. "longopts": "chip",
  386. "shortopts": "c",
  387. "checkbox": false,
  388. "hasvalue": true,
  389. "mincount": 1,
  390. "maxcount": 1
  391. }, {
  392. "datatype": "<n>",
  393. "glossary": "Specify the i2c port (0|2)",
  394. "longopts": "port",
  395. "shortopts": "p",
  396. "checkbox": false,
  397. "hasvalue": true,
  398. "mincount": 0,
  399. "maxcount": 1
  400. }, {
  401. "datatype": "<register_addr>",
  402. "glossary": "Specify the address on that chip to read from",
  403. "longopts": "register",
  404. "shortopts": "r",
  405. "checkbox": false,
  406. "hasvalue": true,
  407. "mincount": 0,
  408. "maxcount": 1
  409. }, {
  410. "datatype": "<data>",
  411. "glossary": "Specify the data to write to that data address",
  412. "checkbox": false,
  413. "hasvalue": true,
  414. "mincount": 0,
  415. "maxcount": 256
  416. }],
  417. "hint": " -c <chip_addr> [-p <n>] [-r <register_addr>] [<data>]...",
  418. "name": "i2cset"
  419. }, {
  420. "help": "Examine registers visible through the I2C bus",
  421. "hascb": false,
  422. "argtable": [{
  423. "datatype": "<chip_addr>",
  424. "glossary": "Specify the address of the chip on that bus",
  425. "longopts": "chip",
  426. "shortopts": "c",
  427. "checkbox": false,
  428. "hasvalue": true,
  429. "mincount": 1,
  430. "maxcount": 1
  431. }, {
  432. "datatype": "<size>",
  433. "glossary": "Specify the size of each read",
  434. "longopts": "size",
  435. "shortopts": "s",
  436. "checkbox": false,
  437. "hasvalue": true,
  438. "mincount": 0,
  439. "maxcount": 1
  440. }],
  441. "hint": " -c <chip_addr> [-s <size>]",
  442. "name": "i2cdump"
  443. }, {
  444. "help": "Display",
  445. "hascb": true,
  446. "argtable": [{
  447. "datatype": "<I2C|SPI>",
  448. "glossary": "Interface (default I2C)",
  449. "longopts": "type",
  450. "shortopts": "t",
  451. "checkbox": false,
  452. "hasvalue": true,
  453. "mincount": 0,
  454. "maxcount": 1
  455. }, {
  456. "datatype": "<SH1106|SSD1306|SSD1322|SSD1326|SSD1327|SSD1675|SSD1351|ST7735|ST7789|ILI9341|>",
  457. "glossary": "Driver",
  458. "longopts": "driver",
  459. "shortopts": "d",
  460. "checkbox": false,
  461. "hasvalue": true,
  462. "mincount": 0,
  463. "maxcount": 1
  464. }, {
  465. "datatype": "1|4",
  466. "glossary": "Bit Depth (only for SSD1326 displays)",
  467. "longopts": "depth",
  468. "shortopts": "p",
  469. "checkbox": false,
  470. "hasvalue": true,
  471. "mincount": 0,
  472. "maxcount": 1
  473. }, {
  474. "datatype": "<n>",
  475. "glossary": "I2C address (default 60)",
  476. "longopts": "address",
  477. "shortopts": "a",
  478. "checkbox": false,
  479. "hasvalue": true,
  480. "mincount": 0,
  481. "maxcount": 1
  482. }, {
  483. "datatype": "<n>",
  484. "glossary": "Width",
  485. "longopts": "width",
  486. "shortopts": "w",
  487. "checkbox": false,
  488. "hasvalue": true,
  489. "mincount": 1,
  490. "maxcount": 1
  491. }, {
  492. "datatype": "<n>",
  493. "glossary": "Height",
  494. "longopts": "height",
  495. "shortopts": "h",
  496. "checkbox": false,
  497. "hasvalue": true,
  498. "mincount": 1,
  499. "maxcount": 1
  500. }, {
  501. "glossary": "Rotate 180 degrees",
  502. "longopts": "rotate",
  503. "shortopts": "r",
  504. "checkbox": true,
  505. "hasvalue": false,
  506. "mincount": 0,
  507. "maxcount": 1
  508. }, {
  509. "glossary": "Flip horizontally",
  510. "longopts": "hf",
  511. "checkbox": true,
  512. "hasvalue": false,
  513. "mincount": 0,
  514. "maxcount": 1
  515. }, {
  516. "glossary": "Flip vertically",
  517. "longopts": "vf",
  518. "checkbox": true,
  519. "hasvalue": false,
  520. "mincount": 0,
  521. "maxcount": 1
  522. }, {
  523. "datatype": "<n>",
  524. "glossary": "SPI Only. Bus Speed (Default 8000000). SPI interface can work up to 26MHz~40MHz",
  525. "longopts": "speed",
  526. "shortopts": "s",
  527. "checkbox": false,
  528. "hasvalue": true,
  529. "mincount": 0,
  530. "maxcount": 1
  531. }, {
  532. "datatype": "<n>",
  533. "glossary": "SPI Only. CS GPIO (for SPI displays)",
  534. "longopts": "cs",
  535. "shortopts": "b",
  536. "checkbox": false,
  537. "hasvalue": true,
  538. "mincount": 0,
  539. "maxcount": 1
  540. }, {
  541. "datatype": "<n>",
  542. "glossary": "Backlight GPIO (if applicable)",
  543. "longopts": "back",
  544. "shortopts": "b",
  545. "checkbox": false,
  546. "hasvalue": true,
  547. "mincount": 0,
  548. "maxcount": 1
  549. }, {
  550. "datatype": "<n>",
  551. "glossary": "Reset GPIO",
  552. "longopts": "reset",
  553. "checkbox": false,
  554. "hasvalue": true,
  555. "mincount": 0,
  556. "maxcount": 1
  557. }, {
  558. "glossary": "clear configuration and return",
  559. "longopts": "clear",
  560. "checkbox": true,
  561. "hasvalue": false,
  562. "mincount": 0,
  563. "maxcount": 1
  564. }],
  565. "hint": " [-r] [-t <I2C|SPI>] [-d <SH1106|SSD1306|SSD1322|SSD1326|SSD1327|SSD1675|SSD1351|ST7735|ST7789|ILI9341|>] [-p 1|4] [-a <n>] -w <n> -h <n> [--hf] [--vf] [-s <n>] [-b <n>] [-b <n>] [--reset=<n>] [--clear]",
  566. "name": "cfg-hw-display"
  567. }],
  568. "values": {
  569. "cfg-syst-wifi": {
  570. "scanmode": "Fast"
  571. },
  572. "cfg-syst-services": {
  573. "BT_Speaker": true,
  574. "AirPlay": true,
  575. "telnet": "Telnet Only"
  576. },
  577. "cfg-syst-name": {
  578. "name": "Bureau-OLED"
  579. },
  580. "cfg-audio-general": {
  581. "jack_behavior": "Subwoofer"
  582. },
  583. "cfg-audio-bt_source": {
  584. "sink_name": "SMSL BT4.2",
  585. "pin_code": "0000"
  586. },
  587. "cfg-hw-dac": {
  588. "clock": 33,
  589. "wordselect": 25,
  590. "data": 32,
  591. "model_name": "I2S"
  592. },
  593. "cfg-hw-spdif": {
  594. },
  595. "cfg-hw-i2c": {
  596. "speed": 400000
  597. },
  598. "cfg-hw-spi": {
  599. "data": 4,
  600. "clk": 5,
  601. "dc": 18,
  602. "host": 1
  603. },
  604. "cfg-hw-display": {
  605. "width": 256,
  606. "height": 64,
  607. "reset": 21,
  608. "driver": "SSD1322",
  609. "cs": 19,
  610. "speed": 16000000,
  611. "type": "SPI",
  612. "rotate": false,
  613. "hf": false,
  614. "vf": false
  615. }
  616. }
  617. }