Can

java.lang.Object
- com.iotize.jvm.hal.Can

public class Can
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Can.CanMsg
Inner class to manage the CAN messages.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Can.CanMsg` Inner class to manage the CAN messages.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABOVE_ERR_WARN`
`static int`	`ALL`
`static int`	`ARB_LOST`
`static int`	`BELOW_ERR_WARN`
`static int`	`BUS_ERROR`
`static int`	`BUS_OFF`
`static int`	`BUS_RECOVERED`
`static int`	`ERR_ACTIVE`
`static int`	`ERR_PASS`
`static int`	`HAS_CS`
`static int`	`MAX_FRAME_SIZE`
`static int`	`MAX_TIMEOUT`
`static int`	`MODE_LISTEN_ONLY`
`static int`	`MODE_NO_ACK`
`static int`	`MODE_NORMAL`
`static int`	`NO_CS`
`static int`	`NONE`
`static int`	`RECOVERY_IN_PROGRESS`
`static int`	`RX_NON_EMPTY`
`static int`	`RX_QUEUE_FULL`
`static int`	`SID_ACTIVE_EVENTS`
`static int`	`SID_ARB_LOST_COUNT`
`static int`	`SID_BUS_ERROR_COUNT`
`static int`	`SID_MSGS_TO_RX`
`static int`	`SID_MSGS_TO_TX`
`static int`	`SID_RX_ERROR_COUNTER`
`static int`	`SID_RX_MISSED_COUNT`
`static int`	`SID_STATE`
`static int`	`SID_TX_ERROR_COUNTER`
`static int`	`SID_TX_FAILED_COUNT`
`static int`	`STATE_BUS_OFF`
`static int`	`STATE_RECOVERING`
`static int`	`STATE_RUNNING`
`static int`	`STATE_STOPPED`
`static int`	`TX_FAILED`
`static int`	`TX_IDLE`
`static int`	`TX_SUCCESS`

Constructor Summary

Constructors
Constructor and Description

Can(int canFrequency_kbps, int canMode)
Creates a CAN interface at the specified frequency.

Constructors
Constructor and Description
`Can(int canFrequency_kbps, int canMode)` Creates a CAN interface at the specified frequency.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`enableEvent(int newenabled)` enableEvent( int newenabled ) Adapt the filter characteristics to send event (through onEvent() method)
`int`	`flushReceive()` flushReceive( ) flush the queue of received messages
`int`	`flushTransmit()` flushTransmit( ) flush the queue of messages to be transmitted.
`Can.CanMsg`	`getMessage(int timeout)` Read the first message from the CAN FIFO.
`int`	`getState(int sta_id)` getStateVal( int state_id ) Read the current state of the controller and update the corresponding class fields.
`int`	`recover()` recover( ) Try to recover the bus connection when state == STATE_BUS_OFF
`int`	`sendMessage(Can.CanMsg msg, int timeout)` Send the given message to the CAN port
`int`	`setAcceptance(int code, int mask, byte single)` setAcceptance Defines the filter for incoming messages (see mask above)
`int`	`setMode(int canMode)` setMode( int mode ) Enable the controller for both transmissin and reception
`int`	`start()` start() Enable the controller for both transmissin and reception
`int`	`stop()` stop() Enable the controller for both transmissin and reception

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_FRAME_SIZE
```
public static final int MAX_FRAME_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_TIMEOUT
```
public static final int MAX_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - MODE_NORMAL
```
public static final int MODE_NORMAL
```
    See Also:
    
    Constant Field Values
  - MODE_NO_ACK
```
public static final int MODE_NO_ACK
```
    See Also:
    
    Constant Field Values
  - MODE_LISTEN_ONLY
```
public static final int MODE_LISTEN_ONLY
```
    See Also:
    
    Constant Field Values
  - STATE_STOPPED
```
public static final int STATE_STOPPED
```
    See Also:
    
    Constant Field Values
  - STATE_RUNNING
```
public static final int STATE_RUNNING
```
    See Also:
    
    Constant Field Values
  - STATE_BUS_OFF
```
public static final int STATE_BUS_OFF
```
    See Also:
    
    Constant Field Values
  - STATE_RECOVERING
```
public static final int STATE_RECOVERING
```
    See Also:
    
    Constant Field Values
  - SID_STATE
```
public static final int SID_STATE
```
    See Also:
    
    Constant Field Values
  - SID_MSGS_TO_RX
```
public static final int SID_MSGS_TO_RX
```
    See Also:
    
    Constant Field Values
  - SID_MSGS_TO_TX
```
public static final int SID_MSGS_TO_TX
```
    See Also:
    
    Constant Field Values
  - SID_TX_ERROR_COUNTER
```
public static final int SID_TX_ERROR_COUNTER
```
    See Also:
    
    Constant Field Values
  - SID_RX_ERROR_COUNTER
```
public static final int SID_RX_ERROR_COUNTER
```
    See Also:
    
    Constant Field Values
  - SID_TX_FAILED_COUNT
```
public static final int SID_TX_FAILED_COUNT
```
    See Also:
    
    Constant Field Values
  - SID_RX_MISSED_COUNT
```
public static final int SID_RX_MISSED_COUNT
```
    See Also:
    
    Constant Field Values
  - SID_ARB_LOST_COUNT
```
public static final int SID_ARB_LOST_COUNT
```
    See Also:
    
    Constant Field Values
  - SID_BUS_ERROR_COUNT
```
public static final int SID_BUS_ERROR_COUNT
```
    See Also:
    
    Constant Field Values
  - SID_ACTIVE_EVENTS
```
public static final int SID_ACTIVE_EVENTS
```
    See Also:
    
    Constant Field Values
  - NO_CS
