Merge pull request #182 from BluEye-Robotics/bump-dotnet-and-improve-docs

Update dotnet packages and improve documentation

Author: follesoe

Blueye.Protocol.Protobuf.csproj

@@ -5,20 +5,20 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <LangVersion>13.0</LangVersion>
     <PackageId>Blueye.Protocol.Protobuf</PackageId>
-    <VersionPrefix>4.6.0</VersionPrefix>
+    <VersionPrefix>4.7.0</VersionPrefix>
     <Company>Blueye Robotics AS</Company>
     <ProduceReferenceAssembly>True</ProduceReferenceAssembly>
     <PackageDescription>Library with dotnet representation of the ProtocolDefinition protobuf files.</PackageDescription>
     <RepositoryUrl>https://github.com/BluEye-Robotics/ProtocolDefinitions</RepositoryUrl>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Google.Protobuf" Version="3.29.2" />
-    <PackageReference Include="Google.Protobuf.Tools" Version="3.29.2">
+    <PackageReference Include="Google.Protobuf" Version="3.29.3" />
+    <PackageReference Include="Google.Protobuf.Tools" Version="3.29.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Grpc.Tools" Version="2.68.1">
+    <PackageReference Include="Grpc.Tools" Version="2.69.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

protobuf_definitions/message_formats.proto

@@ -26,15 +26,20 @@ message BinlogRecord {
 // Used to indicate the desired motion in each direction.
 // Typically these values map to the left and right joystick for motion,
 // and the left and right trigger for the slow and boost modifiers.
+//
+// You can use the slow and boost modifiers to increase or decrease the speed
+// of the motion, from the default baseline.
+
+// If you use both values at the same time they cancel each other out.
 message MotionInput {
   float surge = 1; // Forward (positive) and backwards (negative) movement. (-1..1)
   float sway = 2; // Right (positive) and left (negative) lateral movement (-1..1)
   float heave = 3; // Descend (positive) and ascend (negative) movement (-1..1)
   float roll = 7; // Roll left (negative) or right (positive). (-1..1)
   float pitch = 8; // Pitch down (negative) or up (positive). (-1..1)
   float yaw = 4; // Left (positive) and right (negative) movement (-1..1)
-  float slow = 5; // Multiplier used to reduce the speed of the motion (0..1)
-  float boost = 6; // Multiplier used to increase the speed of the motion (0..1)
+  float slow = 5; // Modifier used to reduce the speed of the motion (0..1)
+  float boost = 6; // Modifier used to increase the speed of the motion (0..1)
 }
 
 // Lights message used to represent the intensity of the main light or external lights.