blob: 5378dfea6f08a846e28ffe0c8ece88691eef8d84 [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]
Patrick Williams8da396c2022-03-14 14:21:02 -05007 default: "Off"
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +05308 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -05009 Current State of the LED.
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053010
11 - name: DutyOn
12 type: byte
13 default: 50
14 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050015 Percentage time the LED needs to be ON while blinking.
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053016
17 - name: Color
18 type: enum[self.Palette]
19 default: Unknown
20 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050021 Color that the LED can emit.
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053022
Vishwanatha Subbanna47af1f72016-12-13 21:33:05 +053023 - name: Period
24 type: uint16
25 default: 1000
26 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050027 LED blink period expressed as milliseconds per on/off cycle.
Vishwanatha Subbanna47af1f72016-12-13 21:33:05 +053028
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053029enumerations:
30 - name: Action
31 description: >
32 Possible states a LED can be in.
33 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050034 - name: "Off"
35 description: >
36 LED is in OFF state
37 - name: "On"
38 description: >
39 LED is in solid ON state
40 - name: "Blink"
41 description: >
42 LED is blinking
Vishwanatha Subbannaa1e70a72016-11-12 16:00:00 +053043
44 - name: Palette
45 description: >
46 Possible colors that the LED can emit.
47 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050048 - 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.