```
public static final int NO_CS
```
    See Also:
    
    Constant Field Values
  - HAS_CS
```
public static final int HAS_CS
```
    See Also:
    
    Constant Field Values
  - TX_IDLE
```
public static final int TX_IDLE
```
    See Also:
    
    Constant Field Values
  - TX_SUCCESS
```
public static final int TX_SUCCESS
```
    See Also:
    
    Constant Field Values
  - BELOW_ERR_WARN
```
public static final int BELOW_ERR_WARN
```
    See Also:
    
    Constant Field Values
  - ERR_ACTIVE
```
public static final int ERR_ACTIVE
```
    See Also:
    
    Constant Field Values
  - RECOVERY_IN_PROGRESS
```
public static final int RECOVERY_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - BUS_RECOVERED
```
public static final int BUS_RECOVERED
```
    See Also:
    
    Constant Field Values
  - ARB_LOST
```
public static final int ARB_LOST
```
    See Also:
    
    Constant Field Values
  - ABOVE_ERR_WARN
```
public static final int ABOVE_ERR_WARN
```
    See Also:
    
    Constant Field Values
  - BUS_ERROR
```
public static final int BUS_ERROR
```
    See Also:
    
    Constant Field Values
  - TX_FAILED
```
public static final int TX_FAILED
```
    See Also:
    
    Constant Field Values
  - RX_QUEUE_FULL
```
public static final int RX_QUEUE_FULL
```
    See Also:
    
    Constant Field Values
  - ERR_PASS
```
public static final int ERR_PASS
```
    See Also:
    
    Constant Field Values
  - BUS_OFF
```
public static final int BUS_OFF
```
    See Also:
    
    Constant Field Values
  - RX_NON_EMPTY
```
public static final int RX_NON_EMPTY
```
    See Also:
    
    Constant Field Values
  - ALL
```
public static final int ALL
```
    See Also:
    
    Constant Field Values
  - NONE
```
public static final int NONE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Can
```
public Can(int canFrequency_kbps,
           int canMode)
```
    Creates a CAN interface at the specified frequency. Must be called only once.
    
    Parameters:
    
    canFrequency - the frequency of the CAN (unit = kbit per second).
    
    canMode - should 0 (Normal), 1 (no acknowledge) or 2 (listen only)
- Method Detail
  - setAcceptance
```
public int setAcceptance(int code,
                         int mask,
                         byte single)
```
    setAcceptance Defines the filter for incoming messages (see mask above)
    
    Parameters:
    
    code - bit sequence which a message�s ID, RTR, and possibly data bytes (for 11 bit id) must match to be received.
    
    mask - bit sequence specifying which bits of the acceptance code can be ignored
    
    single: - 1: Single Filter Mode will use the acceptance code and mask to define a single filter 0: Dual Filter Mode will use code and mask to define two separate filters [only bits 13:28 are considered)
  - start
```
public int start()
```
    start() Enable the controller for both transmissin and reception
  - stop
```
public int stop()
```
    stop() Enable the controller for both transmissin and reception
  - setMode
```
public int setMode(int canMode)
```
    setMode( int mode ) Enable the controller for both transmissin and reception
    
    Parameters:
    
    canMode - should 0 (Normal), 1 (no acknowledge) or 2 (listen only)
  - getState
```
public int getState(int sta_id)
```
    getStateVal( int state_id ) Read the current state of the controller and update the corresponding class fields.
  - flushTransmit
```
public int flushTransmit()
```
    flushTransmit( ) flush the queue of messages to be transmitted.
  - flushReceive
```
public int flushReceive()
```
    flushReceive( ) flush the queue of received messages
  - recover
```
public int recover()
```
    recover( ) Try to recover the bus connection when state == STATE_BUS_OFF
  - enableEvent
```
public int enableEvent(int newenabled)
```
    enableEvent( int newenabled ) Adapt the filter characteristics to send event (through onEvent() method)
    
    Parameters:
    
    newenabled: - bitfield to define the accepted events for notification.
  - getMessage
```
public Can.CanMsg getMessage(int timeout)
```
    Read the first message from the CAN FIFO. If there is no pending message, wait for one until timeout.
    
    Parameters:
    
    timeout - in ms
    
    Returns:
    
    the first received message on completion, else return null;
  - sendMessage
```
public int sendMessage(Can.CanMsg msg,
                       int timeout)
```
    Send the given message to the CAN port
    
    Parameters:
    
    msg - the message buffer to transmit
    
    timeout - in ms
    
    Returns:
    
    0 on completion, else the error code

Class Can

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_FRAME_SIZE

MAX_TIMEOUT

MODE_NORMAL

MODE_NO_ACK

MODE_LISTEN_ONLY

STATE_STOPPED

STATE_RUNNING

STATE_BUS_OFF

STATE_RECOVERING

SID_STATE

SID_MSGS_TO_RX

SID_MSGS_TO_TX

SID_TX_ERROR_COUNTER

SID_RX_ERROR_COUNTER

SID_TX_FAILED_COUNT

SID_RX_MISSED_COUNT

SID_ARB_LOST_COUNT

SID_BUS_ERROR_COUNT

SID_ACTIVE_EVENTS

NO_CS

HAS_CS

TX_IDLE

TX_SUCCESS

BELOW_ERR_WARN

ERR_ACTIVE

RECOVERY_IN_PROGRESS

BUS_RECOVERED

ARB_LOST

ABOVE_ERR_WARN

BUS_ERROR

TX_FAILED

RX_QUEUE_FULL

ERR_PASS

BUS_OFF

RX_NON_EMPTY

ALL

NONE

Constructor Detail

Can

Method Detail

setAcceptance

start

stop

setMode

getState

flushTransmit

flushReceive

recover

enableEvent

getMessage

sendMessage