Repository navigation
feat(revohuman): add the RevoHuman glove plugin - #1407
Open
HAOTianGa03 wants to merge 10 commits into
Open
HAOTianGa03 wants to merge 10 commits into
HAOTianGa03 wants to merge 10 commits into
Conversation
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.
Description
Adds an optional, Linux-only plugin for BrainCo RevoHuman exoskeleton gloves, built on the RevoHuman C SDK release that its CMake pins (0.1.3).
/glovestatus gives the SDK's reason when the glove is degraded, for example streaming without hardware sync to the other glove, or given up; the plugin keeps running.core/hand_fit.inc) and injects them into the OpenXR hand-tracking layer, placed at a wrist pose from optical hand tracking or a controller aim pose (REVOHUMAN_WRIST_SOURCE). A glove whose hand model the plugin is not fitted to is reported as failed.TactileMetadatabuilt from the SDK's taxel layout when each glove opens. Supports PTV1 (with tactile sensors) and P1 (without).SIGUSR1tares the tactile sensors of each streaming glove that has them. This writes to the gloves; the README gives the procedure and how each request is logged.<id>/device_status, andTeleopSessionmonitors it, as it doesmanus_hand_plugin,avatar_hand_plugin,spacemouseandgamepad. Its collections are recorded and played back with the DeviceIO MCAP configs, as for the other trackers.BUILD_PLUGIN_REVOHUMANis OFF by default. With it ON, the plugin's CMake downloads the pinned C SDK release for the build's arch (x86_64 or aarch64) withFetchContentand checks its SHA-256;REVOHUMAN_SDK_ROOTpoints it at a local SDK instead, and an incomplete SDK fails the configure.cmake --install build --component revohumaninstalls the plugin with the SDK library and its licence.src/plugins/revohuman: theBUILD_PLUGIN_REVOHUMANoption in the rootCMakeLists.txt, itsadd_subdirectorygates insrc/plugins/andtests/cpp/plugins/, and therevohumanentry in the pluginsTeleopSessionmonitors, with its test case.The glove's WRIST is a point of its mechanical model, not the anatomical wrist centre. The device page and the plugin README give the nominal offset between the two and how to set the wrist source for it.
Changes since the last review
Appended to the squashed commit; nothing is force-pushed.
install.shis gone: the plugin's CMake downloads and checks the SDK, socmake -B build -DBUILD_PLUGIN_REVOHUMAN=ON && cmake --build buildbuilds it with any other plugins.PipelineConfigbecame constants, and a reopened glove keeps nothing of the earlier glove's tactile metadata.Changes in the previous round
SIGUSR1tare and the start-up hold above.main.tests/cpp/plugins/CMakeLists.txt, whichmainhas also changed, keeps both blocks.Type of change
Testing
At this commit, from a clean source tree:
cmake -B build -DBUILD_PLUGIN_REVOHUMAN=ONwith no SDK given downloads the pinned SDK release anonymously and checks its SHA-256, andcmake --install build --component revohumaninstalls the plugin with the SDK library next to it. The aarch64 release was downloaded anonymously and its SHA-256 checked against the pin.revohuman_core_tests(24 test cases, 756 assertions) and the fullctest(548 tests) pass. Two tests are skipped: this plugin's "A device that cannot be opened reports why", which skips when run as root, and onemanus_calibrationtest.SKIP=check-copyright-year pre-commit run --all-files: all hooks pass.make current-docs(sphinx-build -W --keep-going): build succeeded.With two RevoHuman PTV1 gloves (firmware 0.20.4) on x86_64, before this round's changes (not repeated on the appended commits):
DeviceIOSession, with aSIGUSR1tare at 30 s. Each hand's tactile ran split at about 215 Hz and its joint states at 200 Hz. Each hand's tactile paused once, for 245 ms, at the tare; no other gap in any of the four collections exceeded 20 ms.Video
The Tactile Metadata Editor (
scripts/tactile_metadata) in Live mode, fed by the plugin with RevoHuman PTV1 gloves.revohuman_tactile_editor_live.github.mp4
Device conformance
Summary
Scope
As requested, this take covers only the three gestures that do not depend on the wrist: open hand, pinch and fist. No wrist source was connected during recording, so the five checks that need one read FAIL:
values.zero_pose_on_valid_joint: WRIST stays at the origin. It is one of the 22 valid joints, hence 4.5% of samples.placement.not_at_originandplacement.wrist_not_frozen: no wrist pose is applied.segmentation.labelled_step_actually_performed: palms together and tip roll need the hands to move and turn.segmentation.step_order_matches_labels: the order is judged from how far each hand turns.The ten checks that depend on the step order then read
n/a, andconsistency.position_orientation_same_framereadsn/abecause the hand did not turn.Results for the three gestures
posture.flat_hand_extensionpinch.finger_identitypinch.contact_distanceposture.fist_closureretake.n/a. The measured values are the same.To reproduce, run only these four checks:
Thumb base position:
skeleton.joint_index_assignmentThis check does not depend on the wrist. It reads FAIL.
THUMB_METACARPAL) is projected onto the line fromINDEX_PROXIMALtoLITTLE_PROXIMALand must fall on the index half. It must do so in at least 90% of frames to pass.Checklist
SKIP=check-copyright-year pre-commit run --all-filesgit commit -s) per the DCOSummary by CodeRabbit