ocpp - v0.2.0

ocpp/v2_1/datatype/network_connection_profile

OCPP 2.1 NetworkConnectionProfile data type (schema NetworkConnectionProfileType).

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

Types

NetworkConnectionProfile

</>

The NetworkConnectionProfile defines the functional and technical parameters of a communication link.

FieldTypeReqDescription
apnApn—
basic_auth_passwordString—(2.1) BasicAuthPassword to use for security profile 1 or 2. (max 64 chars)
custom_dataCustomData—
identityString—(2.1) Charging Station identity to be used as the basic authentication username. (max 48 chars)
message_timeoutInt✓Duration in seconds before a message send by the Charging Station via this network connection times-out. The best setting depends on the underlying network and response times of the CSMS. If you are looking for a some guideline: use 30 seconds as a starting point.
ocpp_csms_urlString✓URL of the CSMS(s) that this Charging Station communicates with, without the Charging Station identity part. + The SecurityCtrlr.Identity field is appended to ocppCsmsUrl to provide the full websocket URL. (max 2000 chars)
ocpp_interfaceOcppInterface✓
ocpp_transportOcppTransport✓
ocpp_versionOcppVersion—
security_profileInt✓This field specifies the security profile used when connecting to the CSMS with this NetworkConnectionProfile. (≥ 0)
vpnVpnType—

Schema: NetworkConnectionProfileType

pub type NetworkConnectionProfile {
  NetworkConnectionProfile(
    apn: option.Option(apn.Apn),
    basic_auth_password: option.Option(String),
    custom_data: option.Option(custom_data.CustomData),
    identity: option.Option(String),
    message_timeout: Int,
    ocpp_csms_url: String,
    ocpp_interface: ocpp_interface.OcppInterface,
    ocpp_transport: ocpp_transport.OcppTransport,
    ocpp_version: option.Option(ocpp_version.OcppVersion),
    security_profile: Int,
    vpn: option.Option(vpn_type.VpnType),
  )
}

Constructors

Values

decoder

</> 
pub fn decoder() -> decode.Decoder(NetworkConnectionProfile)

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

new

</> 
pub fn new(
  message_timeout message_timeout: Int,
  ocpp_csms_url ocpp_csms_url: String,
  ocpp_interface ocpp_interface: ocpp_interface.OcppInterface,
  ocpp_transport ocpp_transport: ocpp_transport.OcppTransport,
  security_profile security_profile: Int,
) -> NetworkConnectionProfile

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

to_json

</> 
pub fn to_json(value: NetworkConnectionProfile) -> json.Json

Encode a NetworkConnectionProfile to its OCPP-J JSON object.

✨ Search Document