WPILibC++ 2024.3.2
DriverStationData.h
Go to the documentation of this file.
1// Copyright (c) FIRST and other WPILib contributors.
2// Open Source Software; you can modify and/or share it under the terms of
3// the WPILib BSD license file in the root directory of this project.
4
5#pragma once
6
7#include <cstddef>
8
10#include "hal/Types.h"
12
13typedef void (*HAL_JoystickAxesCallback)(const char* name, void* param,
14 int32_t joystickNum,
15 const HAL_JoystickAxes* axes);
16typedef void (*HAL_JoystickPOVsCallback)(const char* name, void* param,
17 int32_t joystickNum,
18 const HAL_JoystickPOVs* povs);
19typedef void (*HAL_JoystickButtonsCallback)(const char* name, void* param,
20 int32_t joystickNum,
21 const HAL_JoystickButtons* buttons);
23 const char* name, void* param, int32_t joystickNum,
24 const HAL_JoystickDescriptor* descriptor);
25typedef void (*HAL_JoystickOutputsCallback)(const char* name, void* param,
26 int32_t joystickNum,
27 int64_t outputs, int32_t leftRumble,
28 int32_t rightRumble);
29typedef void (*HAL_MatchInfoCallback)(const char* name, void* param,
30 const HAL_MatchInfo* info);
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
38 void* param,
39 HAL_Bool initialNotify);
43
45 HAL_NotifyCallback callback, void* param, HAL_Bool initialNotify);
49
51 void* param,
52 HAL_Bool initialNotify);
56
58 void* param,
59 HAL_Bool initialNotify);
63
65 HAL_NotifyCallback callback, void* param, HAL_Bool initialNotify);
69
71 HAL_NotifyCallback callback, void* param, HAL_Bool initialNotify);
75
77 HAL_NotifyCallback callback, void* param, HAL_Bool initialNotify);
81 HAL_AllianceStationID allianceStationId);
82
84 HAL_NotifyCallback callback, void* param, HAL_Bool initialNotify);
87void HALSIM_SetDriverStationMatchTime(double matchTime);
88
89int32_t HALSIM_RegisterJoystickAxesCallback(int32_t joystickNum,
91 void* param,
92 HAL_Bool initialNotify);
94void HALSIM_GetJoystickAxes(int32_t joystickNum, HAL_JoystickAxes* axes);
95void HALSIM_SetJoystickAxes(int32_t joystickNum, const HAL_JoystickAxes* axes);
96
97int32_t HALSIM_RegisterJoystickPOVsCallback(int32_t joystickNum,
99 void* param,
100 HAL_Bool initialNotify);
102void HALSIM_GetJoystickPOVs(int32_t joystickNum, HAL_JoystickPOVs* povs);
103void HALSIM_SetJoystickPOVs(int32_t joystickNum, const HAL_JoystickPOVs* povs);
104
106 int32_t joystickNum, HAL_JoystickButtonsCallback callback, void* param,
107 HAL_Bool initialNotify);
109void HALSIM_GetJoystickButtons(int32_t joystickNum,
110 HAL_JoystickButtons* buttons);
111void HALSIM_SetJoystickButtons(int32_t joystickNum,
112 const HAL_JoystickButtons* buttons);
113
115 int32_t joystickNum, HAL_JoystickDescriptorCallback callback, void* param,
116 HAL_Bool initialNotify);
118void HALSIM_GetJoystickDescriptor(int32_t joystickNum,
119 HAL_JoystickDescriptor* descriptor);
120void HALSIM_SetJoystickDescriptor(int32_t joystickNum,
121 const HAL_JoystickDescriptor* descriptor);
122
124 int32_t joystickNum, HAL_JoystickOutputsCallback callback, void* param,
125 HAL_Bool initialNotify);
127void HALSIM_GetJoystickOutputs(int32_t joystickNum, int64_t* outputs,
128 int32_t* leftRumble, int32_t* rightRumble);
129void HALSIM_SetJoystickOutputs(int32_t joystickNum, int64_t outputs,
130 int32_t leftRumble, int32_t rightRumble);
131
133 void* param, HAL_Bool initialNotify);
137
138void HALSIM_SetJoystickButton(int32_t stick, int32_t button, HAL_Bool state);
139void HALSIM_SetJoystickAxis(int32_t stick, int32_t axis, double value);
140void HALSIM_SetJoystickPOV(int32_t stick, int32_t pov, int32_t value);
141void HALSIM_SetJoystickButtonsValue(int32_t stick, uint32_t buttons);
142void HALSIM_SetJoystickAxisCount(int32_t stick, int32_t count);
143void HALSIM_SetJoystickPOVCount(int32_t stick, int32_t count);
144void HALSIM_SetJoystickButtonCount(int32_t stick, int32_t count);
145void HALSIM_GetJoystickCounts(int32_t stick, int32_t* axisCount,
146 int32_t* buttonCount, int32_t* povCount);
147
148void HALSIM_SetJoystickIsXbox(int32_t stick, HAL_Bool isXbox);
149void HALSIM_SetJoystickType(int32_t stick, int32_t type);
150void HALSIM_SetJoystickName(int32_t stick, const char* name, size_t size);
151void HALSIM_SetJoystickAxisType(int32_t stick, int32_t axis, int32_t type);
152
153void HALSIM_SetGameSpecificMessage(const char* message, size_t size);
154void HALSIM_SetEventName(const char* name, size_t size);
156void HALSIM_SetMatchNumber(int32_t matchNumber);
157void HALSIM_SetReplayNumber(int32_t replayNumber);
158
160 void* param,
161 HAL_Bool initialNotify);
162
164 void* param,
165 HAL_Bool initialNotify);
168
169#ifdef __cplusplus
170} // extern "C"
171#endif
void HALSIM_SetJoystickIsXbox(int32_t stick, HAL_Bool isXbox)
void HALSIM_CancelJoystickOutputsCallback(int32_t uid)
void HALSIM_GetJoystickPOVs(int32_t joystickNum, HAL_JoystickPOVs *povs)
void HALSIM_SetEventName(const char *name, size_t size)
void HALSIM_CancelDriverStationDsAttachedCallback(int32_t uid)
void HALSIM_GetJoystickAxes(int32_t joystickNum, HAL_JoystickAxes *axes)
void HALSIM_CancelJoystickAxesCallback(int32_t uid)
void HALSIM_SetJoystickName(int32_t stick, const char *name, size_t size)
void HALSIM_CancelDriverStationEnabledCallback(int32_t uid)
int32_t HALSIM_RegisterDriverStationTestCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetDriverStationMatchTime(double matchTime)
void HALSIM_SetDriverStationAutonomous(HAL_Bool autonomous)
int32_t HALSIM_RegisterJoystickButtonsCallback(int32_t joystickNum, HAL_JoystickButtonsCallback callback, void *param, HAL_Bool initialNotify)
int32_t HALSIM_RegisterJoystickPOVsCallback(int32_t joystickNum, HAL_JoystickPOVsCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_GetJoystickDescriptor(int32_t joystickNum, HAL_JoystickDescriptor *descriptor)
void HALSIM_SetDriverStationAllianceStationId(HAL_AllianceStationID allianceStationId)
HAL_Bool HALSIM_GetDriverStationDsAttached(void)
void(* HAL_JoystickOutputsCallback)(const char *name, void *param, int32_t joystickNum, int64_t outputs, int32_t leftRumble, int32_t rightRumble)
Definition: DriverStationData.h:25
int32_t HALSIM_RegisterDriverStationNewDataCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetJoystickButton(int32_t stick, int32_t button, HAL_Bool state)
int32_t HALSIM_RegisterDriverStationMatchTimeCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
HAL_Bool HALSIM_GetDriverStationEnabled(void)
void HALSIM_SetJoystickPOVs(int32_t joystickNum, const HAL_JoystickPOVs *povs)
HAL_Bool HALSIM_GetDriverStationEStop(void)
void HALSIM_GetMatchInfo(HAL_MatchInfo *info)
void HALSIM_SetMatchInfo(const HAL_MatchInfo *info)
void(* HAL_MatchInfoCallback)(const char *name, void *param, const HAL_MatchInfo *info)
Definition: DriverStationData.h:29
int32_t HALSIM_RegisterJoystickOutputsCallback(int32_t joystickNum, HAL_JoystickOutputsCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetDriverStationFmsAttached(HAL_Bool fmsAttached)
HAL_Bool HALSIM_GetDriverStationAutonomous(void)
void(* HAL_JoystickPOVsCallback)(const char *name, void *param, int32_t joystickNum, const HAL_JoystickPOVs *povs)
Definition: DriverStationData.h:16
void HALSIM_SetGameSpecificMessage(const char *message, size_t size)
void HALSIM_CancelMatchInfoCallback(int32_t uid)
void HALSIM_SetJoystickAxis(int32_t stick, int32_t axis, double value)
void(* HAL_JoystickDescriptorCallback)(const char *name, void *param, int32_t joystickNum, const HAL_JoystickDescriptor *descriptor)
Definition: DriverStationData.h:22
HAL_Bool HALSIM_GetDriverStationFmsAttached(void)
int32_t HALSIM_RegisterJoystickAxesCallback(int32_t joystickNum, HAL_JoystickAxesCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetJoystickAxisCount(int32_t stick, int32_t count)
void HALSIM_SetJoystickType(int32_t stick, int32_t type)
void HALSIM_SetMatchType(HAL_MatchType type)
int32_t HALSIM_RegisterJoystickDescriptorCallback(int32_t joystickNum, HAL_JoystickDescriptorCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetJoystickPOVCount(int32_t stick, int32_t count)
void HALSIM_SetDriverStationTest(HAL_Bool test)
HAL_AllianceStationID HALSIM_GetDriverStationAllianceStationId(void)
void HALSIM_CancelJoystickDescriptorCallback(int32_t uid)
void HALSIM_CancelDriverStationAllianceStationIdCallback(int32_t uid)
void HALSIM_GetJoystickCounts(int32_t stick, int32_t *axisCount, int32_t *buttonCount, int32_t *povCount)
int32_t HALSIM_RegisterDriverStationFmsAttachedCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_CancelDriverStationTestCallback(int32_t uid)
void HALSIM_SetMatchNumber(int32_t matchNumber)
void HALSIM_SetJoystickAxisType(int32_t stick, int32_t axis, int32_t type)
void HALSIM_SetJoystickButtons(int32_t joystickNum, const HAL_JoystickButtons *buttons)
int32_t HALSIM_RegisterDriverStationAutonomousCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_NotifyDriverStationNewData(void)
int32_t HALSIM_RegisterDriverStationEStopCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetReplayNumber(int32_t replayNumber)
int32_t HALSIM_RegisterDriverStationEnabledCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void(* HAL_JoystickButtonsCallback)(const char *name, void *param, int32_t joystickNum, const HAL_JoystickButtons *buttons)
Definition: DriverStationData.h:19
void HALSIM_ResetDriverStationData(void)
double HALSIM_GetDriverStationMatchTime(void)
void HALSIM_GetJoystickOutputs(int32_t joystickNum, int64_t *outputs, int32_t *leftRumble, int32_t *rightRumble)
void HALSIM_SetJoystickButtonCount(int32_t stick, int32_t count)
void HALSIM_GetJoystickButtons(int32_t joystickNum, HAL_JoystickButtons *buttons)
void HALSIM_SetJoystickButtonsValue(int32_t stick, uint32_t buttons)
void HALSIM_RegisterDriverStationAllCallbacks(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_CancelDriverStationNewDataCallback(int32_t uid)
int32_t HALSIM_RegisterDriverStationAllianceStationIdCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_CancelDriverStationFmsAttachedCallback(int32_t uid)
void HALSIM_CancelDriverStationMatchTimeCallback(int32_t uid)
void HALSIM_CancelJoystickButtonsCallback(int32_t uid)
HAL_Bool HALSIM_GetDriverStationTest(void)
void HALSIM_SetDriverStationDsAttached(HAL_Bool dsAttached)
void HALSIM_SetJoystickAxes(int32_t joystickNum, const HAL_JoystickAxes *axes)
void HALSIM_CancelDriverStationEStopCallback(int32_t uid)
void(* HAL_JoystickAxesCallback)(const char *name, void *param, int32_t joystickNum, const HAL_JoystickAxes *axes)
Definition: DriverStationData.h:13
void HALSIM_SetDriverStationEnabled(HAL_Bool enabled)
void HALSIM_SetJoystickOutputs(int32_t joystickNum, int64_t outputs, int32_t leftRumble, int32_t rightRumble)
void HALSIM_SetDriverStationEStop(HAL_Bool eStop)
void HALSIM_CancelDriverStationAutonomousCallback(int32_t uid)
void HALSIM_SetJoystickDescriptor(int32_t joystickNum, const HAL_JoystickDescriptor *descriptor)
void HALSIM_CancelJoystickPOVsCallback(int32_t uid)
int32_t HALSIM_RegisterMatchInfoCallback(HAL_MatchInfoCallback callback, void *param, HAL_Bool initialNotify)
int32_t HALSIM_RegisterDriverStationDsAttachedCallback(HAL_NotifyCallback callback, void *param, HAL_Bool initialNotify)
void HALSIM_SetJoystickPOV(int32_t stick, int32_t pov, int32_t value)
void(* HAL_NotifyCallback)(const char *name, void *param, const struct HAL_Value *value)
Definition: NotifyListener.h:9
HAL_MatchType
Definition: DriverStationTypes.h:53
HAL_AllianceStationID
Definition: DriverStationTypes.h:43
int32_t HAL_Bool
Definition: Types.h:73
constexpr auto count() -> size_t
Definition: core.h:1203
state
Definition: core.h:2271
type
Definition: core.h:556
constexpr const char * name(const T &)
Definition: DriverStationTypes.h:68
Definition: DriverStationTypes.h:81
Definition: DriverStationTypes.h:87
Definition: DriverStationTypes.h:75
Definition: DriverStationTypes.h:98