NetworkTables API
About
Synapse interfaces with SynapseLib, our vendor dependency, using NetworkTables. If you are running Synapse on a robot (i.e with a RoboRIO), you should configure the runtime to connect correctly to the NetworkTables server hosted on the robot.
If you are working without a robot, (i.e running in server mode or in sim mode), you will not need to configure a NetworkTables server and Syanpse will automatically connect either to the self-hosted server or the Simulation NetworkTables server.
API
While using the NetworkTable's API alone is possible in order to get some basic stuff done, and will also support settings modification, not all the values inside it will be sent in a human-readable format (i.e as byte-encodded data), and won't be verified from Robot Code if modified directly from NetworkTables. We recommend using SynapseLib.
The tables below list each key name that Synapse sends over the network, along with a brief description. These entries can be found within a subtable named after your camera’s nickname (as shown in the Synapse UI), which is located under the main Synapse table (or the runtime nickname table).
metrics
double[]
Metrics array for hardware perofmance information [cpu temp, cpu usage, memory, uptime, gpu memory split, used ram, used disk pct, npu usgae]
web_ui
string
URL in order to access the runtime UI
<cameraTable>/pipeline
int
Pipeline index for camera
<cameraTable>/record
bool
Recording status for camera
<cameraTable>/processLatency
double
Pipeline process latency
<cameraTable>/captureLatency
double
Camera capture latency
<cameraTable>/settings
Table
Holds all the settings for the current pipeline
<cameraTable>/data
Table
Holds all the data results for the current pipeline
Last updated