Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-host-ipmid / e0af7209c748794b867bce6901f834d10d47773f / . / scripts / sensor-example.yaml
blob: 750da95203f33fcd69802a6edc9c985b224d13ff [file] [log] [blame]
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]1#sample yaml with documentation
2#Sensor Number
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]30xa6:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]4 #Sensor Type
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]5 sensorType: 0x0C
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]6 #There are two types of updates one with Set method and other with
7 #Notify method for inventory updates. The path indicates Inventory path for
8 #the Notify method and Dbus object path for Set method.
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]9 path: /system/chassis/motherboard/dimm0
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]10 #event reading type
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]11 sensorReadingType: 0x6F
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]12 #Dbus service interface to make a bus call to update or request value of a
13 #property
14 serviceInterface: xyz.openbmc_project.Inventory.Manager
15 #command data has three fields, sensor reading value, assertion and
16 #deassertion bits and event data, this indicates which data field should
17 #be used. Possible value to be updated.
18 readingType: assertion
19 #List of dbus interfaces associated with the interested properties.
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]20 interfaces:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]21 #Dbus interface implementing the interested property.
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]22 xyz.openbmc_project.State.Decorator.OperationalStatus:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]23 #DBus property
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]24 Functional:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]25 #Offset, for assertion it should be a bit mask to indicate which bit
26 #indicates the property is true or false, in event or reading types
27 #the value will get mapped to a Dbus enum, 0xFF need to give if the
28 #reading or event value need to be updated as it is.
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]29 0x04:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]30 #type of the property
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]31 type: bool
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]32 #mapping from event offset bit in the command to the property value.
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]33 deassert: "true"
34 assert: "false"
35 xyz.openbmc_project.Inventory.Item:
36 Present:
37 0x06:
38 type: bool
39 assert: "true"
40 deassert: "false"
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]410x07:
42 sensorType: 0xC3
43 path: /xyz/openbmc_project/control/host0
44 sensorReadingType: 0x6F
45 serviceInterface: org.freedesktop.DBus.Properties
46 readingType: reading
47 interfaces:
48 xyz.openbmc_project.Control.Boot.RebootAttempts:
49 AttemptsLeft:
50 #A 0xFF indicates the value need to be send to dbus
51 0xFF:
52 type: uint32_t
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]530xa8:
54 sensorType: 0x0C
55 path: /system/chassis/motherboard/dimm1
56 sensorReadingType: 0x6F
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]57 serviceInterface: xyz.openbmc_project.Inventory.Manager
58 readingType: assertion
59 byteOffset: 0x00
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]60 interfaces:
61 xyz.openbmc_project.State.Decorator.OperationalStatus:
62 Functional:
63 0x04:
64 type: bool
65 deassert: "true"
66 assert: "false"
67 xyz.openbmc_project.Inventory.Item:
68 Present:
69 0x06:
70 type: bool
71 assert: "true"
72 deassert: "false"
730xaa:
74 sensorType: 0x0C
75 path: /system/chassis/motherboard/dimm2
76 sensorReadingType: 0x6F
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]77 serviceInterface: xyz.openbmc_project.Inventory.Manager
78 readingType: assertion
79 byteOffset: 0x00
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]80 interfaces:
81 xyz.openbmc_project.State.Decorator.OperationalStatus:
82 Functional:
83 0x04:
84 type: bool
85 deassert: "true"
86 assert: "false"
87 xyz.openbmc_project.Inventory.Item:
88 Present:
89 0x06:
90 type: bool
91 assert: "true"
92 deassert: "false"
930xac:
94 sensorType: 0x0C
95 path: /system/chassis/motherboard/dimm3
96 sensorReadingType: 0x6F
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame^]97 serviceInterface: xyz.openbmc_project.Inventory.Manager
98 readingType: assertion
99 byteOffset: 0x00
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]100 interfaces:
101 xyz.openbmc_project.State.Decorator.OperationalStatus:
102 Functional:
103 0x04:
104 type: bool
105 deassert: "true"
106 assert: "false"
107 xyz.openbmc_project.Inventory.Item:
108 Present:
109 0x06:
110 type: bool
111 assert: "true"
112 deassert: "false"