Gocator API

GoSensorInfo.h
Go to the documentation of this file.
1 /**
2 * @file GoSensorInfo.h
3 * @brief Declares the GoSensorInfo class.
4 *
5 * @internal
6 * Copyright (C) 2016-2020 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_SENSOR_INFO_H
11 #define GO_SDK_SENSOR_INFO_H
12
13 #include <GoSdk/GoSdkDef.h>
14 kBeginHeader()
15 #include <kApi/Io/kSerializer.h>
16
17 /**
18 * @class GoSensorInfo
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents read-only sensor information.
22 */
23 typedef kObject GoSensorInfo;
24
25
26 /**
27 * Gets the source ID of the sensor information.
28 *
29 * @public @memberof GoSensorInfo
30 * @version Introduced in firmware 4.0.10.27
31 * @param info GoSensorInfo object.
32 * @return The information source sensor ID.
33 */
34 GoFx(k32u) GoSensorInfo_Id(GoSensorInfo info);
35
36 /**
37 * Gets the firmware version of the sensor which provided the sensor information.
38 *
39 * @public @memberof GoSensorInfo
40 * @version Introduced in firmware 4.0.10.27
41 * @param info GoSensorInfo object.
42 * @return The firmware version.
43 */
44 GoFx(kVersion) GoSensorInfo_Firmware(GoSensorInfo info);
45
46 /**
47 * Gets the model string of the sensor which provided the sensor information.
48 *
49 * @public @memberof GoSensorInfo
50 * @version Introduced in firmware 4.0.10.27
51 * @param info GoSensorInfo object.
52 * @param model A character array pointer.
53 * @param capacity The character array capacity.
54 * @return Operation status.
55 */
56 GoFx(kStatus) GoSensorInfo_Model(GoSensorInfo info, kChar* model, k32u capacity);
57
58 /**
59 * Gets the role of the sensor which provided the sensor information.
60 *
61 * @public @memberof GoSensorInfo
62 * @version Introduced in firmware 4.0.10.27
63 * @param info GoSensorInfo object.
64 * @return The sensor role.
65 */
66 GoFx(GoRole) GoSensorInfo_Role(GoSensorInfo info);
67
68 /**
69 * Indicates whether the device providing the sensor information has a buddy device connected.
70 *
71 * @public @memberof GoSensorInfo
72 * @version Introduced in firmware 4.0.10.27
73 * @param info GoSensorInfo object.
74 * @return kTRUE if the device has a buddy and kFALSE otherwise.
75 */
76 GoFx(kBool) GoSensorInfo_HasBuddy(GoSensorInfo info);
77
78 /**
79 * Gets the ID of the buddy device which provided the sensor information.
80 *
81 * @public @memberof GoSensorInfo
82 * @version Introduced in firmware 4.0.10.27
83 * @param info GoSensorInfo object.
84 * @return The buddy device ID. 0 is returned if there is no buddy assigned.
85 */
86 GoFx(k32u) GoSensorInfo_BuddyId(GoSensorInfo info);
87
88 /**
89 * Gets the state of the device which provided the sensor information.
90 *
91 * @public @memberof GoSensorInfo
92 * @version Introduced in firmware 4.0.10.27
93 * @param info GoSensorInfo object.
94 * @return Device state.
95 */
96 GoFx(GoState) GoSensorInfo_State(GoSensorInfo info);
97
98 /**
99 * Gets the budddyable state of the device which provided the sensor information.
100 *
101 * @public @memberof GoSensorInfo
102 * @version Introduced in firmware 4.6.4.66
103 * @param info GoSensorInfo object.
104 * @return Device state.
105 */
106 GoFx(GoBuddyState) GoSensorInfo_BuddyableStatus(GoSensorInfo info);
107
108 /**
109 * Gets the id of the main device which provided the sensor information.
110 *
111 * @public @memberof GoSensorInfo
112 * @version Introduced in firmware 4.6.4.66
113 * @param info GoSensorInfo object.
114 * @return Device state.
115 */
116 GoFx(k32u) GoSensorInfo_MainId(GoSensorInfo info);
117
118
119
120 kEndHeader()
121
122 #include <GoSdk/GoSensorInfo.x.h>
123
124 #endif
GoSensorInfo::GoSensorInfo_MainId
k32u GoSensorInfo_MainId(GoSensorInfo info)
Gets the id of the main device which provided the sensor information.
k32u
GoSensorInfo
Represents read-only sensor information.
GoRole
Represents a user role.
kChar
GoSensorInfo::GoSensorInfo_BuddyId
k32u GoSensorInfo_BuddyId(GoSensorInfo info)
Gets the ID of the buddy device which provided the sensor information.
GoSensorInfo::GoSensorInfo_BuddyableStatus
GoBuddyState GoSensorInfo_BuddyableStatus(GoSensorInfo info)
Gets the budddyable state of the device which provided the sensor information.
GoSdkDef.h
Essential SDK declarations.
GoSensorInfo::GoSensorInfo_HasBuddy
kBool GoSensorInfo_HasBuddy(GoSensorInfo info)
Indicates whether the device providing the sensor information has a buddy device connected.
GoSensorInfo::GoSensorInfo_State
GoState GoSensorInfo_State(GoSensorInfo info)
Gets the state of the device which provided the sensor information.
k32s
GoSensorInfo::GoSensorInfo_Firmware
kVersion GoSensorInfo_Firmware(GoSensorInfo info)
Gets the firmware version of the sensor which provided the sensor information.
GoSensorInfo::GoSensorInfo_Role
GoRole GoSensorInfo_Role(GoSensorInfo info)
Gets the role of the sensor which provided the sensor information.
GoSensorInfo::GoSensorInfo_Id
k32u GoSensorInfo_Id(GoSensorInfo info)
Gets the source ID of the sensor information.
GoSensorInfo::GoSensorInfo_Model
kStatus GoSensorInfo_Model(GoSensorInfo info, kChar *model, k32u capacity)
Gets the model string of the sensor which provided the sensor information.
kObject
kVersion
kStatus
kBool
GoState
Represents the current state of a sensor object.