Skip to content

Commit e87c517

Browse files
bfjohannesteiwesbfjohannesteiwes
committed
Client files for Qb2 Firmware v2.3.3 (12.09.2024)
1 parent f904176 commit e87c517

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+922
-17
lines changed

‎doc/antora.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
display_version: v2.2
1+
display_version: v2.3
22
name: Qb2
33
nav:
44
- modules/ROOT/nav.adoc
@@ -8,4 +8,4 @@ nav:
88
- modules/developer/nav.adoc
99
- modules/service_and_maintenance/nav.adoc
1010
title: Qb2
11-
version: v2.2
11+
version: v2.3

‎doc/modules/developer/nav.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
****** xref:protocol:blickfeld/beam_deflection_control/data/health.adoc[Health]
4646
***** services
4747
****** xref:protocol:blickfeld/beam_deflection_control/services/health.adoc[Health]
48+
**** compute_module
49+
***** data
50+
****** xref:protocol:blickfeld/compute_module/data/health.adoc[Health]
51+
***** services
52+
****** xref:protocol:blickfeld/compute_module/services/health.adoc[Health]
4853
**** config
4954
***** data
5055
****** xref:protocol:blickfeld/config/data/watch_event.adoc[Watch Event]
@@ -132,12 +137,14 @@
132137
***** data
133138
****** xref:protocol:blickfeld/percept_processing/data/data_type.adoc[Data Type]
134139
****** xref:protocol:blickfeld/percept_processing/data/detected_object.adoc[Detected Object]
140+
****** xref:protocol:blickfeld/percept_processing/data/event.adoc[Event]
135141
****** xref:protocol:blickfeld/percept_processing/data/health.adoc[Health]
136142
****** xref:protocol:blickfeld/percept_processing/data/objects.adoc[Objects]
137143
****** xref:protocol:blickfeld/percept_processing/data/state.adoc[State]
138144
****** xref:protocol:blickfeld/percept_processing/data/states.adoc[States]
139145
****** xref:protocol:blickfeld/percept_processing/data/volume_map.adoc[Volume Map]
140146
***** services
147+
****** xref:protocol:blickfeld/percept_processing/services/event.adoc[Event]
141148
****** xref:protocol:blickfeld/percept_processing/services/health.adoc[Health]
142149
****** xref:protocol:blickfeld/percept_processing/services/objects.adoc[Objects]
143150
****** xref:protocol:blickfeld/percept_processing/services/pipeline.adoc[Pipeline]
@@ -199,3 +206,8 @@
199206
****** xref:protocol:blickfeld/system/services/network.adoc[Network]
200207
****** xref:protocol:blickfeld/system/services/scan_pattern.adoc[Scan Pattern]
201208
****** xref:protocol:blickfeld/system/services/time_synchronization.adoc[Time Synchronization]
209+
**** video
210+
***** data
211+
****** xref:protocol:blickfeld/video/data/health.adoc[Health]
212+
***** services
213+
****** xref:protocol:blickfeld/video/services/health.adoc[Health]

‎doc/modules/protocol/nav.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
***** xref:protocol:blickfeld/beam_deflection_control/data/health.adoc[Health]
2626
**** services
2727
***** xref:protocol:blickfeld/beam_deflection_control/services/health.adoc[Health]
28+
*** compute_module
29+
**** data
30+
***** xref:protocol:blickfeld/compute_module/data/health.adoc[Health]
31+
**** services
32+
***** xref:protocol:blickfeld/compute_module/services/health.adoc[Health]
2833
*** config
2934
**** data
3035
***** xref:protocol:blickfeld/config/data/watch_event.adoc[Watch Event]
@@ -112,12 +117,14 @@
112117
**** data
113118
***** xref:protocol:blickfeld/percept_processing/data/data_type.adoc[Data Type]
114119
***** xref:protocol:blickfeld/percept_processing/data/detected_object.adoc[Detected Object]
120+
***** xref:protocol:blickfeld/percept_processing/data/event.adoc[Event]
115121
***** xref:protocol:blickfeld/percept_processing/data/health.adoc[Health]
116122
***** xref:protocol:blickfeld/percept_processing/data/objects.adoc[Objects]
117123
***** xref:protocol:blickfeld/percept_processing/data/state.adoc[State]
118124
***** xref:protocol:blickfeld/percept_processing/data/states.adoc[States]
119125
***** xref:protocol:blickfeld/percept_processing/data/volume_map.adoc[Volume Map]
120126
**** services
127+
***** xref:protocol:blickfeld/percept_processing/services/event.adoc[Event]
121128
***** xref:protocol:blickfeld/percept_processing/services/health.adoc[Health]
122129
***** xref:protocol:blickfeld/percept_processing/services/objects.adoc[Objects]
123130
***** xref:protocol:blickfeld/percept_processing/services/pipeline.adoc[Pipeline]
@@ -179,3 +186,8 @@
179186
***** xref:protocol:blickfeld/system/services/network.adoc[Network]
180187
***** xref:protocol:blickfeld/system/services/scan_pattern.adoc[Scan Pattern]
181188
***** xref:protocol:blickfeld/system/services/time_synchronization.adoc[Time Synchronization]
189+
*** video
190+
**** data
191+
***** xref:protocol:blickfeld/video/data/health.adoc[Health]
192+
**** services
193+
***** xref:protocol:blickfeld/video/services/health.adoc[Health]

