add documentation

This commit is contained in:
Dennis Gunia
2025-09-19 00:14:54 +02:00
parent 509e6430cb
commit 02d434dfc5

View File

@@ -137,25 +137,33 @@ void sfbus_send_frame(int fd, u_int16_t address, u_int8_t length, char *buffer)
free(frame_ptr); free(frame_ptr);
} }
/*
* Send SFBus frame with protocol version 2.0 and calculated CRC
*/
void sfbus_send_frame_v2(int fd, u_int16_t address, u_int8_t length, char *buffer) void sfbus_send_frame_v2(int fd, u_int16_t address, u_int8_t length, char *buffer)
{ {
int frame_size_complete = length + 7; int frame_size_complete = length + 7; // calculate size of complete transmission
// (including header, payload and crc)
char *frame = malloc(frame_size_complete); char *frame = malloc(frame_size_complete);
*(frame + 0) = '+'; // startbyte // assemble tx data
*(frame + 1) = 1; // protocol version *(frame + 0) = '+'; // startbyte (0x2B)
*(frame + 2) = length + 4; // length *(frame + 1) = 0x01; // protocol version (v2.0)
*(frame + 2) = length + 4; // length of frame
*(frame + 3) = (address); // addres high byte *(frame + 3) = (address); // addres high byte
*(frame + 4) = ((address >> 8)); // address low byte *(frame + 4) = ((address >> 8)); // address low byte
memcpy(frame + 5, buffer, length); // copy data to packet memcpy(frame + 5, buffer, length); // copy payload to packet
// add crc to frame
u_int16_t crc = calc_CRC16(buffer, length); // calculate CRC u_int16_t crc = calc_CRC16(buffer, length); // calculate CRC
*(frame + (frame_size_complete - 1)) = (crc); // addres high byte *(frame + (frame_size_complete - 1)) = (crc); // addres high byte
*(frame + (frame_size_complete - 0)) = ((crc >> 8)); // address low byte *(frame + (frame_size_complete - 0)) = ((crc >> 8)); // address low byte
// send data
int result = write(fd, frame, frame_size_complete); int result = write(fd, frame, frame_size_complete);
print_bufferHexTx(frame, frame_size_complete, address); print_bufferHexTx(frame, frame_size_complete, address);
free(frame); free(frame); // free malloc
} }