Mirror/opentx
1
0
Fork 0
mirror of https://github.com/opentx/opentx.git synced 2025-07-16 12:55:12 +03:00
Code Issues Wiki Activity

Lua docs update (CrossfireTelemetryPush and crossfireTelemetryPop and some small spelling fixes)

Browse source
This commit is contained in:
Damjan Adamic 2017-08-27 16:45:56 +02:00
parent 1bb8aab866
commit 6cc40c65b2
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
radio/src/lua/api_general.cpp
View file

@ -108,7 +108,7 @@ Return the time since the radio was started in multiple of 10ms
@retval number Number of 10ms ticks since the radio was started Example: @retval number Number of 10ms ticks since the radio was started Example:
run time: 12.54 seconds, return value: 1254 run time: 12.54 seconds, return value: 1254
The timer internally uses a 32-bit counter which is enough for 30year so The timer internally uses a 32-bit counter which is enough for 30 years so
overflows will not happen. overflows will not happen.
@status current Introduced in 2.0.0 @status current Introduced in 2.0.0
@ -311,7 +311,9 @@ Pops a received SPORT packet from the queue. Please note that only packets using
(frame ID == 0x10), as well as packets with a frame ID equal 0x32 (regardless of the data ID) will be passed to (frame ID == 0x10), as well as packets with a frame ID equal 0x32 (regardless of the data ID) will be passed to
the LUA telemetry receive queue. the LUA telemetry receive queue.
@retval SPORT paket as a quadruple: @retval nil queue does not contain any (or enough) bytes to form a whole packet
@retval multiple returns 4 values:
* sensor ID (number) * sensor ID (number)
* frame ID (number) * frame ID (number)
* data ID (number) * data ID (number)
@ -359,7 +361,7 @@ uint8_t getDataId(uint8_t physicalId)
This functions allows for sending SPORT telemetry data toward the receiver, This functions allows for sending SPORT telemetry data toward the receiver,
and more generally, to anything connected SPORT bus on the receiver or transmitter. and more generally, to anything connected SPORT bus on the receiver or transmitter.
When called without parameters, it will only return the status of the ouput buffer without sending anything. When called without parameters, it will only return the status of the output buffer without sending anything.
@param sensorId physical sensor ID @param sensorId physical sensor ID
@ -396,11 +398,13 @@ static int luaSportTelemetryPush(lua_State * L)
/*luadoc /*luadoc
@function crossfireTelemetryPop() @function crossfireTelemetryPop()
@retval SPORT paket as a quadruple: Pops a received Crossfire Telemetry packet from the queue.
* sensor ID (number)
* frame ID (number) @retval nil queue does not contain any (or enough) bytes to form a whole packet
* data ID (number)
* value (number) @retval multiple returns 2 values:
* command (number)
* packet (table) data bytes
@status current Introduced in 2.2.0 @status current Introduced in 2.2.0
*/ */
@ -437,15 +441,11 @@ static int luaCrossfireTelemetryPop(lua_State * L)
This functions allows for sending telemetry data toward the TBS Crossfire link. This functions allows for sending telemetry data toward the TBS Crossfire link.
When called without parameters, it will only return the status of the ouput buffer without sending anything. When called without parameters, it will only return the status of the output buffer without sending anything.
@param sensorId physical sensor ID @param command command
@param frameId frame ID @param data table of data bytes
@param dataId data ID
@param value value
@retval boolean data queued in output buffer or not. @retval boolean data queued in output buffer or not.