chore: improve doc

Author: bougou

cmd/goipmi/commands/x.go

@@ -31,6 +31,7 @@ func NewCmdX() *cobra.Command {
 	}
 	cmd.AddCommand(NewCmdXGetSDRs())
 	cmd.AddCommand(NewCmdXGetSensors())
+	cmd.AddCommand(NewCmdXGetSensorsFilterFans())
 	cmd.AddCommand(NewCmdXGetDeviceSDRs())
 	cmd.AddCommand(NewCmdXGetPayloadActivationStatus())
 	cmd.AddCommand(NewCmdXGetDeviceGUID())
@@ -137,6 +138,24 @@ func NewCmdXGetSensors() *cobra.Command {
 	return cmd
 }
 
+func NewCmdXGetSensorsFilterFans() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "get-sensors-filter-fans",
+		Short: "get-sensors-filter-fans",
+		Run: func(cmd *cobra.Command, args []string) {
+			ctx := context.Background()
+			res, err := client.GetSensors(ctx, ipmi.SensorFilterOptionIsSensorType(ipmi.SensorTypeFan))
+			if err != nil {
+				fmt.Printf("GetSensors failed, err: %s", err)
+				return
+			}
+			fmt.Printf("GetSensors succeeded, %d records\n", len(res))
+			fmt.Println(ipmi.FormatSensors(true, res...))
+		},
+	}
+	return cmd
+}
+
 func NewCmdXGetDeviceSDRs() *cobra.Command {
 	var show bool
 

cmd_get_sensors.go

@@ -36,6 +36,11 @@ func SensorFilterOptionIsSensorType(sensorTypes ...SensorType) func(sensor *Sens
 // passed all filter options, that means the filter options are logically ANDed.
 //
 // If you want the filter options are logically ORed, use `GetSensorsAny`
+//
+// Example:
+//
+//	// get all sensors with fan type
+//	sensors, err := client.GetSensors(ctx, ipmi.SensorFilterOptionIsSensorType(ipmi.SensorTypeFan))
 func (c *Client) GetSensors(ctx context.Context, filterOptions ...SensorFilterOption) ([]*Sensor, error) {
 	var out = make([]*Sensor, 0)