‎doc/modules/protocol/pages/blickfeld/base/options/misc.adoc

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
1+
= Misc
2+
3+
[#_blickfeld_base_LifeTimeDiagnostics]
4+
== Life Time Diagnostics
5+
6+
This annotation is used by diagnostic modules to
7+
collect long term statistics for the annotated field.
8+
9+
.Available fields in blickfeld.base.LifeTimeDiagnostics
10+
|===
11+
| Field | Type | Default | Unit
12+
13+
.2+| *type* | xref:blickfeld/base/options/misc.adoc#_blickfeld_base_LifeTimeDiagnostics_Type[Type] | TYPE_UNSPECIFIED | -
14+
3+| Type
15+
16+
|===
17+
18+
[#_blickfeld_base_LifeTimeDiagnostics_Type]
19+
=== Type
20+
21+
Type of diagnostics.
22+
23+
Is used to aggregate multiple long term statistics.
24+
25+
.Available values for blickfeld.base.LifeTimeDiagnostics.Type enum
26+
[cols='25h,5,~']
27+
|===
28+
| Name | Value | Description
29+
30+
| TYPE_UNSPECIFIED ^| 0 | Unspecified type.
31+
| TYPE_TEMPERATURE ^| 1 | Temperature sensor or estimate.
32+
| TYPE_UTILIZATION ^| 2 | Indicates how much of the available resource is used.
33+
| TYPE_RATE ^| 3 | Frequency measurement or estimate.
34+
| TYPE_VOLTAGE ^| 4 | Electrical voltage sensor or estimate.
35+
|===
36+
137
[#_blickfeld_base_LinkData]
2-
= Link Data
38+
== Link Data
339
440
541

‎doc/modules/protocol/pages/blickfeld/compute_module/data/health.adoc

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
[#_blickfeld_compute_module_data_Health]
2+
= Health
3+
4+
Describes the health of the compute module
5+
6+
.Available fields in blickfeld.compute_module.data.Health
7+
|===
8+
| Field | Type | Default | Unit
9+
10+
.2+| *state* | xref:blickfeld/base/data/health.adoc#_blickfeld_base_data_Health_State[base.data.Health.State] | - | -
11+
3+| High-level state of module
12+
13+
.2+| *state_reason* | string| - | -
14+
3+| Reason for given state. Is not set if state is STATE_OK.
15+
16+
.2+| *error_flags* | xref:blickfeld/compute_module/data/health.adoc#_blickfeld_compute_module_data_Health_ErrorFlags[ErrorFlags] | - | -
17+
3+| Error flags
18+
19+
.2+| *cpu_performance* | xref:blickfeld/compute_module/data/health.adoc#_blickfeld_compute_module_data_Health_CpuPerformance[CpuPerformance] | - | -
20+
3+| CPU performance
21+
22+
.2+| *memory_utilization* | float| - | -
23+
3+| Memory utilization of the compute module.
24+
25+
The value range is between 0 and 1.
26+
27+
.2+| *uptime* | xref:blickfeld/compute_module/data/health.adoc#_blickfeld_compute_module_data_Health_Uptime[Uptime] | - | -
28+
3+| Uptime
29+
30+
|===
31+
32+
[#_blickfeld_compute_module_data_Health_ErrorFlags]
33+
== Error Flags
34+
35+
Error flags
36+
37+
.Available fields in blickfeld.compute_module.data.Health.ErrorFlags
38+
|===
39+
| Field | Type | Default | Unit
40+
41+
.2+| *high_cpu_load* | bool| - | -
42+
3+| The average CPU load of sensor is too high.
43+
The processing and frame rate will be automatically throttled.
44+
45+
.2+| *high_temperature* | bool| - | -
46+
3+| The temperature of the device is too high.
47+
48+
The CPU frequency will be throttled automatically.
49+
The processing capability might be limited.
50+
Note that an operation outside of the specified temperature range,
51+
can cause permanent damage to the sensor.
52+
53+
|===
54+
55+
[#_blickfeld_compute_module_data_Health_CpuPerformance]
56+
== Cpu Performance
57+
58+
Performance statistics of the CPU
59+
60+
.Available fields in blickfeld.compute_module.data.Health.CpuPerformance
61+
|===
62+
| Field | Type | Default | Unit
63+
64+
.2+| *total_load* | float| - | -
65+
3+| Average CPU load of all cores.
66+
67+
The value range is between 0 and 1.
68+
69+
.2+| *individual_loads* | repeated float| - | -
70+
3+| Individual load per core.
71+
72+
The value range is between 0 and 1.
73+
74+
.2+| *frequency* | float| - | Hz
75+
3+| Current frequency
76+
77+
.2+| *temperature* | float| - | °C
78+
3+| Current temperature
79+
80+
|===
81+
82+
[#_blickfeld_compute_module_data_Health_Uptime]
83+
== Uptime
84+
85+
Uptime of the device
86+
87+
.Available fields in blickfeld.compute_module.data.Health.Uptime
88+
|===
89+
| Field | Type | Default | Unit
90+
91+
.2+| *since_boot* | uint64| - | s
92+
3+| Uptime since the last boot
93+
94+
.2+| *lifetime* | uint64| - | s
95+
3+| Uptime over the whole lifetime.
96+
97+
NOTE: The counting started with the firmware v2.3.
98+
99+
|===
100+

‎doc/modules/protocol/pages/blickfeld/compute_module/services/health.adoc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
= Service: Health
2+
3+
NOTE: This API is officially released and maintained.
4+
5+
The health service provides methods to monitor operational status of the compute module
6+
7+
.Available methods
8+
|===
9+
| Method | Request | Response
10+
11+
| *xref:#Get[]* | https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]| xref:blickfeld/compute_module/services/health.adoc#_blickfeld_compute_module_services_HealthGetResponse[HealthGetResponse]
12+
| *xref:#Watch[]* | https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]| xref:blickfeld/compute_module/services/health.adoc#_blickfeld_compute_module_services_HealthWatchResponse[HealthWatchResponse]Stream
13+
|===
14+
[#Get]
15+
== Get
16+
17+
Returns the current health status
18+
19+
[#_blickfeld_compute_module_services_HealthGetResponse]
20+
=== Response
21+
22+
Response to health get request
23+
24+
.Available fields in blickfeld.compute_module.services.HealthGetResponse
25+
|===
26+
| Field | Type | Default | Unit
27+
28+
.2+| *health* | xref:blickfeld/compute_module/data/health.adoc[data.Health] | - | -
29+
3+| Health state
30+
31+
|===
32+
33+
[#Watch]
34+
== Watch
35+
36+
Can be used to attach to the health monitoring status information
37+
38+
[#_blickfeld_compute_module_services_HealthWatchResponse]
39+
=== Response Stream
40+
41+
Stream response to health watch request
42+
43+
.Available fields in blickfeld.compute_module.services.HealthWatchResponse
44+
|===
45+
| Field | Type | Default | Unit
46+
47+
.2+| *health* | xref:blickfeld/compute_module/data/health.adoc[data.Health] | - | -
48+
3+| Health state
49+
50+
|===
51+

‎doc/modules/protocol/pages/blickfeld/diagnostics/data/health.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ Qb2 modules
5757
.2+| *secure* | xref:blickfeld/diagnostics/data/health.adoc#_blickfeld_diagnostics_data_Health_Module_Health[Health] | - | -
5858
3+| Health of the Blickfeld Secure module
5959
60+
.2+| *video* | xref:blickfeld/diagnostics/data/health.adoc#_blickfeld_diagnostics_data_Health_Module_Health[Health] | - | -
61+
3+| Health of the Blickfeld Video module
62+
63+
.2+| *compute_module* | xref:blickfeld/diagnostics/data/health.adoc#_blickfeld_diagnostics_data_Health_Module_Health[Health] | - | -
64+
3+| Health of the Blickfeld Compute module
65+
6066
|===
6167
6268
[#_blickfeld_diagnostics_data_Health_Module_Health]

‎doc/modules/protocol/pages/blickfeld/percept_pipeline/config/data_source.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ This field is required if user-management is enabled on externally connected dev
6161
3+| Serial number. If set, the connection will be secured with TLS. This field is required if user-management
6262
is enabled on externally connected devices.
6363
64+
.2+| *disabled* | bool| - | -
65+
3+| Disable fetching data from this sensor, setting this flag to `true` disables the evaluation of the entire sensor point cloud
66+
6467
.2+| *metadata* | optional https://protobuf.dev/reference/protobuf/google.protobuf/#struct[google.protobuf.Struct] | - | -
6568
3+| Arbitrary metadata storage for client applications
6669

‎doc/modules/protocol/pages/blickfeld/percept_pipeline/config/zone_algorithm.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ An algorithm that monitors the area within and around a zone.
1616
.2+| *shape* | xref:blickfeld/base/geometry/shape.adoc[base.geometry.Shape] | - | -
1717
3+| Geometric shape (usually a Box) in which the algorithm detects certain behaviors/scenarios
1818
19+
.2+| *disabled* | bool| - | -
20+
3+| Disable this zone, setting this flag to `true` disables the evaluation of the zone
21+
1922
.2+| *metadata* | optional https://protobuf.dev/reference/protobuf/google.protobuf/#struct[google.protobuf.Struct] | - | -
2023
3+| Arbitrary metadata storage for client applications
2124

‎doc/modules/protocol/pages/blickfeld/percept_pipeline/services/perception.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Perception configurations specify the algorithms used for e.g. for background su
1414
| *xref:#Watch[]* | https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]| xref:blickfeld/percept_pipeline/services/perception.adoc#_blickfeld_percept_pipeline_services_PerceptionWatchResponse[PerceptionWatchResponse]Stream
1515
| *xref:#ListTemplates[]* | https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]| xref:blickfeld/percept_pipeline/services/perception.adoc#_blickfeld_percept_pipeline_services_PerceptionListTemplatesResponse[PerceptionListTemplatesResponse]
1616
| *xref:#ResetBackground[]* | xref:blickfeld/percept_pipeline/services/perception.adoc#_blickfeld_percept_pipeline_services_PerceptionResetBackgroundRequest[PerceptionResetBackgroundRequest]| https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]
17+
| *xref:#GetBackground[]* | https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]| xref:blickfeld/percept_pipeline/services/perception.adoc#_blickfeld_percept_pipeline_services_PerceptionGetBackgroundResponse[PerceptionGetBackgroundResponse]
18+
| *xref:#SetBackground[]* | xref:blickfeld/percept_pipeline/services/perception.adoc#_blickfeld_percept_pipeline_services_PerceptionSetBackgroundRequest[PerceptionSetBackgroundRequest]| https://protobuf.dev/reference/protobuf/google.protobuf/#empty[google.protobuf.Empty]
1719
|===
1820
[#Get]
1921
== Get
@@ -129,3 +131,41 @@ has to be mentioned in the 'fqdns' list.
129131
130132
|===
131133
134+
[#GetBackground]
135+
== GetBackground
136+
137+
Get the background frame of a single device
138+
139+
[#_blickfeld_percept_pipeline_services_PerceptionGetBackgroundResponse]
140+
=== Response
141+
142+
Response containing the active background frame
143+
144+
.Available fields in blickfeld.percept_pipeline.services.PerceptionGetBackgroundResponse
145+
|===
146+
| Field | Type | Default | Unit
147+
148+
.2+| *background* | xref:blickfeld/core_processing/data/frame.adoc[core_processing.data.Frame] | - | -
149+
3+| The frame currently active as background
150+
151+
|===
152+
153+
[#SetBackground]
154+
== SetBackground
155+
156+
Set the background frame of a single device
157+
158+
[#_blickfeld_percept_pipeline_services_PerceptionSetBackgroundRequest]
159+
=== Request
160+
161+
Request to set the active background frame
162+
163+
.Available fields in blickfeld.percept_pipeline.services.PerceptionSetBackgroundRequest
164+
|===
165+
| Field | Type | Default | Unit
166+
167+
.2+| *background* | xref:blickfeld/core_processing/data/frame.adoc[core_processing.data.Frame] | - | -
168+
3+| The frame to be set as background
169+
170+
|===
171+

0 commit comments

Comments
 (0)