CAN Module¶
| Since | Origin / Contributor | Maintainer | Source |
|---|---|---|---|
| 2017-04-27 | @ThomasBarth, zelll | can.c |
The CAN module provides access to the in-built CAN controller.
can.send()¶
Send a frame.
Syntax¶
can.send(format, msg_id, data)
Parameters¶
formatFrame format.can.STANDARD_FRAMEorcan.EXTENDED_FRAMEmsg_idCAN Messge IDdataCAN data, up to 8 bytes
Returns¶
nil
can.setup()¶
Configuration CAN controller.
Syntax¶
can.setup(config, callback)
Parameters¶
configtable.speedkbps. One of following value:1000,800,500,250,100.txPin num for TX.rxPin num for RX.dual_filtertruedual filter mode,falsesingle filter mode (default)code4-bytes integer. Use this with mask to filter CAN frame. Default:0. See SJA1000mask4-bytes integer. Default:0xffffffff
callbackfunction to be called when CAN data received.formatFrame format.can.STANDARD_FRAMEorcan.EXTENDED_FRAMEmsg_idCAN Message IDdataCAN data, up to 8 bytes
Returns¶
nil
Example¶
can.setup({
speed = 1000,
tx = 5,
rx = 4,
dual_filter = false,
code = 0,
mask = 0xffffffff
}, function(format, msg_id, data) end)
can.start()¶
Start CAN controller.
Syntax¶
can.start()
Parameters¶
none
Returns¶
nil
can.stop()¶
Stop CAN controller.
Syntax¶
can.stop()
Parameters¶
none
Returns¶
nil