blob: f4f9784c486b2e7a3bd40abd4c905cdb806e5683 [file] [log] [blame]
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +05301description: >
2 Interface to control physical LED.
3
4properties:
5 - name: State
6 type: enum[self.Action]
Vishwanatha Subbannad9751fa2016-11-29 11:30:54 +05307 default: 'Off'
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +05308 description: >
9 Current State of the LED.
10
11 - name: DutyOn
12 type: byte
13 default: 50
14 description: >
15 Percentage time the LED needs to be ON while blinking.
16
17 - name: Color
18 type: enum[self.Palette]
19 default: Unknown
20 description: >
21 Color that the LED can emit.
22
Vishwanatha Subbanna47af1f72016-12-13 21:33:05 +053023 - name: Period
24 type: uint16
25 default: 1000
26 description: >
27 LED blink period expressed as milliseconds per on/off cycle.
28
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053029enumerations:
30 - name: Action
31 description: >
32 Possible states a LED can be in.
33 values:
Vishwanatha Subbannad9751fa2016-11-29 11:30:54 +053034 - name: 'Off'
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053035 description: >
36 LED is in OFF state
Vishwanatha Subbannad9751fa2016-11-29 11:30:54 +053037 - name: 'On'
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053038 description: >
39 LED is in solid ON state
Vishwanatha Subbannad9751fa2016-11-29 11:30:54 +053040 - name: 'Blink'
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053041 description: >
42 LED is blinking
43
44 - name: Palette
45 description: >
46 Possible colors that the LED can emit.
47 values:
48 - name: Unknown
49 description: >
50 Color emitted by LED is unknown.
51 - name: Red
52 description: >
53 LED can emit Red color.
54 - name: Green
55 description: >
56 LED can emit Green color.
57 - name: Blue
58 description: >
59 LED can emit Blue color.
60 - name: Yellow
61 description: >
62 LED can emit Yellow color.