Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
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-2022 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
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 part number of the sensor which provided the sensor information.
48 *
49 * @public @memberof GoSensorInfo
50 * @version Introduced in firmware 5.3.17.23
51 * @param info GoSensorInfo object.
52 * @param partNumber A character array pointer.
53 * @param capacity The character array capacity.
54 * @return Operation status.
55 */
56 GoFx(kStatus) GoSensorInfo_PartNumber(GoSensorInfo info, kChar* partNumber, kSize capacity);
57
58 /**
59 * Gets the model display name of the sensor which provided the sensor information.
60 *
61 * @public @memberof GoSensorInfo
62 * @version Introduced in firmware 5.3.17.23
63 * @param info GoSensorInfo object.
64 * @param modelDisplayName A character array pointer.
65 * @param capacity The character array capacity.
66 * @return Operation status.
67 */
68 GoFx(kStatus) GoSensorInfo_ModelDisplayName(GoSensorInfo info, kChar* modelDisplayName, kSize capacity);
69
70 /**
71 * Gets the role of the sensor which provided the sensor information.
72 *
73 * @public @memberof GoSensorInfo
74 * @version Introduced in firmware 4.0.10.27
75 * @param info GoSensorInfo object.
76 * @return The sensor role.
77 */
78 GoFx(GoRole) GoSensorInfo_Role(GoSensorInfo info);
79
80 /**
81 * Indicates whether the device providing the sensor information has a buddy device connected.
82 *
83 * @public @memberof GoSensorInfo
84 * @version Introduced in firmware 4.0.10.27
85 * @param info GoSensorInfo object.
86 * @return kTRUE if the device has a buddy and kFALSE otherwise.
87 */
88 GoFx(kBool) GoSensorInfo_HasBuddy(GoSensorInfo info);
89
90 /**
91 * Gets the ID of the buddy device which provided the sensor information.
92 *
93 * @public @memberof GoSensorInfo
94 * @version Introduced in firmware 4.0.10.27
95 * @param info GoSensorInfo object.
96 * @return The buddy device ID. 0 is returned if there is no buddy assigned.
97 */
98 GoFx(k32u) GoSensorInfo_BuddyId(GoSensorInfo info);
99
100 /**
101 * Gets the state of the device which provided the sensor information.
102 *
103 * @public @memberof GoSensorInfo
104 * @version Introduced in firmware 4.0.10.27
105 * @param info GoSensorInfo object.
106 * @return Device state.
107 */
108 GoFx(GoState) GoSensorInfo_State(GoSensorInfo info);
109
110 /**
111 * Gets the budddyable state of the device which provided the sensor information.
112 *
113 * @public @memberof GoSensorInfo
114 * @version Introduced in firmware 4.6.4.66
115 * @param info GoSensorInfo object.
116 * @return Device state.
117 */
118 GoFx(GoBuddyState) GoSensorInfo_BuddyableStatus(GoSensorInfo info);
119
120 /**
121 * Gets the id of the main device which provided the sensor information.
122 *
123 * @public @memberof GoSensorInfo
124 * @version Introduced in firmware 4.6.4.66
125 * @param info GoSensorInfo object.
126 * @return Device state.
127 */
128 GoFx(k32u) GoSensorInfo_MainId(GoSensorInfo info);
129
130 #include <GoSdk/GoSensorInfo.x.h>
131
132 #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. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
kSize
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.
kSerializer.h
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_ModelDisplayName
kStatus GoSensorInfo_ModelDisplayName(GoSensorInfo info, kChar *modelDisplayName, kSize capacity)
Gets the model display name of the sensor which provided the sensor information.
kObject
kVersion
GoSensorInfo::GoSensorInfo_PartNumber
kStatus GoSensorInfo_PartNumber(GoSensorInfo info, kChar *partNumber, kSize capacity)
Gets the part number of the sensor which provided the sensor information.
kStatus
kBool
GoState
Represents the current state of a sensor object.