-
Enable
- Enable the bean - module exits initialization mode and starts to connect to the bus. Events may be generated ("DisableEvent"/"EnableEvent").
-
Disable
- Disable the bean - it stops the send and receive and enters initialization mode. No events will be generated.
-
EnableEvent
- Enable the events. This method is available if the interrupt service/event property is enabled and at least one event is enabled.
-
DisableEvent
- Disable the events. This method is available if the interrupt service/event property is enabled and at least one event is enabled.
-
SendFrame
- The method sends the data through specified transmit buffer and width specified identifier. The method is available only if Transmit buffers are enabled.
-
SendFrameExt
- The method retransmits the specified transmit buffer width content previously stored by SendFrame method. The method is available only if Transmit buffers are enabled.
-
ReadFrame
- The method reads Data from specified receive buffer. If receive FIFO is enabled, reading from buffer 0 reads the message from FIFO. The method is available only if Dedicated receive or receive FIFO buffers are enabled.
-
SetAcceptanceCode
- The method writes acceptance identifier to specified dedicated receive buffer. The Byteflight transfers received message to the receive buffer with matching identifier. The method can be called only if the bean is disabled (Disable method).
The method is available only if Dedicated receive buffers are enabled.
-
GetError
- The method returns a set of accumulated errors. After calling GetError the accumulated errors is cleared.
-
GetStatus
- The method returns a set of accumulated status flags. After calling GetStatus the accumulated status flags are cleared.
-
GetBufState
- The method returns interrupt status flag of the buffer control register. If the buffer is configured as receive, returned value is TRUE if the buffer contains newly received message. If the buffer is configured as transmit, returned value is TRUE if the buffer is empty.
-
SetAlarm
- The method enables alarm sync pulse generation on next cycle. The method is available only in Master mode.
-
ClrAlarm
- The method disables alarm sync pulse generation and normal sync pulses starts on next cycle. The method is available only in Master mode.
-
SetSleepRequest
- The method sets the request to switch the module to sleep mode. The module remains stopped until wakeup occurs. GetSleepAck method can be used to test if the module has entered the sleep mode.
-
ClrSleepRequest
- The method clears the request to switch the module to sleep mode and requests the normal mode entering. GetSleepAck method can be used to test the mode of the module.
-
GetSleepAck
- The method tests if the module is in Sleep or Normal run mode.
-
GetInitAck
- The method tests if the module is in Initialization (disabled) or Normal run (enabled) mode.
-
GetModuleVersion
- The method returns version number of the module implementation.
-
AbortMessage
- The method requests that specified full transmit buffer is aborted. The acknowledge of message abort can be tested by GetAbortMessageAck. AbortMessage method is available only if Transmit buffers are enabled.
-
GetAbortMessageAck
- The method tests if a message in the specified transmit buffer has been aborted (AbortMessage method). GetAbortMessageAck method is available only if Transmit buffers are enabled.
-
StartWakeupPulses
- The method causes to transmit wakeup pulses on the transmit pin. The method can be called only if the bean is disabled (Disable method).
-
StopWakeupPulses
- The method causes to stop transmitting wakeup pulses on the transmit pin. The method can be called only if the bean is disabled (Disable method).
Note: Some methods can be implemented as macros.