_/qmk_firmware
1
0
Fork 0
Code Releases Activity
qmk_firmware/docs/api_sysex_tools.md
skullydazed 7c9d5ace14 Generate API docs from source code comments (#2491) 
* Generate api docs from source code

* Add a bunch of doxygen comments

* more doxygen comments

* Add the in-progress api docs

* script to generate docs from travis

* Add doc generation to the travis job

* make travis_docs.sh commit the work it does

* make sure the docs script exits cleanly
2018-03-22 02:50:38 -04:00

2.8 KiB
Raw Blame History

group sysex_tools

Summary

Members Descriptions
public uint16_t sysex_encoded_length(uint16_t decoded_length) Compute the length of a message after it is encoded.
public uint16_t sysex_decoded_length(uint16_t encoded_length) Compute the length of a message after it is decoded.
public uint16_t sysex_encode(uint8_t * encoded,const uint8_t * source,uint16_t length) Encode data so that it can be transmitted safely in a sysex message.
public uint16_t sysex_decode(uint8_t * decoded,const uint8_t * source,uint16_t length) Decode encoded data.

Members

public uint16_t sysex_encoded_length(uint16_t decoded_length)

Compute the length of a message after it is encoded.

Parameters

  • decoded_length The length, in bytes, of the message to encode.

Returns

The length, in bytes, of the message after encodeing.

public uint16_t sysex_decoded_length(uint16_t encoded_length)

Compute the length of a message after it is decoded.

Parameters

  • encoded_length The length, in bytes, of the encoded message.

Returns

The length, in bytes, of the message after it is decoded.

public uint16_t sysex_encode(uint8_t * encoded,const uint8_t * source,uint16_t length)

Encode data so that it can be transmitted safely in a sysex message.

Parameters

  • encoded The output data buffer, must be at least sysex_encoded_length(length) bytes long.

  • source The input buffer of data to be encoded.

  • length The number of bytes from the input buffer to encode.

Returns

number of bytes encoded.

public uint16_t sysex_decode(uint8_t * decoded,const uint8_t * source,uint16_t length)

Decode encoded data.

Parameters

  • decoded The output data buffer, must be at least sysex_decoded_length(length) bytes long.

  • source The input buffer of data to be decoded.

  • length The number of bytes from the input buffer to decode.

Returns

number of bytes decoded.