can_NAME.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef CAN_NAME_HPP
#define CAN_NAME_HPP
 
#include <cstdint>
#include <tuple>
 
namespace isobus
{
    //================================================================================================
    //================================================================================================
    class NAME
    {
    public:
        enum class NAMEParameters
        {
            IdentityNumber, 
            ManufacturerCode, 
            EcuInstance, 
            FunctionInstance, 
            FunctionCode, 
            DeviceClass, 
            DeviceClassInstance, 
            IndustryGroup, 
            ArbitraryAddressCapable 
        };
 
        enum class IndustryGroup : std::uint8_t
        {
            Global = 0, 
            OnHighwayEquipment = 1,
            AgriculturalAndForestryEquipment = 2,
            ConstructionEquipment = 3,
            Marine = 4,
            IndustrialOrProcessControl = 5,
            Reserved1 = 6, 
            Reserved2 = 7 
        };
 
        enum class Function : std::uint8_t
        {
            // Common Functions
            Engine = 0, 
            AuxiliaryPowerUnit = 1, 
            ElectricPropulsionControl = 2, 
            Transmission = 3, 
            BatteryPackMonitor = 4, 
            ShiftControl = 5, 
            PowerTakeOffRearOrPrimary = 6, 
            SteeringAxle = 7, 
            DrivingAxle = 8, 
            SystemControlBrakes = 9, 
            SteerAxleControlBrakes = 10, 
            DriveAxleControlBrakes = 11, 
            EngineRetarder = 12, 
            DrivelineRetarder = 13, 
            CruiseControl = 14, 
            FuelSystem = 15, 
            SteeringControl = 16, 
            SteerAxleSuspensionControl = 17, 
            DriveAxleSuspensionControl = 18, 
            InstrumentCluster = 19, 
            TripRecorder = 20, 
            CabClimateControl = 21, 
            AerodynamicControl = 22, 
            VehicleNavigation = 23, 
            VehicleSecurity = 24, 
            NetworkInterconnectUnit = 25, 
            BodyControl = 26, 
            PowerTakeOffFrontOrSecondary = 27, 
            OffVehicleGateway = 28, 
            VirtualTerminal = 29, 
            ManagementComputerOne = 30, 
            PropulsionBatteryCharger = 31, 
            HeadwayControl = 32, 
            SystemMonitor = 33, 
            HydraulicPumpControl = 34, 
            SystemControlSuspension = 35, 
            SystemControlPneumatic = 36, 
            CabController = 37, 
            TirePressureControl = 38, 
            IgnitionControl = 39, 
            SeatControl = 40, 
            OperatorControlsLighting = 41, 
            WaterPumpControl = 42, 
            TransmissionDisplay = 43, 
            ExhaustEmissionControl = 44, 
            VehicleDynamicStabilityControl = 45, 
            OilSystemMonitor = 46, 
            InformationSystemControl = 47, 
            RampControl = 48, 
            ClutchConverterControl = 49, 
            AuxiliaryHeater = 50, 
            ForwardLookingCollisionWarningSystem = 51, 
            ChassisControl = 52, 
            AlternatorElectricalChargingSystem = 53, 
            CommunicationsCellular = 54, 
            CommunicationsSatellite = 55, 
            CommunicationsRadio = 56, 
            OperatorControlsSteeringColumn = 57, 
            FanDriveControl = 58, 
            Starter = 59, 
            CabDisplayCab = 60, 
            FileServerOrPrinter = 61, 
            OnboardDiagnosticUnit = 62, 
            EngineValveController = 63, 
            EnduranceBraking = 64, 
            GasFlowMeasurement = 65, 
            IOController = 66, 
            ElectricalSystemController = 67, 
            AftertreatmentSystemGasMeasurement = 68, 
            EngineEmissionAftertreatmentSystem = 69, 
            AuxiliaryRegenerationDevice = 70, 
            TransferCaseControl = 71, 
            CoolantValveController = 72, 
            RolloverDetectionControl = 73, 
            LubricationSystem = 74, 
            SupplementalFan = 75, 
            TemperatureSensor = 76, 
            FuelPropertiesSensor = 77, 
            FireSuppressionSystem = 78, 
            PowerSystemsManager = 79, 
            ElectricPowertrain = 80, 
            HydraulicPowertrain = 81, 
            FileServer = 82, 
            Printer = 83, 
            StartAidDevice = 84, 
            EngineInjectionControlModule = 85, 
            EVCommunicationController = 86, 
            DriverImpairmentDevice = 87, 
            ElectricPowerConverter = 88, 
            SupplyEquipmentCommunicationController = 89, 
            VehicleAdapterCommunicationController = 90, 
            RateControl = 128, 
            SectionOnOffControl = 129, 
            PositionControl = 131, 
            MachineControl = 132, 
            ProductFlow = 133, 
            ProductLevel = 134, 
            DepthOrHeightControl = 135, 
            FrameControl = 136, 
 
