ocpp::v2::Availability Class Reference

Inheritance diagram for ocpp::v2::Availability:

Public Member Functions
	Availability (const FunctionalBlockContext &functional_block_context, std::optional< TimeSyncCallback > time_sync_callback, std::optional< AllConnectorsUnavailableCallback > all_connectors_unavailable_callback)
void	handle_message (const ocpp::EnhancedMessage< MessageType > &message) override
	Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...
void	status_notification_req (const int32_t evse_id, const int32_t connector_id, const ConnectorStatusEnum status, const bool initiated_by_trigger_message=false) override
	Send a StatusNotificationRequest to the CSMS. More...
void	heartbeat_req (const bool initiated_by_trigger_message=false) override
	Send a HeartbeatRequest to the CSMS. More...
void	handle_scheduled_change_availability_requests (const int32_t evse_id) override
	Handle / send the scheduled change availability requests. More...
void	set_scheduled_change_availability_requests (const int32_t evse_id, AvailabilityChange availability_change) override
	Set scheduled change availability requests, that should be sent later (for example because of a firmware update). More...
void	set_heartbeat_timer_interval (const std::chrono::seconds &interval) override
	Set the heartbeat timer interval. More...
void	stop_heartbeat_timer () override
	Stop the heartbeat timer. More...
virtual void	handle_message (const ocpp::EnhancedMessage< MessageType > &message)=0
	Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...
virtual void	status_notification_req (const int32_t evse_id, const int32_t connector_id, const ConnectorStatusEnum status, const bool initiated_by_trigger_message=false)=0
	Send a StatusNotificationRequest to the CSMS. More...
virtual void	heartbeat_req (const bool initiated_by_trigger_message=false)=0
	Send a HeartbeatRequest to the CSMS. More...
virtual void	handle_scheduled_change_availability_requests (const int32_t evse_id)=0
	Handle / send the scheduled change availability requests. More...
virtual void	set_scheduled_change_availability_requests (const int32_t evse_id, AvailabilityChange availability_change)=0
	Set scheduled change availability requests, that should be sent later (for example because of a firmware update). More...
virtual void	set_heartbeat_timer_interval (const std::chrono::seconds &interval)=0
	Set the heartbeat timer interval. More...
virtual void	stop_heartbeat_timer ()=0
	Stop the heartbeat timer. More...
virtual void	handle_message (const EnhancedMessage< MessageType > &message)=0
	Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...

Member Function Documentation

handle_message()

void ocpp::v2::Availability::handle_message ( const ocpp::EnhancedMessage< MessageType > &  message )

overridevirtual

Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message .

Parameters

message

Implements ocpp::v2::AvailabilityInterface.

handle_scheduled_change_availability_requests()

void ocpp::v2::Availability::handle_scheduled_change_availability_requests ( const int32_t  evse_id )

overridevirtual

Handle / send the scheduled change availability requests.

Parameters

evse_id

The evse id of the change availability request.

Implements ocpp::v2::AvailabilityInterface.

heartbeat_req()

void ocpp::v2::Availability::heartbeat_req ( const bool  initiated_by_trigger_message = false )

overridevirtual

Send a HeartbeatRequest to the CSMS.

Parameters

initiated_by_trigger_message

True if sending of the request was triggered by a trigger message.

Implements ocpp::v2::AvailabilityInterface.

set_heartbeat_timer_interval()

void ocpp::v2::Availability::set_heartbeat_timer_interval ( const std::chrono::seconds &  interval )

overridevirtual

Set the heartbeat timer interval.

Parameters

interval

The interval in seconds.

Implements ocpp::v2::AvailabilityInterface.

set_scheduled_change_availability_requests()

void ocpp::v2::Availability::set_scheduled_change_availability_requests ( const int32_t  evse_id, AvailabilityChange  availability_change  )

overridevirtual

Set scheduled change availability requests, that should be sent later (for example because of a firmware update).

Parameters

evse_id	The evse id.
availability_change	The availability change request.

Implements ocpp::v2::AvailabilityInterface.

status_notification_req()

void ocpp::v2::Availability::status_notification_req ( const int32_t  evse_id, const int32_t  connector_id, const ConnectorStatusEnum  status, const bool  initiated_by_trigger_message = false  )

overridevirtual

Send a StatusNotificationRequest to the CSMS.

Parameters

evse_id	Evse id.
connector_id	Connector id.
status	Status to send.
initiated_by_trigger_message	True if sending of the request was triggered by a trigger message.

Implements ocpp::v2::AvailabilityInterface.

stop_heartbeat_timer()

void ocpp::v2::Availability::stop_heartbeat_timer ( )

overridevirtual

Stop the heartbeat timer.

Implements ocpp::v2::AvailabilityInterface.

---

The documentation for this class was generated from the following files:

• include/ocpp/v2/functional_blocks/availability.hpp
• lib/ocpp/v2/functional_blocks/availability.cpp