xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Chassis/Buttons/Button.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1dac7f6c3SNaveen Mosesdescription: >
2*a1347418SPatrick Williams    Button interface is a generic phosphor button interface  which supports two
3*a1347418SPatrick Williams    primary actions (pressed/releasd). When the button is pressed "Pressed"
4*a1347418SPatrick Williams    signal is emitted and when button is released then "Released"
5dac7f6c3SNaveen Moses      signal is emitted.
6dac7f6c3SNaveen Mosesmethods:
7dac7f6c3SNaveen Moses    - name: simPress
8dac7f6c3SNaveen Moses      description: >
9dac7f6c3SNaveen Moses          Emulate button press.
10dac7f6c3SNaveen Moses      errors:
11dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
12dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.IOError
13dac7f6c3SNaveen Moses    - name: simRelease
14dac7f6c3SNaveen Moses      description: >
15dac7f6c3SNaveen Moses          Emulate button release.
16dac7f6c3SNaveen Moses      errors:
17dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
18dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.IOError
19dac7f6c3SNaveen Moses    - name: simLongPress
20dac7f6c3SNaveen Moses      description: >
21dac7f6c3SNaveen Moses          Emulate long button press.
22dac7f6c3SNaveen Moses      errors:
23dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
24dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.IOError
25dac7f6c3SNaveen Moses
26dac7f6c3SNaveen Mosesproperties:
27dac7f6c3SNaveen Moses    - name: Enabled
28dac7f6c3SNaveen Moses      type: boolean
29dac7f6c3SNaveen Moses      default: true
30dac7f6c3SNaveen Moses      description: >
31*a1347418SPatrick Williams          Enable/disable the button object. false means button is disabled true
32*a1347418SPatrick Williams          means button is enabled
33dac7f6c3SNaveen Moses      errors:
34dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
35dac7f6c3SNaveen Moses          - xyz.openbmc_project.Chassis.Common.Error.IOError
36dac7f6c3SNaveen Moses
37dac7f6c3SNaveen Mosessignals:
38dac7f6c3SNaveen Moses    - name: Released
39dac7f6c3SNaveen Moses      description: >
40dac7f6c3SNaveen Moses          Button released signal
41dac7f6c3SNaveen Moses    - name: Pressed
42dac7f6c3SNaveen Moses      description: >
43dac7f6c3SNaveen Moses          Button pressed signal
44dac7f6c3SNaveen Moses    - name: PressedLong
45dac7f6c3SNaveen Moses      description: >
46dac7f6c3SNaveen Moses          Button long pressed signal
47