Skip to content

Commit ea50edb

Browse files
committed
[messages] Renammed SignedFirmwareUpdate message to SignedUpdateFirmware to match the specification
1 parent 3b3d6a3 commit ea50edb

File tree

10 files changed

+51
-51
lines changed

10 files changed

+51
-51
lines changed

src/centralsystem/chargepoint/ChargePointProxy.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
4141
#include "Reset.h"
4242
#include "SendLocalList.h"
4343
#include "SetChargingProfile.h"
44-
#include "SignedFirmwareUpdate.h"
44+
#include "SignedUpdateFirmware.h"
4545
#include "TriggerMessage.h"
4646
#include "UnlockConnector.h"
4747
#include "UpdateFirmware.h"
@@ -1003,7 +1003,7 @@ ocpp::types::UpdateFirmwareStatusEnumType ChargePointProxy::signedUpdateFirmware
10031003
<< " - signingCertificate subject = " << signing_certificate.subjectString() << " - signature = " << signature;
10041004

10051005
// Prepare request
1006-
SignedFirmwareUpdateReq req;
1006+
SignedUpdateFirmwareReq req;
10071007
req.requestId = request_id;
10081008
req.retries = retries;
10091009
if (retry_interval.isSet())
@@ -1017,8 +1017,8 @@ ocpp::types::UpdateFirmwareStatusEnumType ChargePointProxy::signedUpdateFirmware
10171017
req.firmware.signature.assign(signature);
10181018

10191019
// Send request
1020-
SignedFirmwareUpdateConf resp;
1021-
CallResult res = m_msg_sender.call(SIGNED_FIRMWARE_UPDATE_ACTION, req, resp);
1020+
SignedUpdateFirmwareConf resp;
1021+
CallResult res = m_msg_sender.call(SIGNED_UPDATE_FIRMWARE_ACTION, req, resp);
10221022
if (res == CallResult::Ok)
10231023
{
10241024
ret = resp.status;

src/chargepoint/ChargePoint.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -720,16 +720,16 @@ bool ChargePoint::signCertificate()
720720
return ret;
721721
}
722722

723-
/** @copydoc bool IChargePoint::notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType) */
724-
bool ChargePoint::notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType status)
723+
/** @copydoc bool IChargePoint::notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType) */
724+
bool ChargePoint::notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType status)
725725
{
726726
bool ret = false;
727727

728728
if (m_status_manager)
729729
{
730730
if (m_status_manager->getRegistrationStatus() != RegistrationStatus::Rejected)
731731
{
732-
ret = m_maintenance_manager->notifySignedFirmwareUpdateStatus(status);
732+
ret = m_maintenance_manager->notifySignedUpdateFirmwareStatus(status);
733733
}
734734
else
735735
{

src/chargepoint/ChargePoint.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ class ChargePoint : public IChargePoint,
171171
/** @copydoc bool IChargePoint::signCertificate() */
172172
bool signCertificate() override;
173173

174-
/** @copydoc bool IChargePoint::notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType) */
175-
bool notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType status) override;
174+
/** @copydoc bool IChargePoint::notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType) */
175+
bool notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType status) override;
176176

177177
// RpcClient::IListener interface
178178

src/chargepoint/interface/IChargePoint.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ class IChargePoint
252252
* @param status Installation status (see FirmwareStatusEnumType documentation)
253253
* @return true if the notification has been sent, false otherwise
254254
*/
255-
virtual bool notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType status) = 0;
255+
virtual bool notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType status) = 0;
256256
};
257257

258258
} // namespace chargepoint

