1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
|
package ipmi
import (
"context"
"fmt"
"time"
)
// GetDCMIPowerReadingRequest represents a "Get Power Reading" request according
// to section 6.6.1 of the [DCMI specification v1.5].
//
// Currently, only the basic "System Power Statistics" mode is supported, not
// the extended mode.
//
// [DCMI specification v1.5]: https://www.intel.com/content/dam/www/public/us/en/documents/technical-specifications/dcmi-v1-5-rev-spec.pdf
type GetDCMIPowerReadingRequest struct {
// TODO add support for extended mode...
}
// GetDCMIPowerReadingResponse represents a response to a [GetDCMIPowerReadingRequest].
type GetDCMIPowerReadingResponse struct {
// Current Power in watts
CurrentPower uint16
// Minimum Power over sampling duration in watts
MinimumPower uint16
// Maximum Power over sampling duration in watts
MaximumPower uint16
// Average Power over sampling duration in watts
AveragePower uint16
// IPMI Specification based Time Stamp
//
// For Mode 02h (not yet supported), the time stamp specifies the end of the
// averaging window.
Timestamp uint32
// Statistics reporting time period
//
// For Mode 01h, time-frame in milliseconds, over which the controller
// collects statistics. For Mode 02h (not yet supported), time-frame reflects
// the Averaging Time period in units.
ReportingPeriod uint32
// True if power measurements are available, false otherwise.
PowerMeasurementActive bool
}
func (req *GetDCMIPowerReadingRequest) Pack() []byte {
// second byte 0x01 = "basic" System Power Statistics
return []byte{GroupExtensionDCMI, 0x01, 0x00, 0x00}
}
func (req *GetDCMIPowerReadingRequest) Command() Command {
return CommandGetDCMIPowerReading
}
func (res *GetDCMIPowerReadingResponse) CompletionCodes() map[uint8]string {
return map[uint8]string{}
}
func (res *GetDCMIPowerReadingResponse) Unpack(msg []byte) error {
if len(msg) < 18 {
return ErrUnpackedDataTooShortWith(len(msg), 19)
}
var off int
if err := CheckDCMIGroupExenstionMatch(msg[0]); err != nil {
return err
}
res.CurrentPower, off, _ = unpackUint16L(msg, 1)
res.MinimumPower, off, _ = unpackUint16L(msg, off)
res.MaximumPower, off, _ = unpackUint16L(msg, off)
res.AveragePower, off, _ = unpackUint16L(msg, off)
res.Timestamp, off, _ = unpackUint32L(msg, off)
res.ReportingPeriod, off, _ = unpackUint32L(msg, off)
state, _, _ := unpackUint8(msg, off)
res.PowerMeasurementActive = isBit6Set(state)
return nil
}
func (res *GetDCMIPowerReadingResponse) Format() string {
ts := time.Unix(int64(res.Timestamp), 0)
return "" +
fmt.Sprintf("Instantaneous power reading : %5d Watts\n", res.CurrentPower) +
fmt.Sprintf("Minimum during sampling period : %5d Watts\n", res.MinimumPower) +
fmt.Sprintf("Maximum during sampling period : %5d Watts\n", res.MaximumPower) +
fmt.Sprintf("Average power reading over sample period : %5d Watts\n", res.AveragePower) +
fmt.Sprintf("IPMI timestamp : %s\n", ts.Format("01/02/06 15:04:05 UTC")) +
fmt.Sprintf("Sampling period : %d Seconds\n", res.ReportingPeriod/1000) +
fmt.Sprintf("Power reading state is : %s\n", formatBool(res.PowerMeasurementActive, "activated", "deactivated"))
}
// GetDCMIPowerReading sends a DCMI "Get Power Reading" command.
// See [GetDCMIPowerReadingRequest] for details.
func (c *Client) GetDCMIPowerReading(ctx context.Context) (response *GetDCMIPowerReadingResponse, err error) {
request := &GetDCMIPowerReadingRequest{}
response = &GetDCMIPowerReadingResponse{}
err = c.Exchange(ctx, request, response)
return
}
|