ParametersDownloadFactory.hpp

Go to the documentation of this file.

 
#ifndef IV_SRC_COMMS_PARAMETERSDOWNLOADFACTORY_HPP_
#define IV_SRC_COMMS_PARAMETERSDOWNLOADFACTORY_HPP_
 
#include "comms/can/CMessageCan.hpp"
#include "core/defines.hpp"
#include "streams/OutputStreamMemory.hpp"
 
#include <memory>
#include <vector>
 
namespace iv::comms
{
class ParametersDownloadFactory
{
public:
    static std::shared_ptr<CMessageCan> createSetPreoperationalUnitMessage(iv::types::unitId unitId);
 
    static std::shared_ptr<CMessageCan> createLssMasterCommand(uint8_t command);
    static std::shared_ptr<CMessageCan> createLssMasterCommandData(uint8_t command, uint8_t data);
    static std::shared_ptr<CMessageCan> createLssMasterSwitchParam(uint8_t command, uint32_t value);
    static std::shared_ptr<CMessageCan> createSetStoppedUnitMessage(iv::types::unitId unitId);
    static std::shared_ptr<CMessageCan> createDomainStartBody(iv::types::unitId unitId, uint8_t command, uint16_t index,
                                                              uint8_t subIndex, const std::vector<std::byte> &data,
                                                              bool expedite);
 
    static std::shared_ptr<CMessageCan> createDomainUploadStartBody(iv::types::unitId unitId, uint16_t index,
                                                                    uint8_t subIndex);
 
    static std::shared_ptr<CMessageCan>
    createSdoCanMessage(iv::types::unitId unitId, const std::shared_ptr<iv::streams::OutputStreamMemory> &memory);
 
    static std::shared_ptr<CMessageCan> createNmtStartUnitMessage(iv::types::unitId unitId);
 
    static std::shared_ptr<CMessageCan> createDomainSegmentBody(iv::types::unitId, uint8_t command,
                                                                const std::vector<std::byte> &data);
 
    struct ConstantMessageValues
    {
        static constexpr uint8_t commandPreOperationalNode = 0x80;
        static constexpr uint16_t invalidGlobalId = 0xFFFF;
    };
    struct ConstantMessageSources
    {
        static constexpr std::string toSend {"TO_SEND"};
    };
    struct MessageLengths
    {
        static constexpr uint8_t nmtMessageLength {2};
 
        static constexpr uint8_t formulaFilename {32};
        static constexpr uint8_t formulaVersion {8};
        static constexpr uint8_t formulaAuthor {3};
        static constexpr uint8_t formulaDescription {32};
    };
    struct sdoIndexes
    {
        static constexpr uint16_t automata {0x5001};
        static constexpr uint16_t restoreDefaultParameters {0x1011};
        static constexpr uint16_t storeDefaultParameters {0x1010};
        static constexpr uint16_t verifyConfig {0x1020};
        static constexpr uint16_t parameterVersion {0x2000};
        static constexpr uint16_t manufacturerDeviceName {0x1008};
        static constexpr uint16_t manufacturerSoftwareVersion {0x100A};
        static constexpr uint16_t objectLss {0x1018};
        static constexpr uint16_t manufacturerHardwareVersion {0x1009};
        static constexpr uint16_t formula {0x5000};
        static constexpr uint16_t logicFormula {0x5000};
        static constexpr uint16_t logicBlockConfiguration {0x5400};
        static constexpr uint16_t logicParameterConfigBase {0x5800};
        static constexpr uint16_t changeUnitId {0x100B};
    };
    struct nmtCommands
    {
        static constexpr uint8_t preoperational {0x80};
        static constexpr uint8_t start {0x81};
        static constexpr uint8_t stop {0x02};
    };
    struct sdoSubIndexes
    {
        static constexpr uint8_t automataMode {0x01};
        static constexpr uint8_t parametersFormula {0x04};
        static constexpr uint8_t channelParameters {0x05};
        static constexpr uint8_t channelFunc {0x03};
        static constexpr uint8_t channelTag {0x01};
        static constexpr uint8_t channelDescription {0x02};
        static constexpr uint8_t channelStatNr =
                0x21;// Area is written in this Index, old names are kept for compatibility's sake
        static constexpr uint8_t channelMimicId {0x23};//No longer used
        static constexpr uint8_t channelInverted {0x09};
        static constexpr uint8_t channelDelayOn {0x27};
        static constexpr uint8_t channelDelayOff {0x28};
        static constexpr uint8_t alarmEnabled {0x0A};
        static constexpr uint8_t digitalAlarmLimit {0x08};
        static constexpr uint8_t alarmDelayOn {0x05};
        static constexpr uint8_t alarmDelayOff {0x06};
        static constexpr uint8_t offScan {0x20};
        static constexpr uint8_t groupSubIndex {0x22};
        static constexpr uint8_t inhTag {0x24};
        static constexpr uint8_t verifyConfigDate {0x01};
        static constexpr uint8_t verifyConfigTime {0x02};
        static constexpr uint8_t parameterVersionDate {0x02};
        static constexpr uint8_t parameterVersionTime {0x03};
        static constexpr uint8_t parameterVersionVersion {0x01};
        static constexpr uint8_t analogType {0x04};
        static constexpr uint8_t measurementUnit {0xd};
        static constexpr uint8_t sensorLowLimit {0x0e};
        static constexpr uint8_t sensorHighLimit {0x0f};
        static constexpr uint8_t lel {0x10};
        static constexpr uint8_t hel {0x11};
        static constexpr uint8_t deadband {0x12};
        static constexpr uint8_t filterTime {0x13};
        static constexpr uint8_t numberOfDecimals {0x25};
        static constexpr uint8_t eepromParameters {0x1};
        static constexpr uint8_t noSubIndex {0x0};
        static constexpr uint8_t lssSerialNumber {0x04};
        static constexpr uint8_t formulaName {0x04};
        static constexpr uint8_t formulaVersion {0x05};
        static constexpr uint8_t formulaAuthor {0x06};
        static constexpr uint8_t formulaTodDays {0x07};
        static constexpr uint8_t formulaDescription {0x09};
        static constexpr uint8_t parameterLogicDefinition {0x00};
        static constexpr uint8_t parameterLogicTag1 {0x01};
        static constexpr uint8_t parameterLogicTag2 {0x02};
        static constexpr uint8_t parameterLogicValue {0x03};
 