src/chargepoint/maintenance/MaintenanceManager.cpp

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ MaintenanceManager::MaintenanceManager(const ocpp::config::IChargePointConfig&
6161
GenericMessageHandler<GetDiagnosticsReq, GetDiagnosticsConf>(GET_DIAGNOSTICS_ACTION, messages_converter),
6262
GenericMessageHandler<UpdateFirmwareReq, UpdateFirmwareConf>(UPDATE_FIRMWARE_ACTION, messages_converter),
6363
GenericMessageHandler<GetLogReq, GetLogConf>(GET_LOG_ACTION, messages_converter),
64-
GenericMessageHandler<SignedFirmwareUpdateReq, SignedFirmwareUpdateConf>(SIGNED_FIRMWARE_UPDATE_ACTION, messages_converter),
64+
GenericMessageHandler<SignedUpdateFirmwareReq, SignedUpdateFirmwareConf>(SIGNED_UPDATE_FIRMWARE_ACTION, messages_converter),
6565
m_stack_config(stack_config),
6666
m_internal_config(internal_config),
6767
m_events_handler(events_handler),
@@ -86,8 +86,8 @@ MaintenanceManager::MaintenanceManager(const ocpp::config::IChargePointConfig&
8686
msg_dispatcher.registerHandler(UPDATE_FIRMWARE_ACTION,
8787
*dynamic_cast<GenericMessageHandler<UpdateFirmwareReq, UpdateFirmwareConf>*>(this));
8888
msg_dispatcher.registerHandler(GET_LOG_ACTION, *dynamic_cast<GenericMessageHandler<GetLogReq, GetLogConf>*>(this));
89-
msg_dispatcher.registerHandler(SIGNED_FIRMWARE_UPDATE_ACTION,
90-
*dynamic_cast<GenericMessageHandler<SignedFirmwareUpdateReq, SignedFirmwareUpdateConf>*>(this));
89+
msg_dispatcher.registerHandler(SIGNED_UPDATE_FIRMWARE_ACTION,
90+
*dynamic_cast<GenericMessageHandler<SignedUpdateFirmwareReq, SignedUpdateFirmwareConf>*>(this));
9191
trigger_manager.registerHandler(MessageTrigger::DiagnosticsStatusNotification, *this);
9292
trigger_manager.registerHandler(MessageTrigger::FirmwareStatusNotification, *this);
9393
trigger_manager.registerHandler(MessageTriggerEnumType::LogStatusNotification, *this);
@@ -146,7 +146,7 @@ bool MaintenanceManager::notifyFirmwareUpdateStatus(bool success)
146146
}
147147

148148
/** @brief Notify the end of a signed firmware update operation */
149-
bool MaintenanceManager::notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType status)
149+
bool MaintenanceManager::notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType status)
150150
{
151151
// Update status
152152
m_signed_firmware_status = status;
@@ -465,8 +465,8 @@ bool MaintenanceManager::handleMessage(const ocpp::messages::GetLogReq& request,
465465
* const char*& error_code,
466466
* std::string& error_message)
467467
*/
468-
bool MaintenanceManager::handleMessage(const ocpp::messages::SignedFirmwareUpdateReq& request,
469-
ocpp::messages::SignedFirmwareUpdateConf& response,
468+
bool MaintenanceManager::handleMessage(const ocpp::messages::SignedUpdateFirmwareReq& request,
469+
ocpp::messages::SignedUpdateFirmwareConf& response,
470470
const char*& error_code,
471471
std::string& error_message)
472472
{
@@ -517,7 +517,7 @@ bool MaintenanceManager::handleMessage(const ocpp::messages::SignedFirmwareUpdat
517517
// Create a separate thread since the operation can be time consuming
518518
m_firmware_request_id = request.requestId;
519519
m_internal_config.setKey(SIGNED_FW_UPDATE_ID_KEY, std::to_string(request.requestId));
520-
m_firmware_thread = new std::thread(std::bind(&MaintenanceManager::processSignedFirmwareUpdate,
520+
m_firmware_thread = new std::thread(std::bind(&MaintenanceManager::processSignedUpdateFirmware,
521521
this,
522522
request.firmware.location,
523523
request.retries,
@@ -812,7 +812,7 @@ void MaintenanceManager::sendLogStatusNotification()
812812
}
813813

814814
/** @brief Process the signed firmware update */
815-
void MaintenanceManager::processSignedFirmwareUpdate(std::string location,
815+
void MaintenanceManager::processSignedUpdateFirmware(std::string location,
816816
ocpp::types::Optional<unsigned int> retries,
817817
ocpp::types::Optional<unsigned int> retry_interval,
818818
ocpp::types::DateTime retrieve_date,
@@ -857,7 +857,7 @@ void MaintenanceManager::processSignedFirmwareUpdate(std::string
857857
nb_retries--;
858858
if (nb_retries != 0)
859859
{
860-
LOG_WARNING << "SignedFirmwareUpdate : download failed (" << nb_retries << " retrie(s) left - next retry in "
860+
LOG_WARNING << "SignedUpdateFirmware : download failed (" << nb_retries << " retrie(s) left - next retry in "
861861
<< retry_interval_s.count() << "s)";
862862
std::this_thread::sleep_for(retry_interval_s);
863863
}
@@ -869,12 +869,12 @@ void MaintenanceManager::processSignedFirmwareUpdate(std::string
869869
if (success)
870870
{
871871
m_signed_firmware_status = FirmwareStatusEnumType::Downloaded;
872-
LOG_INFO << "SignedFirmwareUpdate download : success";
872+
LOG_INFO << "SignedUpdateFirmware download : success";
873873
}
874874
else
875875
{
876876
m_signed_firmware_status = FirmwareStatusEnumType::DownloadFailed;
877-
LOG_ERROR << "SignedFirmwareUpdate download : failed";
877+
LOG_ERROR << "SignedUpdateFirmware download : failed";
878878
}
879879
sendSignedFirmwareStatusNotification();
880880

@@ -888,12 +888,12 @@ void MaintenanceManager::processSignedFirmwareUpdate(std::string
888888
if (success)
889889
{
890890
m_signed_firmware_status = FirmwareStatusEnumType::SignatureVerified;
891-
LOG_INFO << "SignedFirmwareUpdate verify : success";
891+
LOG_INFO << "SignedUpdateFirmware verify : success";
892892
}
893893
else
894894
{
895895
m_signed_firmware_status = FirmwareStatusEnumType::InvalidSignature;
896-
LOG_ERROR << "SignedFirmwareUpdate verify : failed";
896+
LOG_ERROR << "SignedUpdateFirmware verify : failed";
897897
}
898898
sendSignedFirmwareStatusNotification();
899899

@@ -930,7 +930,7 @@ void MaintenanceManager::processSignedFirmwareUpdate(std::string
930930
/** @brief Send a signed firmware status notification */
931931
bool MaintenanceManager::sendSignedFirmwareStatusNotification()
932932
{
933-
LOG_INFO << "SignedFirmwareUpdate status : " << FirmwareStatusEnumTypeHelper.toString(m_signed_firmware_status);
933+
LOG_INFO << "SignedUpdateFirmware status : " << FirmwareStatusEnumTypeHelper.toString(m_signed_firmware_status);
934934

935935
SignedFirmwareStatusNotificationReq status_req;
936936
SignedFirmwareStatusNotificationConf status_conf;

src/chargepoint/maintenance/MaintenanceManager.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
2525
#include "GetLog.h"
2626
#include "ITriggerMessageManager.h"
2727
#include "Reset.h"
28-
#include "SignedFirmwareUpdate.h"
28+
#include "SignedUpdateFirmware.h"
2929
#include "UnlockConnector.h"
3030
#include "UpdateFirmware.h"
3131

@@ -72,7 +72,7 @@ class MaintenanceManager
7272
public ocpp::messages::GenericMessageHandler<ocpp::messages::UpdateFirmwareReq, ocpp::messages::UpdateFirmwareConf>,
7373
// Security extensions
7474
public ocpp::messages::GenericMessageHandler<ocpp::messages::GetLogReq, ocpp::messages::GetLogConf>,
75-
public ocpp::messages::GenericMessageHandler<ocpp::messages::SignedFirmwareUpdateReq, ocpp::messages::SignedFirmwareUpdateConf>
75+
public ocpp::messages::GenericMessageHandler<ocpp::messages::SignedUpdateFirmwareReq, ocpp::messages::SignedUpdateFirmwareConf>
7676
{
7777
public:
7878
/** @brief Constructor */
@@ -103,7 +103,7 @@ class MaintenanceManager
103103
* @param status Installation status (see FirmwareStatusEnumType documentation)
104104
* @return true if the notification has been sent, false otherwise
105105
*/
106-
bool notifySignedFirmwareUpdateStatus(ocpp::types::FirmwareStatusEnumType status);
106+
bool notifySignedUpdateFirmwareStatus(ocpp::types::FirmwareStatusEnumType status);
107107

108108
// ITriggerMessageManager::ITriggerMessageHandler interface
109109

@@ -172,8 +172,8 @@ class MaintenanceManager
172172
* const char*& error_code,
173173
* std::string& error_message)
174174
*/
175-
bool handleMessage(const ocpp::messages::SignedFirmwareUpdateReq& request,
176-
ocpp::messages::SignedFirmwareUpdateConf& response,
175+
bool handleMessage(const ocpp::messages::SignedUpdateFirmwareReq& request,
176+
ocpp::messages::SignedUpdateFirmwareConf& response,
177177
const char*& error_code,
178178
std::string& error_message) override;
179179

@@ -242,7 +242,7 @@ class MaintenanceManager
242242
void sendLogStatusNotification();
243243

244244
/** @brief Process the signed firmware update */
245-
void processSignedFirmwareUpdate(std::string location,
245+
void processSignedUpdateFirmware(std::string location,
246246
ocpp::types::Optional<unsigned int> retries,
247247
ocpp::types::Optional<unsigned int> retry_interval,
248248
ocpp::types::DateTime retrieve_date,

src/messages/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ add_library(messages STATIC
4040
SetChargingProfile.cpp
4141
SignCertificate.cpp
4242
SignedFirmwareStatusNotification.cpp
43-
SignedFirmwareUpdate.cpp
43+
SignedUpdateFirmware.cpp
4444
StartTransaction.cpp
4545
StatusNotification.cpp
4646
StopTransaction.cpp

src/messages/MessagesConverter.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
5050
#include "SetChargingProfile.h"
5151
#include "SignCertificate.h"
5252
#include "SignedFirmwareStatusNotification.h"
53-
#include "SignedFirmwareUpdate.h"
53+
#include "SignedUpdateFirmware.h"
5454
#include "StartTransaction.h"
5555
#include "StatusNotification.h"
5656
#include "StopTransaction.h"
@@ -108,7 +108,7 @@ MessagesConverter::MessagesConverter()
108108
REGISTER_CONVERTER(SetChargingProfile);
109109
REGISTER_CONVERTER(SignCertificate);
110110
REGISTER_CONVERTER(SignedFirmwareStatusNotification);
111-
REGISTER_CONVERTER(SignedFirmwareUpdate);
111+
REGISTER_CONVERTER(SignedUpdateFirmware);
112112
REGISTER_CONVERTER(StartTransaction);
113113
REGISTER_CONVERTER(StatusNotification);
114114
REGISTER_CONVERTER(StopTransaction);
@@ -152,7 +152,7 @@ MessagesConverter::~MessagesConverter()
152152
DELETE_CONVERTER(SetChargingProfile);
153153
DELETE_CONVERTER(SignCertificate);
154154
DELETE_CONVERTER(SignedFirmwareStatusNotification);
155-
DELETE_CONVERTER(SignedFirmwareUpdate);
155+
DELETE_CONVERTER(SignedUpdateFirmware);
156156
DELETE_CONVERTER(StartTransaction);
157157
DELETE_CONVERTER(StatusNotification);
158158
DELETE_CONVERTER(StopTransaction);

src/messages/SignedFirmwareUpdate.cpp renamed to src/messages/SignedUpdateFirmware.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You should have received a copy of the GNU Lesser General Public License
1616
along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
1717
*/
1818

19-
#include "SignedFirmwareUpdate.h"
19+
#include "SignedUpdateFirmware.h"
2020
#include "IRpc.h"
2121
#include "Url.h"
2222

@@ -40,8 +40,8 @@ namespace messages
4040
{
4141

4242
/** @copydoc bool IMessageConverter<DataType>::fromJson(const rapidjson::Value&, DataType&, const char*&, std::string&) */
43-
bool SignedFirmwareUpdateReqConverter::fromJson(const rapidjson::Value& json,
44-
SignedFirmwareUpdateReq& data,
43+
bool SignedUpdateFirmwareReqConverter::fromJson(const rapidjson::Value& json,
44+
SignedUpdateFirmwareReq& data,
4545
const char*& error_code,
4646
std::string& error_message)
4747
{
@@ -66,7 +66,7 @@ bool SignedFirmwareUpdateReqConverter::fromJson(const rapidjson::Value& json,
6666
}
6767

6868
/** @copydoc bool IMessageConverter<DataType>::toJson(DataType&, rapidjson::Document&, const char*&, std::string&) */
69-
bool SignedFirmwareUpdateReqConverter::toJson(const SignedFirmwareUpdateReq& data, rapidjson::Document& json)
69+
bool SignedUpdateFirmwareReqConverter::toJson(const SignedUpdateFirmwareReq& data, rapidjson::Document& json)
7070
{
7171
fill(json, "requestId", data.requestId);
7272
fill(json, "retries", data.retries);
@@ -84,8 +84,8 @@ bool SignedFirmwareUpdateReqConverter::toJson(const SignedFirmwareUpdateReq& dat
8484
}
8585

8686
/** @copydoc bool IMessageConverter<DataType>::fromJson(const rapidjson::Value&, DataType&, const char*&, std::string&) */
87-
bool SignedFirmwareUpdateConfConverter::fromJson(const rapidjson::Value& json,
88-
SignedFirmwareUpdateConf& data,
87+
bool SignedUpdateFirmwareConfConverter::fromJson(const rapidjson::Value& json,
88+
SignedUpdateFirmwareConf& data,
8989
const char*& error_code,
9090
std::string& error_message)
9191
{
@@ -96,7 +96,7 @@ bool SignedFirmwareUpdateConfConverter::fromJson(const rapidjson::Value& json,
9696
}
9797

9898
/** @copydoc bool IMessageConverter<DataType>::toJson(DataType&, rapidjson::Document&, const char*&, std::string&) */
99-
bool SignedFirmwareUpdateConfConverter::toJson(const SignedFirmwareUpdateConf& data, rapidjson::Document& json)
99+
bool SignedUpdateFirmwareConfConverter::toJson(const SignedUpdateFirmwareConf& data, rapidjson::Document& json)
100100
{
101101
fill(json, "status", UpdateFirmwareStatusEnumTypeHelper.toString(data.status));
102102
return true;

src/messages/SignedFirmwareUpdate.h renamed to src/messages/SignedUpdateFirmware.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ You should have received a copy of the GNU Lesser General Public License
1616
along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
1717
*/
1818

19-
#ifndef SIGNEDFIRMWAREUPDATE_H
20-
#define SIGNEDFIRMWAREUPDATE_H
19+
#ifndef SIGNEDUPDATEFIRMWARE_H
20+
#define SIGNEDUPDATEFIRMWARE_H
2121

2222
#include "Enums.h"
2323
#include "FirmwareType.h"
@@ -29,11 +29,11 @@ namespace ocpp
2929
namespace messages
3030
{
3131

32-
/** @brief Action corresponding to the SignedFirmwareUpdate messages */
33-
static const std::string SIGNED_FIRMWARE_UPDATE_ACTION = "SignedFirmwareUpdate";
32+
/** @brief Action corresponding to the SignedUpdateFirmware messages */
33+
static const std::string SIGNED_UPDATE_FIRMWARE_ACTION = "SignedUpdateFirmware";
3434

35-
/** @brief SignedFirmwareUpdate.req message */
36-
struct SignedFirmwareUpdateReq
35+
/** @brief SignedUpdateFirmware.req message */
36+
struct SignedUpdateFirmwareReq
3737
{
3838
/** @brief Optional. This specifies how many times Charge Point must try to download the
3939
firmware before giving up. If this field is not present, it is left to Charge Point to
@@ -50,17 +50,17 @@ struct SignedFirmwareUpdateReq
5050
ocpp::types::FirmwareType firmware;
5151
};
5252

53-
/** @brief SignedFirmwareUpdate.conf message */
54-
struct SignedFirmwareUpdateConf
53+
/** @brief SignedUpdateFirmware.conf message */
54+
struct SignedUpdateFirmwareConf
5555
{
5656
/** @brief Required. This field indicates whether the Charge Point was able to accept the request */
5757
ocpp::types::UpdateFirmwareStatusEnumType status;
5858
};
5959

6060
// Message converters
61-
MESSAGE_CONVERTERS(SignedFirmwareUpdate)
61+
MESSAGE_CONVERTERS(SignedUpdateFirmware)
6262

6363
} // namespace messages
6464
} // namespace ocpp
6565

66-
#endif // SIGNEDFIRMWAREUPDATE_H
66+
#endif // SIGNEDUPDATEFIRMWARE_H

0 commit comments

Comments
 (0)