HMS NETWORKS CANbridge NT Lua ADK Bridge Router User Guide

Lua API Funcon and Module Reference  

CAN@net NT/CANbridge NT Lua ADK  

5. Lua API Funcon and Module Reference  

5.1. Lua Callback Funcons Called from C  

Funcon 'initialize'  

initialize()  

Called once while the rmware is being inialized. It is used to register CAN and MQTT messages for recepon  

and to inialize variables.  

Funcon 'loop'  

loop(ticks, elapsed)  

Called cyclically every 100 ms afer the inializaon phase, when the device is up and running. It is used to  

trigger cyclically recurring tasks.  

• ticks: counter value that is incremented with each call of loop  

• elapsed: me in ms since the last call of loop  

Funcon 'on_can'  

on_can(topic, port, format, ident, data)  

Called on each CAN message recepon, based on message regisraons via can.register_msg.  

• topic: user dened reference value used by can.register_msg  

port: CAN port number (1.. 4), depending on the available CAN ports of the target device  

• format: combinaon of three characters to specify the message format, e.g.:  

– "csr"means: "classic CAN", "standard idener (11 bit)", "remote frame"  

– "fed"means: "CAN-FD", "extended idener (29 bit)", "data frame"  

• ident: CAN message idener (0.. 0x7FFfor standard messages and 0.. 0x1FFFFFFFfor extended  

messages)  

• data: message data bytes provided as Lua table or as byte array (see module array)  

Funcon 'on_mqtt'  

on_mqtt(handle, topic, payload, qos)  

Called on each MQTT message recepon, based on message regisraons via mqtt.subscribe.  

• handle: user dened reference value used by mqtt.subscribe  

• topic: message topic as string  

• payload: message data as string  

• qos: quality of service (0, 1, 2)  

4.02.0332.20002 Version 1.5  

Page 9 of 20  

VIEW FULL SCREEN PDF MANUAL

General	Details
Name	HMS NETWORKS CANbridge NT Lua ADK Bridge Router User Guide
Make	HMS NETWORKS
Language	English
Filetype	PDF (Download)
File size	MB

Download PDF

(1 votes, average: 5.00 out of 5)

Loading...

• ALL WI-FI INSTRUCTIONS & USER MANUALS
• HMS NETWORKS

Questions and Answers (0)

If you have any questions regarding HMS NETWORKS CANbridge NT Lua ADK Bridge Router User Guide, please ask here and describe the problem in detail.