        static constexpr uint8_t logicBlockConfig {0x00};
        static constexpr uint8_t logicBlockParameterConfig {0x01};
 
        static constexpr uint8_t formulaCrc16 {0x01};
        static constexpr uint8_t formulaNumBlocks {0x02};
        static constexpr uint8_t formulaSize {0x03};
        static constexpr uint8_t formulaFilename {0x04};
        static constexpr uint8_t formulaDays {0x07};
        static constexpr uint8_t formulaMSeconds {0x08};
        static constexpr uint8_t llal {0x14};
        static constexpr uint8_t lal {0x15};
        static constexpr uint8_t hal {0x16};
        static constexpr uint8_t hhal {0x17};
        static constexpr uint8_t inhibitSensorFailureHigh {0x1f};
        static constexpr uint8_t inhibitSensorFailureLow {0x1a};
 
        static constexpr uint8_t changeUnitId {0xFF};
    };
    struct sdoValues
    {
        static constexpr uint8_t automataModeOperational {0x01};
        static constexpr uint8_t automataModeProgram {0x03};
        static constexpr uint32_t restoringWriteAccessSignature {0x6C6F6164};
        static constexpr uint32_t storageWriteAccessSignature {0x73617665};
        static constexpr int64_t loadChannelParameters {0x6C6F6164};
    };
    struct sdoCommands
    {
        static constexpr uint8_t startDownloadDomain {1};
        static constexpr uint8_t downloadDomainSegment {0};
        static constexpr uint8_t startUploadDomain {2};
        static constexpr uint8_t uploadDomainSegment {3};
    };
    struct serverResponses
    {
        static constexpr uint8_t responseAcceptedStartDownloadDomain {3};
    };
    struct lssCommands
    {
        static constexpr uint8_t inquiryVendorId {0x5a};
        static constexpr uint8_t productId {0x5b};
        static constexpr uint8_t revisionNumber {0x5c};
        static constexpr uint8_t serialNumber {0x5d};
        static constexpr uint8_t switchModeVendor {0x40};
        static constexpr uint8_t switchModeProduct {0x41};
        static constexpr uint8_t switchModeRevision {0x42};
        static constexpr uint8_t switchModeSerialNumber {0x43};
        static constexpr uint8_t switchModeValidate {0x44};
        static constexpr uint8_t setNodeId {17};
        static constexpr uint8_t storeConfigLssData {23};
    };
 
private:
    static std::shared_ptr<CMessageCan> createNmtMessage(uint32_t unitIdInSubnetwork, uint32_t subnetworkId,
                                                         uint8_t command);
};
}// namespace iv::comms
#endif//IV_SRC_COMMS_PARAMETERSDOWNLOADFACTORY_HPP_