            // Non-specific system (Device class 0) industry group and vehicle system
            OffBoardDiagnosticServiceTool = 129, 
            OnBoardDiagnosticDataLogger = 130, 
            PCKeyboard = 131, 
            SafetyRestraintSystem = 132, 
            Turbocharger = 133, 
            GroundBasedSpeedSensor = 134, 
            Keypad = 135, 
            HumiditySensor = 136, 
            ThermalManagementSystemController = 137, 
            BrakeStrokeAlert = 138, 
            OnBoardAxleGroupScale = 139, 
            OnBoardAxleGroupDisplay = 140, 
            BatteryCharger = 141, 
            TurbochargerCompressorBypass = 142, 
            TurbochargerWastegate = 143, 
            Throttle = 144, 
            InertialSensor = 145, 
            FuelActuator = 146, 
            EngineExhaustGasRecirculation = 147, 
            EngineExhaustBackpressure = 148, 
            OnBoardBinWeightingScale = 149, 
            OnBoardBinWeighingScaleDisplay = 150, 
            EngineCylinderPressureMonitoringSystem = 151, 
            ObjectDetection = 152, 
            ObjectDetectionDisplay = 153, 
            ObjectDetectionSensor = 154, 
            PersonnelDetectionDevice = 155, 
 
            // ******** On-Highway (Industry Group 1) ********
            // Non-specific system (Device class 0) industry group 1
            Tachograph = 128, 
            DoorController = 129, 
            ArticulationTurntableControl = 130, 
            BodyToVehicleInterfaceControl = 131, 
            SlopeSensor = 132, 
            RetarderDisplay = 134, 
            DifferentialLockController = 135, 
            LowVoltageDisconnect = 136, 
            RoadwayInformation = 137, 
            AutomatedDriving = 138, 
 
            // Non-specific system (Device class 0) Tractor industry group 1
            ForwardRoadImageProcessing = 128, 
            FifthWheelSmartSystem = 129, 
            CatalystFluidSensor = 130, 
            AdaptiveFrontLightingSystem = 131, 
            IdleControlSystem = 132, 
            UserInterfaceSystem = 133, 
 
            // ******** Agriculture (Industry Group 2) ********
            // Non-specific system (Device class 0) industry group 2
            NonVirtualTerminalDisplay = 128, 
            OperatorControlsMachineSpecific = 129, 
            TaskController = 130, 
            ForeignObjectDetection = 133, 
            TractorECU = 134, 
            SequenceControlMaster = 135, 
            ProductDosing = 136, 
            ProductTreatment = 137, 
            DataLogger = 139, 
            DecisionSupport = 140, 
            LightingController = 141, 
            TIMServer = 142, 
 
            // Tractor (Device class 1) Industry Group 2
            AuxiliaryValveControl = 129, 
            RearHitchControl = 130, 
            FrontHitchControl = 131, 
            CenterHitchControl = 134, 
 
            // Planters/Seeders (Device Class 4) Industry Group 2
            DownPressure = 137, 
 
            // Fertilizers (Device Class 5) Industry Group 2
            ProductPressure = 130, 
 
