public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,918 Commits 2 Branches 0 Tags 109 MiB
Commit Graph

13 Commits

Author SHA1 Message Date
Aleksandr Prokudin 1c1ebf20a2
Update HID API for the new delay param in /hid/print (#1568) 2025-07-31 14:51:44 +03:00
Aleksandr Prokudin 57e7e03434
Convert H1 to front matter in the rest of the help pages (#1567) 
* Add missing front matter, part 1 of N

* Add missing front matter, part 2 of 2
 2025-07-28 18:48:21 +03:00
Aleksandr Prokudin d210a09ae9
Major update of the API documentation (#1557) 
* Add initial HID API documentation

The first version has placeholders for responses, to be filled at a later time.

* Add initial Streamer API documentation

Currently missing information about query parameters and a few others things.
To be fixed after the first pass at all APIs.

* Add initial PiKVM Switch API and Redfish API documentation

This covers the basics and requires some testing to finalize the documentation

* Cleanup, part 1 of N

- Write short intro for HID and Streamer sections
- Fix the structure in HI and Streamer
- Standardize descriptions

* Cleanup, part 2 of N: more standardization

* Cleanup, part 3 of N:

- Standardize the markup for code blocks and CLI commands
- Enable the 'copy code' button in the theme

* Cleanup, part 4 of N:

- Actually commit the theme settings change (copy code button)
- Wrap URLs with ampersands in single quotes as requested by @mdevaev
- Clarify a few points as suggested by @mdevaev

* Cleanup, part 5 of N:

- Update MSD and GPIO docs for consistence's sake
- A bunch of FIXMEs to take care of alt a later time

* GPIO API: mention the pulse mode support requirement

* Cleanup Responses subsections, we'll do it differently

* Update API documentation: OCR options and examples, GPIO, and more
 2025-07-14 22:38:21 +03:00
Brendan Jackman b053b8c948
Document /api/msd/set_params?rw=1 (#1429) 
Fixes https://github.com/pikvm/pikvm/issues/1428
 2024-11-26 13:52:24 +02:00
Maxim Devaev 91eb2e996d link to keyboard codes 2024-06-19 12:36:04 +03:00
Maxim Devaev a5a9c83bf1 python lib 2023-12-28 18:41:14 +02:00
David Howell 4eeda6b183
Update API docs with missing Python imports for Python wss key example (#1042) 2023-06-28 14:19:52 +03:00
Maxim Devaev 736f370be5 update 2023-01-24 06:38:02 +02:00
Maxim Devaev 361c5a3dd8 using 2fa with api 2023-01-23 17:28:21 +02:00
Maxim Devaev 2cdc9f6422 fix 2023-01-23 14:52:27 +02:00
Maxim Devaev 2c7cf7cc02 2fa 2023-01-23 14:44:49 +02:00
Maxim Devaev 85435c4bfd added serial number api 2022-11-14 19:25:14 +03:00
Maxim Devaev ddd1baf604 docs.pikvm.org 2021-10-12 21:45:00 +03:00