diff --git a/.devcontainer/README-devcontainer.md b/.devcontainer/README-devcontainer.md index 4efbeaa8a..7e993f3d4 100644 --- a/.devcontainer/README-devcontainer.md +++ b/.devcontainer/README-devcontainer.md @@ -11,13 +11,13 @@ This folder contains all files needed for the development container: If you want to use a devcontainer on a remote host add the following to the settings.json of your VS Code config in your local workspace and replace the placeholder with your values: -``` +```json "docker.host": "ssh://your-remote-user@your-remote-machine-fqdn-or-ip-here", ``` Also update the workspace mount to a volume in the [devcontainer.json](devcontainer.json) file: -``` +```json "workspaceMount": "source=seerep-ws,target=/home/docker/workspace/src,type=volume", ``` @@ -29,7 +29,7 @@ instructions copied from [here](https://code.visualstudio.com/docs/remote/contai 3. First, start the SSH Agent in the background by running the following in a terminal: `eval "$(ssh-agent -s)"` 4. Then add these lines to your `~/.bash_profile` or `~/.zprofile` (for Zsh) so it starts on login: -``` +```bash if [ -z "$SSH_AUTH_SOCK" ]; then # Check for a currently running instance of the agent RUNNING_AGENT="`ps -ax | grep 'ssh-agent -s' | grep -v grep | wc -l | tr -d '[:space:]'`" diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 000000000..e12067088 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD033": false +} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4cfbe6c16..bf93dace0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -58,8 +58,8 @@ repos: - id: shell-lint args: [--external-sources] - - repo: https://github.com/markdownlint/markdownlint - rev: v0.12.0 + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.38.0 hooks: - id: markdownlint diff --git a/docs/mkdocs/home/index.md b/docs/mkdocs/home/index.md index 7e1b96525..470dff9c9 100644 --- a/docs/mkdocs/home/index.md +++ b/docs/mkdocs/home/index.md @@ -24,24 +24,24 @@ on the context. ## Core Features - Store robotic sensor data - - Images - - 3D-Points - - Point Clouds - - TF + - Images + - 3D-Points + - Point Clouds + - TF - Store analysis results alongside the corresponding sensor data - - Add (bounding box based) semantic annotations with confidences to the data - - Extend semantic annotations by object instances which are in multiple datasets - - Store information about an instance alongside the data - - Link 3d points to an instance to define the instance position - - Allow multiple categories of labels (e.g. a category per CNN). Thus, enabling easy evaluation and comparison of + - Add (bounding box based) semantic annotations with confidences to the data + - Extend semantic annotations by object instances which are in multiple datasets + - Store information about an instance alongside the data + - Link 3d points to an instance to define the instance position + - Allow multiple categories of labels (e.g. a category per CNN). Thus, enabling easy evaluation and comparison of multiple CNNs based on the same data - Fast spatio-temporal-semantic queries with [gRPC](https://grpc.io/docs/what-is-grpc/introduction/). - Storage of data generated by the robotic system: - - Offline on the robot (no or slow internet connection), currently in Progress - [#89](https://github.com/agri-gaia/seerep/issues/89) - - Online on a server-cluster, with - [gRPC](https://grpc.io/docs/what-is-grpc/introduction/). + - Offline on the robot (no or slow internet connection), currently in Progress + [#89](https://github.com/agri-gaia/seerep/issues/89) + - Online on a server-cluster, with + [gRPC](https://grpc.io/docs/what-is-grpc/introduction/). - Shifting computation loads away from the robot and into the cloud. - Easily switch between [Protocol Buffers (PB)](https://developers.google.com/protocol-buffers/docs/overview) / diff --git a/docs/mkdocs/legal-notice.md b/docs/mkdocs/legal-notice.md index 02e6d11c7..10688cb36 100644 --- a/docs/mkdocs/legal-notice.md +++ b/docs/mkdocs/legal-notice.md @@ -14,7 +14,7 @@ Trippstadter Str. 122
Germany Phone: [+49 631 20575 0](tel:+49631205750)
-Email: [info@dfki.de](mailto:info@dfki.de) +Email: [info@dfki.de](mailto:info@dfki.de>) Register Court: Amtsgericht Kaiserslautern
Register Number: HRB 2313 @@ -31,7 +31,7 @@ Germany
Phone: [+49 541 386050 2254](tel:+495413860502254)
E-mail: [mark.niemeyer@dfki.de](mailto:mark.niemeyer@dfki.de)
-Website URL: www.dfki.de +Website URL: ## Liability for content @@ -64,7 +64,7 @@ checked by DFKI when the links were first set up to determine whether any legal the check, no legal infringements were apparent. However, it cannot be ruled out that the content is subsequently changed by the respective providers. A permanent control of the content of the linked pages is not reasonable without evidence of a legal infringement. Should you believe that the linked external pages infringe applicable law or otherwise -contain inappropriate content, please notify us directly at: info@dfki.de. +contain inappropriate content, please notify us directly at: . In case DFKI should notice or receive any indication that an external offer to which it has linked might cause civil or criminal liability, DFKI will immediately delete this link. diff --git a/docs/mkdocs/tutorials/images.md b/docs/mkdocs/tutorials/images.md index 363f13396..578de3559 100644 --- a/docs/mkdocs/tutorials/images.md +++ b/docs/mkdocs/tutorials/images.md @@ -227,12 +227,14 @@ fullyEncapsulated`. If false, resultant polygons, which are partially inside the * Labels (semantic query) + + === "Protocol Buffers" Source: `examples/python/gRPC/images/gRPC_pb_queryImage.py` ```python - #!/usr/bin/env python3 + #!/usr/bin/env python3 import sys @@ -458,11 +460,11 @@ fullyEncapsulated`. If false, resultant polygons, which are partially inside the ) print("done.") -``` + ``` Output: - ``` + ```shell testproject 3af70ba8-1e81-4f60-86d2-a4257d88f01e uuidmsg: 00ced216-40b1-4d54-817f-11c413b228c6 diff --git a/docs/mkdocs/tutorials/projects.md b/docs/mkdocs/tutorials/projects.md index dda710cc5..efd6235d7 100644 --- a/docs/mkdocs/tutorials/projects.md +++ b/docs/mkdocs/tutorials/projects.md @@ -44,6 +44,8 @@ The new project on the server is (name/uuid): After we created two projects, we can query them. Currently the name doesn't have to be unique. + + === "Protocol Buffers" Source: `examples/gRPC/meta/gRPC_pb_getProjects.py` diff --git a/seerep_msgs/README.md b/seerep_msgs/README.md index 76c7c5c95..2683b7fe5 100644 --- a/seerep_msgs/README.md +++ b/seerep_msgs/README.md @@ -5,66 +5,65 @@ ## Table of Contents - [Header.proto](#Header.proto) - - [Header](#ag.Header) + - [Header](#ag.Header) - [Image.proto](#Image.proto) - - [Image](#ag.Image) + - [Image](#ag.Image) - [Point.proto](#Point.proto) - - [Point](#ag.Point) + - [Point](#ag.Point) - [PointCloud2.proto](#PointCloud2.proto) - - [PointCloud2](#ag.PointCloud2) + - [PointCloud2](#ag.PointCloud2) - [PointField.proto](#PointField.proto) - - [PointField](#ag.PointField) - - - [PointField.Datatype](#ag.PointField.Datatype) + - [PointField](#ag.PointField) + - [PointField.Datatype](#ag.PointField.Datatype) - [PointStamped.proto](#PointStamped.proto) - - [PointStamped](#ag.PointStamped) + - [PointStamped](#ag.PointStamped) - [Polygon.proto](#Polygon.proto) - - [Polygon](#ag.Polygon) + - [Polygon](#ag.Polygon) - [PolygonStamped.proto](#PolygonStamped.proto) - - [PolygonStamped](#ag.PolygonStamped) + - [PolygonStamped](#ag.PolygonStamped) - [Pose.proto](#Pose.proto) - - [Pose](#ag.Pose) + - [Pose](#ag.Pose) - [PoseStamped.proto](#PoseStamped.proto) - - [PoseStamped](#ag.PoseStamped) + - [PoseStamped](#ag.PoseStamped) - [Quaternion.proto](#Quaternion.proto) - - [Quaternion](#ag.Quaternion) + - [Quaternion](#ag.Quaternion) - [QuaternionStamped.proto](#QuaternionStamped.proto) - - [QuaternionStamped](#ag.QuaternionStamped) + - [QuaternionStamped](#ag.QuaternionStamped) - [Transform.proto](#Transform.proto) - - [Transform](#ag.Transform) + - [Transform](#ag.Transform) - [TransformStamped.proto](#TransformStamped.proto) - - [TransformStamped](#ag.TransformStamped) + - [TransformStamped](#ag.TransformStamped) - [Twist.proto](#Twist.proto) - - [Twist](#ag.Twist) + - [Twist](#ag.Twist) - [TwistStamped.proto](#TwistStamped.proto) - - [TwistStamped](#ag.TwistStamped) + - [TwistStamped](#ag.TwistStamped) - [TwistWithCovariance.proto](#TwistWithCovariance.proto) - - [TwistWithCovariance](#ag.TwistWithCovariance) + - [TwistWithCovariance](#ag.TwistWithCovariance) - [TwistWithCovarianceStamped.proto](#TwistWithCovarianceStamped.proto) - - [TwistWithCovarianceStamped](#ag.TwistWithCovarianceStamped) + - [TwistWithCovarianceStamped](#ag.TwistWithCovarianceStamped) - [Vector3.proto](#Vector3.proto) - - [Vector3](#ag.Vector3) + - [Vector3](#ag.Vector3) - [Vector3Stamped.proto](#Vector3Stamped.proto) - - [Vector3Stamped](#ag.Vector3Stamped) +- [Vector3Stamped](#ag.Vector3Stamped) - [Scalar Value Types](#scalar-value-types) @@ -83,6 +82,7 @@ particular coordinate frame. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | seq | [uint32](#uint32) | | sequence id, consecutively increasing id | + | stamp | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | time this data is associated with | | frame_id | [string](#string) | | name of the coordinate frame this data is associated with |