            // Harvesters (Device Class 7) Industry Group 2
            TailingMonitor = 128, 
            HeaderControl = 129, 
            ProductLossMonitor = 130, 
            HarvesterProductMoisture = 131, 
 
            // Forage (Device Class 9) Industry Group 2
            TwineWrapperControl = 128, 
            ProductPackagingControl = 129, 
            ForageProductMoisture = 131, 
 
            // Transport/Trailer (Device Class 11) Industry Group 2
            UnloadControl = 136, 
 
            // Sensor Systems (Device Class 17) Industry Group 2
            GuidanceFeeler = 128, 
            CameraSystem = 129, 
            CropScouting = 130, 
            MaterialPropertiesSensing = 131, 
            InertialMeasurementUnit = 132, 
            ProductMass = 135, 
            VibrationKnock = 136, 
            WeatherInstruments = 137, 
            SoilScouting = 138, 
 
            // ******** Construction (Industry Group 3) ********
            // Non-specific system (Device class 0) Industry Group 3
            ConstructionSupplementalEngineControlSensing = 128, 
            LaserReceiver = 129, 
            LandLevelingSystemOperatorInterface = 130, 
            LandLevelingElectricMast = 131, 
            SingleLandLevelingSystemSupervisor = 132, 
            LandLevelingSystemDisplay = 133, 
            LaserTracer = 134, 
            LoaderControl = 135, 
            ConstructionEquipmentSlopeSensor = 136, 
            LiftArmControl = 137, 
            SupplementalSensorProcessingUnits = 138, 
            HydraulicSystemPlanner = 139, 
            HydraulicValveController = 140, 
            JoystickControl = 141, 
            RotationSensor = 142, 
            SonicSensor = 143, 
            SurveyTotalStationTarget = 144, 
            HeadingSensor = 145, 
            AlarmDevice = 146, 
 
            // Skid Steer Loader (Device Class 1) Industry Group 3
            SkidSteerMainController = 128, 
 
            // Crawler (Device Class 4) Industry Group 3
            BladeController = 128, 
 
            // Grader (Device Class 8) Industry Group 3
            HFWDController = 128, 
 
            // ******** Marine (Industry Group 4) ********
            Alarm1SystemControlForMarineEngines = 128, 
            ProtectionSystemForMarineEngines = 129, 
            DisplayForProtectionSystemForMarineEngines = 130, 
 
            // Power Management And Lighting System (Device Class 30)
            Switch = 130, 
            Load = 140, 
 
            // Steering systems (Device class 40)
            FollowUpController = 130, 
            ModeController = 140, 
            AutomaticSteeringController = 150, 
            HeadingSensors = 160, 
 
            // Propulsion Systems
            EngineRoomMonitoring = 130, 
            EngineInterface = 140, 
            EngineController = 150, 
            EngineGateway = 160, 
            ControlHead = 170, 
            Actuator = 180, 
            GaugeInterface = 190, 
            GaugeLarge = 200, 
            GaugeSmall = 210, 
            PropulsionSensorsAndGateway = 220, 
 
            // Navigation Systems
            SounderDepth = 130, 
            GlobalNavigationSatelliteSystem = 145, 
            LoranC = 150, 
            SpeedSensors = 155, 
            TurnRateIndicator = 160, 
            IntegratedNavigation = 170, 
            RadarOrRadarPlotting = 200, 
            ElectronicChartDisplayAndInformationSystem = 205, 
            ElectronicChartSystem = 210, 
            DirectionFinder = 220, 
 
            // Communications Systems
            EmergencyPositionIndicatingBeacon = 130, 
            AutomaticIdentificationSystem = 140, 
            DigitalSelectiveCalling = 150, 
            DataReceiver = 160, 
            Satellite = 170, 
            RadioTelephoneMF_HF = 180, 
            RadioTelephoneVHF = 190, 
            TimeDateSystems = 130, 
            VoyageDataRecorder = 140, 
            IntegratedInstrumentation = 150, 
            GeneralPurposeDisplays = 160, 
            GeneralSensorBox = 170, 
            MarineWeatherInstruments = 180, 
            TransducerGeneral = 190, 
            NMEA0183Converter = 200, 
 
