sampled_value

OCPP 2.1 SampledValue data type (schema SampledValueType).

to_json/decoder map to/from its OCPP-J JSON object; new (when present) builds a value from the required fields only.

Types

SampledValue

</>

Single sampled value in MeterValues. Each value can be accompanied by optional fields.

To save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.

Field	Type	Req	Description
`context`	`ReadingContext`	—
`custom_data`	`CustomData`	—
`location`	`Location`	—
`measurand`	`Measurand`	—
`phase`	`Phase`	—
`signed_meter_value`	`SignedMeterValue`	—
`unit_of_measure`	`UnitOfMeasure`	—
`value`	`Float`	✓	Indicates the measured value.

Schema: SampledValueType

pub type SampledValue {
  SampledValue(
    context: option.Option(reading_context.ReadingContext),
    custom_data: option.Option(custom_data.CustomData),
    location: option.Option(location.Location),
    measurand: option.Option(measurand.Measurand),
    phase: option.Option(phase.Phase),
    signed_meter_value: option.Option(
      signed_meter_value.SignedMeterValue,
    ),
    unit_of_measure: option.Option(unit_of_measure.UnitOfMeasure),
    value: Float,
  )
}

Constructors

SampledValue(
  context: option.Option(reading_context.ReadingContext),
  custom_data: option.Option(custom_data.CustomData),
  location: option.Option(location.Location),
  measurand: option.Option(measurand.Measurand),
  phase: option.Option(phase.Phase),
  signed_meter_value: option.Option(
    signed_meter_value.SignedMeterValue,
  ),
  unit_of_measure: option.Option(unit_of_measure.UnitOfMeasure),
  value: Float,
)

Values

decoder

</>

pub fn decoder() -> decode.Decoder(SampledValue)

Decode a SampledValue from its OCPP-J JSON object, enforcing schema constraints.

new

</>

pub fn new(value value: Float) -> SampledValue

Construct a SampledValue from its required fields, with every optional field set to None.

to_json

</>

pub fn to_json(value: SampledValue) -> json.Json

Encode a SampledValue to its OCPP-J JSON object.