summaryrefslogtreecommitdiff
path: root/doc/heartrate-api.txt
blob: 665db126b5304bb72cc55e0cc7b0fd2f42b3d3e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Heart Rate API description
**************************


Heart Rate Manager hierarchy
============================

Service		org.bluez
Interface	org.bluez.HeartRateManager1
Object path	[variable prefix]/{hci0,hci1,...}

Methods		RegisterWatcher(object agent)

			Registers a watcher to monitor heart rate measurements.

			Possible Errors: org.bluez.Error.InvalidArguments

		UnregisterWatcher(object agent)

			Unregisters a watcher.

Heart Rate Profile hierarchy
============================

Service		org.bluez
Interface	org.bluez.HeartRate1
Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX

Methods		Reset()

			Restart the accumulation of energy expended from zero.

			Possible Errors: org.bluez.Error.NotSupported

Properties	string Location (optional) [readonly]

			Possible values: "other", "chest", "wrist","winger",
					"hand", "earlobe", "foot"

		boolean ResetSupported [readonly]

			True if energy expended is supported.

Heart Rate Watcher hierarchy
============================

Service		unique name
Interface	org.bluez.HeartRateWatcher1
Object path	freely definable

Methods		void MeasurementReceived(object device, dict measurement)

			This callback is called whenever a heart rate
			measurement is received from the heart rate device.

			Measurement:

				uint16 Value:

					Measurement value expressed in beats per
					minute (bpm)

				uint16 Energy (optional):

					Accumulated energy expended in kilo Joules

				boolean Contact (optional):

					true if skin contact is detected by sensor,
					false otherwise

				array{uint16} Interval (optional):

					RR-Interval values which represent the time
					between two consecutive R waves in an ECG.
					Values are ordered starting from oldest to
					most recent.