| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 2 | Button interface is a generic phosphor button interface which supports two |
| 3 | primary actions (pressed/releasd). When the button is pressed "Pressed" |
| 4 | signal is emitted and when button is released then "Released" |
| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 5 | signal is emitted. |
| 6 | methods: |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 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 |
| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 25 | |
| 26 | properties: |
| 27 | - name: Enabled |
| 28 | type: boolean |
| 29 | default: true |
| 30 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 31 | Enable/disable the button object. false means button is disabled true |
| 32 | means button is enabled |
| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 33 | errors: |
| 34 | - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand |
| 35 | - xyz.openbmc_project.Chassis.Common.Error.IOError |
| 36 | |
| 37 | signals: |
| 38 | - name: Released |
| 39 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 40 | Button released signal |
| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 41 | - name: Pressed |
| 42 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 43 | Button pressed signal |
| Naveen Moses | dac7f6c | 2022-04-13 18:20:16 +0530 | [diff] [blame] | 44 | - name: PressedLong |
| 45 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 46 | Button long pressed signal |