Repository navigation
Add endpoints from upstream and move the detailed docs out of the README - #56
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the endpoints from sipeed/NanoKVM and sipeed/NanoKVM-Pro that are in a released firmware but were missing from the client, and splits the README into a short landing page plus a
docs/folder.Changes
get_autostart_scripts,get_autostart_script,upload_autostart_scriptanddelete_autostart_script. A missing autostart directory, which the firmware reports as code -1, reads as an empty list. Names that are empty,.,..or contain/raiseValueErrorbefore any request.get_time()(Pro 1.2.6) reads the first event of the/vm/timestream and returns an aware UTCdatetime.set_frame_detect(enabled)andpause_frame_detect(duration)(non-Pro) control MJPEG frame skipping. The pause holds the request open on the device for its whole duration, so its timeout covers that.set_tls(enabled)(non-Pro 2.2.7) switches the web interface between HTTP and HTTPS.docs/. The API reference lists every public method with the hardware and firmware it needs, including the ones above.uv.lockis ignored.Notes
/vm/tlshandler, before the answer goes out, so the request always ends inServerDisconnectedError.set_tlstreats that disconnect as success. Every failure before the restart answers with an error code.docs/api.mdfollow the decorators on each method. A few methods check versions in their body instead; those have a note under their table.Behaviour changes
None. All methods are additions.
Testing
408 unit tests pass, 4 of them new. Each endpoint was also run against a device before its commit:
get_time()matched the local clock within a few milliseconds.