            // ******** Industrial / Process Control (Industry Group 5) ********
            GeneratorSupplementalEngineControlSensing = 128, 
            GeneratorSetController = 129, 
            GeneratorVoltageRegulator = 130, 
            ChokeActuator = 131, 
            WellStimulationPump = 132, 
 
            MaxFunctionCode = 255 
        };
 
        enum class DeviceClass
        {
            NonSpecific = 0,
            Tractor = 1, 
            SkidSteerLoader = 1, 
            Trailer = 2, 
            ArticulatedDumpTruck = 2, 
            SecondaryTillage = 3, 
            Backhoe = 3, 
            PlanterSeeder = 4, 
            Crawler = 4, 
            Fertilizer = 5, 
            Excavator = 5, 
            Sprayer = 6, 
            Forklift = 6, 
            Harvester = 7, 
            FourWheelDriveLoader = 7, 
            RootHarvester = 8, 
            Grader = 8, 
            Forage = 9, 
            MillingMachine = 9, 
            Irrigation = 10, 
            RecyclerAndSoilStabilizer = 10, 
            SystemTools = 10, 
            TransportTrailer = 11, 
            BindingAgentSpreader = 11, 
            FarmYardOperations = 12, 
            Paver = 12, 
            PoweredAuxiliaryDevices = 13, 
            Feeder = 13, 
            SpecialCrops = 14, 
            ScreeningPlant = 14, 
            Earthwork = 15, 
            Stacker = 15, 
            Skidder = 16, 
            Roller = 16, 
            SensorSystems = 17, 
            Crusher = 17, 
            TimberHarvester = 19, 
            Forwarder = 20, 
            SafetySystems = 20, 
            TimberLoader = 21, 
            TimberProcessor = 22, 
            Mulcher = 23, 
            UtilityVehicle = 24, 
            SlurryManureApplicator = 25, 
            Gateway = 25, 
            FeederMixer = 26, 
            WeederNonChemical = 27, 
            TurfOrLawnCareMower = 28, 
            ProductMaterialHandling = 29, 
            PowerManagementAndLightingSystem = 30, 
            SteeringSystems = 40, 
            PropulsionSystems = 50, 
            NavigationSystems = 60, 
            CommunicationsSystems = 70, 
            InstrumentationOrGeneral = 80, 
            EnvironmentalHVACSystem = 90, 
            DeckCargoOrFishingEquipment = 100, 
            NotAvailable = 127 //< Applicable to all IGs
        };
 
        bool operator==(const NAME &obj) const;
 
        using NameParameterFilter = std::pair<const NAMEParameters, const std::uint32_t>;
 
        explicit NAME(std::uint64_t rawNAMEData = 0);
 
        bool get_arbitrary_address_capable() const;
 
        void set_arbitrary_address_capable(bool value);
 
        std::uint8_t get_industry_group() const;
 
        void set_industry_group(std::uint8_t value);
 
        std::uint8_t get_device_class_instance() const;
 
        void set_device_class_instance(std::uint8_t value);
 
        std::uint8_t get_device_class() const;
 
        void set_device_class(std::uint8_t value);
 
        std::uint8_t get_function_code() const;
 
        void set_function_code(std::uint8_t value);
 
        std::uint8_t get_function_instance() const;
 
        void set_function_instance(std::uint8_t value);
 
        std::uint8_t get_ecu_instance() const;
 
        void set_ecu_instance(std::uint8_t value);
 
        std::uint16_t get_manufacturer_code() const;
 
        void set_manufacturer_code(std::uint16_t value);
 
        std::uint32_t get_identity_number() const;
 
        void set_identity_number(std::uint32_t value);
 
        std::uint64_t get_full_name() const;
 
        void set_full_name(std::uint64_t value);
 
    private:
        std::uint64_t rawName; 
    };
} // namespace isobus
 
#endif // CAN_NAME_HPP