Package jmri.jmrix.can
Defines classes for interfacing to a CAN-based model railway
control bus.
It is expected that there will be multiple CAN implementations (e.g. MERG CBUS, ATBUS, etc) each accessible through a variety of CAN adapters (e.g. CAN232 or MERG CAN-RS), but that each implementation will be based uppon basic CANbus concepts such as header (standard or extended), Normal and RTR frames and a data field.
This package is therefore organized in several subtrees:
- adapters
- Specific implementations for CAN adapter hardware, e.g. MERG's CAN_RS; LAWICEL AB's CANUSB and CAN232; etc.
- protocols
- Specific implementations for e.g. CBUS, NmraNet, etc:
- cbus - MERG CBUS
- atbus - ATBUS
- nmranet - NMRA NMRAnet (not yet present)
- swing
- Swing-based GUI tools.
A note on terminology
CBUS refers to a 7-bit field in the standard CAN header as the "ID", "Node ID", and "CAN ID", but occasionally refers to the entire 11-bit CAN header by the same names.The JMRI classes use "cbusId" to refer to the 7-bit field.
- Since:
- 2.1.7
-
Interface Summary Interface Description CanFrame Base interface for immutable messages in a CANbus based message/reply protocol.CanInterface Define interface for sending and receiving CAN messagesCanListener Defines the interface for listening to CAN messages.CanMutableFrame Base interface for mutable messages in a CANbus based message/reply protocol. -
Class Summary Class Description AbstractCanTrafficController Abstract base for TrafficControllers in a CANbus based Message/Reply protocol.Bundle CanConfigurationManager Does configuration for CAN communications implementations.CanConnectionTypeList Return a list of valid lenz XpressNet Connection Types.CanConstants Constants to represent CAN protocols and adaptersCanMessage Base class for messages in a CANbus based message/reply protocol.CanReply Base class for replies in a CANbus based message/reply protocol.CanSystemConnectionMemo Lightweight class to denote that a system is active, and provide general information.ConfigurationManager Does configuration for various CAN-based communications implementations.TrafficController Traffic controller for CAN access. -
Enum Summary Enum Description ConfigurationManager.ProgModeSwitch Enumerate support for switching programming modes in connected hardwareConfigurationManager.SubProtocol