v0.4.5 release

acmerobotics · Sep 15, 2022 · d070d2d · d070d2d
1 parent d135df0
commit d070d2d
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 68 deletions.
diff --git a/FtcDashboard/build.gradle b/FtcDashboard/build.gradle
@@ -1,5 +1,5 @@
 buildscript {
-    ext.dashboard_version = '0.4.4'
+    ext.dashboard_version = '0.4.5'
 }
 
 plugins {

diff --git a/docs/features.md b/docs/features.md
@@ -35,9 +35,7 @@ FtcDashboard dashboard = FtcDashboard.getInstance();
 dashboard.sendTelemetryPacket(packet);
 ```
 
-Each telemetry packet overwrites the last, so **only send one packet per loop**. Violating this guideline often leads to flickering data in the client. If you have a modular subsystem architecture, consider having each subsystem produce a `Map<String, Object>` and aggregate them in the main loop with `TelemetryPacket#putAll()`. 
-
-For convenience, the dashboard offers a restricted implementation of `Telemetry`. 
+For convenience the dashboard offers a restricted implementation of `Telemetry`. 
 
 ```java
 FtcDashboard dashboard = FtcDashboard.getInstance();

diff --git a/docs/javadoc/com/acmerobotics/dashboard/FtcDashboard.html b/docs/javadoc/com/acmerobotics/dashboard/FtcDashboard.html
diff --git a/docs/javadoc/index-files/index-1.html b/docs/javadoc/index-files/index-1.html
@@ -144,11 +144,11 @@ <h2 class="title">A</h2>
 <dd>
 <div class="block">Adds and returns the current timestamp to the packet.</div>
 </dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#attachEventLoop-android.content.Context-com.qualcomm.ftccommon.FtcEventLoop-">attachEventLoop(Context, FtcEventLoop)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#attachEventLoop-Context-com.qualcomm.ftccommon.FtcEventLoop-">attachEventLoop(Context, FtcEventLoop)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Attaches the event loop to the instance for op mode management.</div>
 </dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#attachWebServer-android.content.Context-com.qualcomm.robotcore.util.WebHandlerManager-">attachWebServer(Context, WebHandlerManager)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#attachWebServer-Context-com.qualcomm.robotcore.util.WebHandlerManager-">attachWebServer(Context, WebHandlerManager)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Attaches a web server for accessing the dashboard through the phone (like OBJ/Blocks).</div>
 </dd>

diff --git a/docs/javadoc/index-files/index-12.html b/docs/javadoc/index-files/index-12.html
@@ -80,7 +80,7 @@ <h2 class="title">P</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/canvas/Polyline.html#Polyline-double:A-double:A-">Polyline(double[], double[])</a></span> - Constructor for class com.acmerobotics.dashboard.canvas.<a href="../com/acmerobotics/dashboard/canvas/Polyline.html" title="class in com.acmerobotics.dashboard.canvas">Polyline</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#populateMenu-android.content.Context-android.view.Menu-">populateMenu(Context, Menu)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#populateMenu-Context-Menu-">populateMenu(Context, Menu)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Populates the menu with dashboard enable/disable options.</div>
 </dd>

diff --git a/docs/javadoc/index-files/index-14.html b/docs/javadoc/index-files/index-14.html
@@ -86,13 +86,13 @@ <h2 class="title">S</h2>
 <dd>
 <div class="block">Sends a message to the connected client.</div>
 </dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-android.graphics.Bitmap-">sendImage(Bitmap)</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-Bitmap-">sendImage(Bitmap)</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Sends an image to the dashboard for display (MJPEG style).</div>
 </dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendTelemetryPacket-com.acmerobotics.dashboard.telemetry.TelemetryPacket-">sendTelemetryPacket(TelemetryPacket)</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
-<div class="block">Sends telemetry information to all instance clients.</div>
+<div class="block">Queues a telemetry packet to be sent to all clients.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/config/variable/ConfigVariableSerializer.html#serialize-com.acmerobotics.dashboard.config.variable.ConfigVariable-java.lang.reflect.Type-com.google.gson.JsonSerializationContext-">serialize(ConfigVariable&lt;?&gt;, Type, JsonSerializationContext)</a></span> - Method in class com.acmerobotics.dashboard.config.variable.<a href="../com/acmerobotics/dashboard/config/variable/ConfigVariableSerializer.html" title="class in com.acmerobotics.dashboard.config.variable">ConfigVariableSerializer</a></dt>
 <dd>&nbsp;</dd>
@@ -126,7 +126,7 @@ <h2 class="title">S</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#setImageQuality-int-">setImageQuality(int)</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
-<div class="block">Sets the image quality used by <a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-android.graphics.Bitmap-"><code>FtcDashboard.sendImage(Bitmap)</code></a> and
+<div class="block">Sets the image quality used by <a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-Bitmap-"><code>FtcDashboard.sendImage(Bitmap)</code></a> and
  <a href="../com/acmerobotics/dashboard/FtcDashboard.html#startCameraStream-org.firstinspires.ftc.robotcore.external.stream.CameraStreamSource-double-"><code>FtcDashboard.startCameraStream(CameraStreamSource, double)</code></a></div>
 </dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/telemetry/MultipleTelemetry.html#setItemSeparator-java.lang.String-">setItemSeparator(String)</a></span> - Method in class com.acmerobotics.dashboard.telemetry.<a href="../com/acmerobotics/dashboard/telemetry/MultipleTelemetry.html" title="class in com.acmerobotics.dashboard.telemetry">MultipleTelemetry</a></dt>
@@ -173,7 +173,7 @@ <h2 class="title">S</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/canvas/Spline.html#Spline-double-double-double-double-double-double-double-double-double-double-double-double-">Spline(double, double, double, double, double, double, double, double, double, double, double, double)</a></span> - Constructor for class com.acmerobotics.dashboard.canvas.<a href="../com/acmerobotics/dashboard/canvas/Spline.html" title="class in com.acmerobotics.dashboard.canvas">Spline</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#start-android.content.Context-">start(Context)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#start-Context-">start(Context)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Starts the dashboard.</div>
 </dd>
@@ -185,7 +185,7 @@ <h2 class="title">S</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/message/redux/StartOpMode.html#StartOpMode--">StartOpMode()</a></span> - Constructor for class com.acmerobotics.dashboard.message.redux.<a href="../com/acmerobotics/dashboard/message/redux/StartOpMode.html" title="class in com.acmerobotics.dashboard.message.redux">StartOpMode</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#stop-android.content.Context-">stop(Context)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#stop-Context-">stop(Context)</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
 <div class="block">Stops the instance and the underlying WebSocket server.</div>
 </dd>

diff --git a/docs/javadoc/index-files/index-3.html b/docs/javadoc/index-files/index-3.html
@@ -114,6 +114,10 @@ <h2 class="title">C</h2>
 <dd>
 <div class="block">Clears the telemetry log.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#clearTelemetry--">clearTelemetry()</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
+<dd>
+<div class="block">Clears telemetry data from all clients.</div>
+</dd>
 <dt><a href="../com/acmerobotics/dashboard/package-summary.html">com.acmerobotics.dashboard</a> - package com.acmerobotics.dashboard</dt>
 <dd>&nbsp;</dd>
 <dt><a href="../com/acmerobotics/dashboard/canvas/package-summary.html">com.acmerobotics.dashboard.canvas</a> - package com.acmerobotics.dashboard.canvas</dt>

diff --git a/docs/javadoc/index-files/index-7.html b/docs/javadoc/index-files/index-7.html
@@ -108,7 +108,7 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#getImageQuality--">getImageQuality()</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
-<div class="block">Returns the image quality used by <a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-android.graphics.Bitmap-"><code>FtcDashboard.sendImage(Bitmap)</code></a> and
+<div class="block">Returns the image quality used by <a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendImage-Bitmap-"><code>FtcDashboard.sendImage(Bitmap)</code></a> and
  <a href="../com/acmerobotics/dashboard/FtcDashboard.html#startCameraStream-org.firstinspires.ftc.robotcore.external.stream.CameraStreamSource-double-"><code>FtcDashboard.startCameraStream(CameraStreamSource, double)</code></a></div>
 </dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#getInstance--">getInstance()</a></span> - Static method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
@@ -133,7 +133,7 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#getTelemetry--">getTelemetry()</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>
-<div class="block">Returns a telemetry object that proxies <a href="../com/acmerobotics/dashboard/FtcDashboard.html#sendTelemetryPacket-com.acmerobotics.dashboard.telemetry.TelemetryPacket-"><code>FtcDashboard.sendTelemetryPacket(TelemetryPacket)</code></a>.</div>
+<div class="block">Returns a <code>Telemetry</code> object that delegates to the telemetry methods of this class.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="../com/acmerobotics/dashboard/FtcDashboard.html#getTelemetryTransmissionInterval--">getTelemetryTransmissionInterval()</a></span> - Method in class com.acmerobotics.dashboard.<a href="../com/acmerobotics/dashboard/FtcDashboard.html" title="class in com.acmerobotics.dashboard">FtcDashboard</a></dt>
 <dd>

diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html
@@ -167,10 +167,10 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.acmerobotics.dashboard.<a href="com/acmerobotics/dashboard/RobotStatus.OpModeStatus.html" title="enum in com.acmerobotics.dashboard"><span class="typeNameLink">RobotStatus.OpModeStatus</span></a></li>
-<li type="circle">com.acmerobotics.dashboard.canvas.<a href="com/acmerobotics/dashboard/canvas/CanvasOp.Type.html" title="enum in com.acmerobotics.dashboard.canvas"><span class="typeNameLink">CanvasOp.Type</span></a></li>
-<li type="circle">com.acmerobotics.dashboard.config.variable.<a href="com/acmerobotics/dashboard/config/variable/VariableType.html" title="enum in com.acmerobotics.dashboard.config.variable"><span class="typeNameLink">VariableType</span></a></li>
 <li type="circle">com.acmerobotics.dashboard.message.<a href="com/acmerobotics/dashboard/message/MessageType.html" title="enum in com.acmerobotics.dashboard.message"><span class="typeNameLink">MessageType</span></a></li>
+<li type="circle">com.acmerobotics.dashboard.config.variable.<a href="com/acmerobotics/dashboard/config/variable/VariableType.html" title="enum in com.acmerobotics.dashboard.config.variable"><span class="typeNameLink">VariableType</span></a></li>
+<li type="circle">com.acmerobotics.dashboard.canvas.<a href="com/acmerobotics/dashboard/canvas/CanvasOp.Type.html" title="enum in com.acmerobotics.dashboard.canvas"><span class="typeNameLink">CanvasOp.Type</span></a></li>
+<li type="circle">com.acmerobotics.dashboard.<a href="com/acmerobotics/dashboard/RobotStatus.OpModeStatus.html" title="enum in com.acmerobotics.dashboard"><span class="typeNameLink">RobotStatus.OpModeStatus</span></a></li>
 </ul>
 </li>
 </ul>