variable_monitoring

OCPP 2.0.1 VariableMonitoring data type (schema VariableMonitoringType).

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

Types

VariableMonitoring

</>

A monitoring setting for a variable.

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`id`	`Int`	✓	Identifies the monitor.
`severity`	`Int`	✓	The severity that will be assigned to an event that is triggered by this monitor. The severity range is 0-9, with 0 as the highest and 9 as the lowest severity level. The severity levels have the following meaning: + 0-Danger + Indicates lives are potentially in danger. Urgent attention is needed and action should be taken immediately. + 1-Hardware Failure + Indicates that the Charging Station is unable to continue regular operations due to Hardware issues. Action is required. + 2-System Failure + Indicates that the Charging Station is unable to continue regular operations due to software or minor hardware issues. Action is required. + 3-Critical + Indicates a critical error. Action is required. + 4-Error + Indicates a non-urgent error. Action is required. + 5-Alert + Indicates an alert event. Default severity for any type of monitoring event. + 6-Warning + Indicates a warning event. Action may be required. + 7-Notice + Indicates an unusual event. No immediate action is required. + 8-Informational + Indicates a regular operational event. May be used for reporting, measuring throughput, etc. No action is required. + 9-Debug + Indicates information useful to developers for debugging, not useful during operations.
`transaction`	`Bool`	✓	Monitor only active when a transaction is ongoing on a component relevant to this transaction.
`type_`	`Monitor`	✓
`value`	`Float`	✓	Value for threshold or delta monitoring. For Periodic or PeriodicClockAligned this is the interval in seconds.

Schema: VariableMonitoringType

pub type VariableMonitoring {
  VariableMonitoring(
    custom_data: option.Option(custom_data.CustomData),
    id: Int,
    severity: Int,
    transaction: Bool,
    type_: monitor.Monitor,
    value: Float,
  )
}

Constructors

VariableMonitoring(
  custom_data: option.Option(custom_data.CustomData),
  id: Int,
  severity: Int,
  transaction: Bool,
  type_: monitor.Monitor,
  value: Float,
)

Values

decoder

</>

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

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

new

</>

pub fn new(
  id id: Int,
  severity severity: Int,
  transaction transaction: Bool,
  type_ type_: monitor.Monitor,
  value value: Float,
) -> VariableMonitoring

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

to_json

</>

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

Encode a VariableMonitoring to its OCPP-J JSON object.