Package jmri.jmrix.can.cbus.node

Class CbusNodeConstants

  • public class CbusNodeConstants
extends java.lang.Object
    Static Methods relating to nodes ( modules ).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BETA_REV_IDX  
      static int BUS_TYPE_IDX  
      static int CPU_CODE_IDX  
      static int CPU_ID_IDX  
      static int EV_PER_EN_IDX  
      static int FLAGS_IDX  
      static int LOAD_ADDR_IDX  
      static int MAJOR_VER_IDX  
      static int MANU_ID_IDX  
      static int MINOR_VER_IDX  
      static int MODULE_ID_IDX  
      static int NAME_STRING_BASE_IDX  
      static int NUM_EV_IDX  
      static int NUM_NV_IDX  
      static int NUM_PARAM_IDX
      Node Parameters Para 0 Number of parameters Para 1 The manufacturer ID Para 2 Minor code version as an alphabetic character (ASCII) Para 3 Manufacturer module identifier as a HEX numeric Para 4 Number of supported events as a HEX numeric Para 5 Number of Event Variables per event as a HEX numeric Para 6 Number of supported Node Variables as a HEX numeric Para 7 Major version Para 8 Node flags Para 9 Processor type Para 10 Bus type Para 11 load address, 4 bytes Para 15 CPU manufacturer's id as read from the chip config space, 4 bytes Para 19 CPU manufacturer code Para 20 Beta revision (numeric), or 0 if release Para 21 - 24 Zero filled spare Not readable by index: Para 25 - 26 Number of paranmeters can be read as parameter 0 Para 27 - 30 Name string base address Para 31 - 32 Checksum.
      static int PARAM_CHECK_IDX  
      static int PARAM_COUNT_IDX  
      static int PROC_TYPE_IDX  
      static int SPARE_IDX  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String displayPhrase​(CbusNodeConstants.BackupType type)  
      static java.lang.String getBusType​(int type)
      Return a string representation of a decoded Bus Type
      static java.lang.String getManu​(int man)
      Return a string representation of a decoded Module Manufacturer
      static java.lang.String getModuleSupportLink​(int man, int type)
      Return a string representation of Module Support Link
      static java.lang.String getModuleType​(int man, int type)
      Return a string representation of a decoded Module Name for manufacturer MERG.
      static java.lang.String getModuleTypeExtra​(int man, int type)
      Return a string representation of extra module info
      static java.lang.String getReservedModule​(int modnum)
      Return a string representation of a reserved node number
      static CbusNodeConstants.BackupType lookupByName​(java.lang.String name)  
      static void setTraits​(CbusNode node)
      Set traits for a node where there is a minor deviance to MERG CBUS protocol or provide extra info. which is missing for a known module firmware.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • setTraits

        public static void setTraits​(@Nonnull
                             CbusNode node)
        Set traits for a node where there is a minor deviance to MERG CBUS protocol or provide extra info. which is missing for a known module firmware.
        Parameters:
        node - The CbusNode object we are setting the traits for

      • getManu

        public static java.lang.String getManu​(int man)
        Return a string representation of a decoded Module Manufacturer
        Parameters:
        man - manufacturer int
        Returns:
        decoded CBUS message

      • getBusType

        public static java.lang.String getBusType​(int type)
        Return a string representation of a decoded Bus Type
        Parameters:
        type - Bus type
        Returns:
        decoded CBUS message

      • getModuleType

        public static java.lang.String getModuleType​(int man,
                                             int type)
        Return a string representation of a decoded Module Name for manufacturer MERG.
        Parameters:
        man - int manufacturer
        type - module type int
        Returns:
        decoded String module type name else empty string

      • getModuleTypeExtra

        public static java.lang.String getModuleTypeExtra​(int man,
                                                  int type)
        Return a string representation of extra module info
        Parameters:
        man - int manufacturer code
        type - int module type
        Returns:
        string value of extra module info

      • getModuleSupportLink

        public static java.lang.String getModuleSupportLink​(int man,
                                                    int type)
        Return a string representation of Module Support Link
        Parameters:
        man - int manufacturer ID
        type - int module type ID
        Returns:
        string module support link, else empty string

      • getReservedModule

        public static java.lang.String getReservedModule​(int modnum)
        Return a string representation of a reserved node number
        Parameters:
        modnum - node number
        Returns:
        reserved node number reason