| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 1 | description: > |
| 2 | Button interface is a generic phosphor button interface which supports |
| 3 | two primary actions (pressed/releasd). When the button is pressed |
| 4 | "Pressed" signal is emitted and when button is released then "Released" |
| 5 | signal is emitted. |
| 6 | methods: |
| 7 | - name: simPress |
| 8 | description: > |
| 9 | Emulate button press. |
| 10 | errors: |
| 11 | - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand |
| 12 | - xyz.openbmc_project.Chassis.Common.Error.IOError |
| 13 | - name: simRelease |
| 14 | description: > |
| 15 | Emulate button release. |
| 16 | errors: |
| 17 | - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand |
| 18 | - xyz.openbmc_project.Chassis.Common.Error.IOError |
| 19 | - name: simLongPress |
| 20 | description: > |
| 21 | Emulate long button press. |
| 22 | errors: |
| 23 | - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand |
| 24 | - xyz.openbmc_project.Chassis.Common.Error.IOError |
| 25 | |
| 26 | properties: |
| 27 | - name: Enabled |
| 28 | type: boolean |
| 29 | default: true |
| 30 | description: > |
| 31 | Enable/disable the button object. |
| 32 | false means button is disabled |
| 33 | true means button is enabled |
| 34 | errors: |
| 35 | - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand |
| 36 | - xyz.openbmc_project.Chassis.Common.Error.IOError |
| 37 | |
| 38 | signals: |
| 39 | - name: Released |
| 40 | description: > |
| 41 | Button released signal |
| 42 | - name: Pressed |
| 43 | description: > |
| 44 | Button pressed signal |
| 45 | - name: PressedLong |
| 46 | description: > |
| 47 | Button long pressed signal |