Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-28 02:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[sim] Clarify Sim CAN Device Documentation (#6679)

Browse Source
This commit is contained in:
CoolSpy3
2024-05-30 05:32:45 -07:00
committed by GitHub
parent 9782abbcb1
commit c1fc86033a
5 changed files with 128 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
hal/src/main/java/edu/wpi/first/hal/SimDevice.java
View File

@@ -39,6 +39,9 @@ public class SimDevice implements AutoCloseable {
* instances of the same device are desired, recommend appending the instance/unique identifier in
* brackets to the base name, e.g. "device[1]".
*
* <p>Using a device name of the form "Type:Name" will create a WebSockets node with a type value
* of "Type" and a device value of "Name"
*
* <p>null is returned if not in simulation.
*
* @param name device name
@@ -59,6 +62,9 @@ public class SimDevice implements AutoCloseable {
* convenience method that appends index in brackets to the device name, e.g. passing index=1
* results in "device[1]" for the device name.
*
* <p>Using a device name of the form "Type:Name" will create a WebSockets node with a type value
* of "Type" and a device value of "Name"
*
* <p>null is returned if not in simulation.
*
* @param name device name
@@ -76,6 +82,9 @@ public class SimDevice implements AutoCloseable {
* convenience method that appends index and channel in brackets to the device name, e.g. passing
* index=1 and channel=2 results in "device[1,2]" for the device name.
*
* <p>Using a device name of the form "Type:Name" will create a WebSockets node with a type value
* of "Type" and a device value of "Name"
*
* <p>null is returned if not in simulation.
*
* @param name device name

3
hal/src/main/java/edu/wpi/first/hal/SimDeviceJNI.java
View File

@@ -16,6 +16,9 @@ public class SimDeviceJNI extends JNIWrapper {
* instances of the same device are desired, recommend appending the instance/unique identifier in
* brackets to the base name, e.g. "device[1]".
*
* <p>Using a device name of the form "Type:Name" will create a WebSockets node with a type value
* of "Type" and a device value of "Name"
*
* <p>0 is returned if not in simulation.
*
* @param name device name

12
hal/src/main/native/include/hal/SimDevice.h
View File

@@ -48,6 +48,9 @@ extern "C" {
* appending the instance/unique identifier in brackets to the base name,
* e.g. "device[1]".
*
* Using a device name of the form "Type:Name" will create a WebSockets node
* with a type value of "Type" and a device value of "Name"
*
* 0 is returned if not in simulation.
*
* @param name device name
@@ -664,6 +667,9 @@ class SimDevice {
* recommend appending the instance/unique identifier in brackets to the base
* name, e.g. "device[1]".
*
* Using a device name of the form "Type:Name" will create a WebSockets node
* with a type value of "Type" and a device value of "Name"
*
* If not in simulation, results in an "empty" object that evaluates to false
* in a boolean context.
*
@@ -679,6 +685,9 @@ class SimDevice {
* brackets to the device name, e.g. passing index=1 results in "device[1]"
* for the device name.
*
* Using a device name of the form "Type:Name" will create a WebSockets node
* with a type value of "Type" and a device value of "Name"
*
* If not in simulation, results in an "empty" object that evaluates to false
* in a boolean context.
*
@@ -695,6 +704,9 @@ class SimDevice {
* channel in brackets to the device name, e.g. passing index=1 and channel=2
* results in "device[1,2]" for the device name.
*
* Using a device name of the form "Type:Name" will create a WebSockets node
* with a type value of "Type" and a device value of "Name"
*
* If not in simulation, results in an "empty" object that evaluates to false
* in a boolean context.
*