dennisgunia/split-flap-controller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add licence to source code + add protocol v2

Browse Source
This commit is contained in:
Dennis Gunia
2025-09-19 00:09:42 +02:00
parent dcc3a04c89
commit 509e6430cb
14 changed files with 550 additions and 316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
software/pc_client/makefile
View File

@@ -1,3 +1,12 @@
#
# This file is part of the split-flap project.
# Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
# Authors: Dennis Gunia
#
# This program is licenced under AGPL-3.0 license.
#
#
TARGET_EXEC ?= a.out
BUILD_DIR ?= ./build

9
software/pc_client/src/console.c
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "console.h"
const char *device_config_file = "./flapconfig.json";

9
software/pc_client/src/console.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "devicemgr.h"
#include "sfbus-util.h"
#include "wsserver.h"

17
software/pc_client/src/devicemgr.c
View File

@@ -1,13 +1,18 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
* This section provides an abstraction layer to access many devices
* simultaneously
*/
#include "devicemgr.h"
#include <json-c/json_object.h>
#include <string.h>
/*
* This section provides an abstraction layer to access many devices
* simultaneously.
*
* by Dennis Gunia - 2025 - www.dennisgunia.de
*/
enum SFDEVICE_STATE
{
UNALLOCATED,

9
software/pc_client/src/devicemgr.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "sfbus.h"
#include <ctype.h>
#include <errno.h> // Error integer and strerror() function

9
software/pc_client/src/ftdi485.c
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "ftdi485.h"
/*

9
software/pc_client/src/ftdi485.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <sys/ioctl.h>

100
software/pc_client/src/main.c
View File

@@ -1,26 +1,42 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is free software (...)
* You should have received a copy of the GNU Affero General Public License
* along with this program (...)
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the split-flap software without
* disclosing the source code of your own applications (...)
*
*/
#include <fcntl.h> // Contains file controls like O_RDWR
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
// Linux headers
#include <fcntl.h> // Contains file controls like O_RDWR
#include <sys/types.h>
#include <termios.h> // Contains POSIX terminal control definitions
#include <unistd.h> // write(), read(), close()
#include "console.h"
#include "devicemgr.h"
#include "ftdi485.h"
#include "sfbus.h"
#include "devicemgr.h"
#include "console.h"
void printUsage(char *argv[]) {
void printUsage(char *argv[])
{
fprintf(stderr, "Usage: %s -p <tty> -c <command> [value]\n", argv[0]);
exit(EXIT_FAILURE);
}
int main(int argc, char *argv[]) {
int main(int argc, char *argv[])
{
int opt = ' ';
u_int16_t addr_int = 0;
char *port = malloc(256);
@@ -30,8 +46,10 @@ int main(int argc, char *argv[]) {
command = "";
addr = "";
data = "";
while ((opt = getopt(argc, argv, "p:c:a:d:")) != -1) {
switch (opt) {
while ((opt = getopt(argc, argv, "p:c:a:d:")) != -1)
{
switch (opt)
{
case 'p':
port = optarg;
break;
@@ -48,16 +66,19 @@ int main(int argc, char *argv[]) {
printUsage(argv);
}
}
if (access(port, F_OK) != 0) {
fprintf(stderr, "Filedescriptor: %s does not exist or cannot be opened\n",
port);
if (access(port, F_OK) != 0)
{
fprintf(stderr, "Filedescriptor: %s does not exist or cannot be opened\n", port);
printUsage(argv);
}
// parse address
if (strlen(addr) == 0) {
if (strlen(addr) == 0)
{
fprintf(stderr, "Please specify address\n");
printUsage(argv);
} else {
}
else
{
addr_int = strtol(addr, NULL, 10);
}
@@ -67,11 +88,16 @@ int main(int argc, char *argv[]) {
printf("Open device at %s\n", port);
int fd = rs485_init(port, B19200); // setup rs485
if (strcmp(command, "ping") == 0) {
} else if (strcmp(command, "printf") == 0) {
if (strcmp(command, "ping") == 0)
{
sfbus_ping(fd, addr_int);
}
else if (strcmp(command, "printf") == 0)
{
devicemgr_printText(data, 0, 0);
} else if (strcmp(command, "r_eeprom") == 0) {
}
else if (strcmp(command, "r_eeprom") == 0)
{
char *buffer = malloc(64);
sfbus_read_eeprom(fd, addr_int, buffer);
printf("Read data: 0x");
@@ -79,15 +105,21 @@ int main(int argc, char *argv[]) {
printf("\n");
free(buffer);
exit(0);
} else if (strcmp(command, "w_addr") == 0) {
}
else if (strcmp(command, "w_addr") == 0)
{
int n_addr = strtol(data, NULL, 10);
int ret = sfbusu_write_address(fd, addr_int, n_addr);
exit(ret);
} else if (strcmp(command, "w_cal") == 0) {
}
else if (strcmp(command, "w_cal") == 0)
{
int n_addr = strtol(data, NULL, 10);
int ret = sfbusu_write_calibration(fd, addr_int, n_addr);
exit(ret);
} else if (strcmp(command, "status") == 0) {
}
else if (strcmp(command, "status") == 0)
{
double voltage = 0;
u_int32_t counter = 0;
u_int8_t status = sfbus_read_status(fd, addr_int, &voltage, &counter);
@@ -104,30 +136,44 @@ int main(int argc, char *argv[]) {
printf("Rotations : %i\n", counter);
exit(0);
} else if (strcmp(command, "display") == 0) {
}
else if (strcmp(command, "display") == 0)
{
int flap = strtol(data, NULL, 10);
// read current eeprom status
char *buffer_w = malloc(4);
sfbus_display(fd, addr_int, flap);
exit(0);
} else if (strcmp(command, "display_fr") == 0) {
}
else if (strcmp(command, "display_fr") == 0)
{
int flap = strtol(data, NULL, 10);
// read current eeprom status
char *buffer_w = malloc(4);
sfbus_display_full(fd, addr_int, flap);
exit(0);
}else if (strcmp(command, "reset") == 0) {
}
else if (strcmp(command, "reset") == 0)
{
sfbus_reset_device(fd, addr_int);
exit(0);
} else if (strcmp(command, "power_on") == 0) {
}
else if (strcmp(command, "power_on") == 0)
{
sfbus_motor_power(fd, addr_int, 1);
exit(0);
} else if (strcmp(command, "power_off") == 0) {
}
else if (strcmp(command, "power_off") == 0)
{
sfbus_motor_power(fd, addr_int, 0);
exit(0);
} else if (strcmp(command, "server") == 0){
}
else if (strcmp(command, "server") == 0)
{
start_console(fd);
} else {
}
else
{
fprintf(stderr, "Invalid command specified!\n");
printUsage(argv);
}

9
software/pc_client/src/sfbus-util.c
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "sfbus-util.h"
int sfbusu_write_address(int fd, u_int16_t current, u_int16_t new)
{

9
software/pc_client/src/sfbus-util.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "sfbus.h"
#include <stdio.h>
#include <stdlib.h>

169
software/pc_client/src/sfbus.c
View File

@@ -1,36 +1,52 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "sfbus.h"
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
void print_charHex(char *buffer, int length) {
void print_charHex(char *buffer, int length)
{
int _tlength = length;
while (_tlength > 0) {
while (_tlength > 0)
{
printf("%02X ", (*buffer & 0xFF));
buffer++;
_tlength--;
}
}
void print_bufferHexRx(char *buffer, int length, u_int16_t address) {
printf("Rx (0x%04X): 0x", address);
void print_bufferHexRx(char *buffer, int length, u_int16_t address)
{
printf("Rx (0x%04X): ", address);
print_charHex(buffer, length);
printf(" | %i bytes received\n", length);
}
void print_bufferHexTx(char *buffer, int length, u_int16_t address) {
printf("Tx (0x%04X): 0x", address);
void print_bufferHexTx(char *buffer, int length, u_int16_t address)
{
printf("Tx (0x%04X): ", address);
print_charHex(buffer, length);
printf(" | %i bytes sent\n", length);
}
ssize_t sfbus_recv_frame_wait(int fd, u_int16_t address, char *buffer) {
ssize_t sfbus_recv_frame_wait(int fd, u_int16_t address, char *buffer)
{
ssize_t len = 0;
int retryCount = 2;
do {
do
{
len = sfbus_recv_frame(fd, address, buffer);
retryCount--;
if (retryCount == 0) {
if (retryCount == 0)
{
fprintf(stderr, "Rx timeout\n");
return -1;
}
@@ -39,15 +55,18 @@ ssize_t sfbus_recv_frame_wait(int fd, u_int16_t address, char *buffer) {
return len;
}
ssize_t sfbus_recv_frame(int fd, u_int16_t address, char *buffer) {
ssize_t sfbus_recv_frame(int fd, u_int16_t address, char *buffer)
{
// wait for start byte
char byte = 0x00;
int retryCount = 3;
while (byte != '+') {
while (byte != '+')
{
byte = 0x00;
read(fd, &byte, 1);
retryCount--;
if (retryCount == 0) {
if (retryCount == 0)
{
return -1;
}
}
@@ -63,28 +82,33 @@ ssize_t sfbus_recv_frame(int fd, u_int16_t address, char *buffer) {
read(fd, &frm_addr_h, 1);
u_int16_t dst_addr = frm_addr_l | (frm_addr_h << 8);
if (dst_addr != address) {
if (dst_addr != address)
{
return 0;
}
u_int8_t frm_length_counter = frm_length - 3;
// read all bytes:
while (frm_length_counter > 0) {
while (frm_length_counter > 0)
{
read(fd, buffer, 1);
buffer++;
frm_length_counter--;
}
read(fd, &frm_eof, 1);
if (frm_eof == '$') {
if (frm_eof == '$')
{
return frm_length;
} else {
}
else
{
return -1;
}
}
void sfbus_send_frame(int fd, u_int16_t address, u_int8_t length,
char *buffer) {
void sfbus_send_frame(int fd, u_int16_t address, u_int8_t length, char *buffer)
{
int frame_size_complete = length + 6;
char *frame = malloc(frame_size_complete);
char *frame_ptr = frame;
@@ -99,7 +123,8 @@ void sfbus_send_frame(int fd, u_int16_t address, u_int8_t length,
frame++;
*frame = ((address >> 8));
frame++;
while (length > 0) {
while (length > 0)
{
*frame = *buffer;
length--;
buffer++;
@@ -110,35 +135,63 @@ void sfbus_send_frame(int fd, u_int16_t address, u_int8_t length,
int result = write(fd, frame_ptr, frame_size_complete);
print_bufferHexTx(frame_ptr + 5, frame_size_complete - 6, address);
free(frame_ptr);
}
int sfbus_ping(int fd, u_int16_t address) {
void sfbus_send_frame_v2(int fd, u_int16_t address, u_int8_t length, char *buffer)
{
int frame_size_complete = length + 7;
char *frame = malloc(frame_size_complete);
*(frame + 0) = '+'; // startbyte
*(frame + 1) = 1; // protocol version
*(frame + 2) = length + 4; // length
*(frame + 3) = (address); // addres high byte
*(frame + 4) = ((address >> 8)); // address low byte
memcpy(frame + 5, buffer, length); // copy data to packet
u_int16_t crc = calc_CRC16(buffer, length); // calculate CRC
*(frame + (frame_size_complete - 1)) = (crc); // addres high byte
*(frame + (frame_size_complete - 0)) = ((crc >> 8)); // address low byte
int result = write(fd, frame, frame_size_complete);
print_bufferHexTx(frame, frame_size_complete, address);
free(frame);
}
int sfbus_ping(int fd, u_int16_t address)
{
char *cmd = "\xFE";
char *buffer = malloc(64);
sfbus_send_frame(fd, address, strlen(cmd), cmd);
sfbus_send_frame_v2(fd, address, strlen(cmd), cmd);
int len = sfbus_recv_frame_wait(fd, 0xFFFF, buffer);
if (len == 4 && *buffer == (char)0xFF) {
if (len == 4 && *buffer == (char)0xFF)
{
printf("Ping okay!\n");
free(buffer);
return 0;
} else {
}
else
{
printf("Ping invalid response!\n");
free(buffer);
return 1;
}
}
int sfbus_read_eeprom(int fd, u_int16_t address, char *buffer) {
int sfbus_read_eeprom(int fd, u_int16_t address, char *buffer)
{
char *cmd = "\xF0";
char *_buffer = malloc(256);
sfbus_send_frame(fd, address, strlen(cmd), cmd);
int len = sfbus_recv_frame_wait(fd, 0xFFFF, _buffer);
if (len != 9) {
if (len != 9)
{
printf("Invalid data!\n");
return -1;
}
if (*(_buffer + 5) != (char)0xAA || *(_buffer) != (char)0xAA) {
if (*(_buffer + 5) != (char)0xAA || *(_buffer) != (char)0xAA)
{
printf("Invalid data!\n");
return -1;
}
@@ -148,8 +201,8 @@ int sfbus_read_eeprom(int fd, u_int16_t address, char *buffer) {
return len;
}
int sfbus_write_eeprom(int fd, u_int16_t address, char *wbuffer,
char *rbuffer) {
int sfbus_write_eeprom(int fd, u_int16_t address, char *wbuffer, char *rbuffer)
{
char *cmd = malloc(5);
*cmd = (char)0xF1; // write eeprom command
memcpy(cmd + 1, wbuffer, 4);
@@ -158,11 +211,13 @@ int sfbus_write_eeprom(int fd, u_int16_t address, char *wbuffer,
// wait for readback
char *_buffer = malloc(256);
int len = sfbus_recv_frame_wait(fd, 0xFFFF, _buffer);
if (len != 9) {
if (len != 9)
{
printf("Invalid data!\n");
return -1;
}
if (*(_buffer + 5) != (char)0xAA || *(_buffer) != (char)0xAA) {
if (*(_buffer + 5) != (char)0xAA || *(_buffer) != (char)0xAA)
{
printf("Invalid data!\n");
return -1;
}
@@ -172,7 +227,8 @@ int sfbus_write_eeprom(int fd, u_int16_t address, char *wbuffer,
return len;
}
int sfbus_display(int fd, u_int16_t address, u_int8_t flap) {
int sfbus_display(int fd, u_int16_t address, u_int8_t flap)
{
char *cmd = malloc(5);
*cmd = (char)0x10; // write eeprom command
*(cmd + 1) = flap;
@@ -181,7 +237,8 @@ int sfbus_display(int fd, u_int16_t address, u_int8_t flap) {
return 0;
}
int sfbus_display_full(int fd, u_int16_t address, u_int8_t flap) {
int sfbus_display_full(int fd, u_int16_t address, u_int8_t flap)
{
char *cmd = malloc(5);
*cmd = (char)0x11; // write eeprom command
*(cmd + 1) = flap;
@@ -190,19 +247,19 @@ int sfbus_display_full(int fd, u_int16_t address, u_int8_t flap) {
return 0;
}
u_int8_t sfbus_read_status(int fd, u_int16_t address, double *voltage,
u_int32_t *counter) {
u_int8_t sfbus_read_status(int fd, u_int16_t address, double *voltage, u_int32_t *counter)
{
char *cmd = "\xF8";
char *_buffer = malloc(256);
sfbus_send_frame(fd, address, strlen(cmd), cmd);
int res = sfbus_recv_frame_wait(fd, 0xFFFF, _buffer);
if (res < 0){
if (res < 0)
{
return 0xFF;
}
u_int16_t _voltage = *(_buffer + 2) & 0xFF | ((*(_buffer + 1) << 8) & 0xFF00);
u_int32_t _counter =
*(_buffer + 6) & 0xFF | (((*(_buffer + 3) & 0xFF) << 24)) |
(((*(_buffer + 4) & 0xFF) << 16)) | (((*(_buffer + 5) & 0xFF) << 8));
u_int32_t _counter = *(_buffer + 6) & 0xFF | (((*(_buffer + 3) & 0xFF) << 24)) | (((*(_buffer + 4) & 0xFF) << 16)) |
(((*(_buffer + 5) & 0xFF) << 8));
double __voltage = ((double)_voltage / 1024) * 55;
@@ -211,15 +268,43 @@ u_int8_t sfbus_read_status(int fd, u_int16_t address, double *voltage,
return *_buffer;
}
void sfbus_reset_device(int fd, u_int16_t address) {
void sfbus_reset_device(int fd, u_int16_t address)
{
char *cmd = "\x30";
sfbus_send_frame(fd, address, strlen(cmd), cmd);
}
void sfbus_motor_power(int fd, u_int16_t address, u_int8_t state) {
void sfbus_motor_power(int fd, u_int16_t address, u_int8_t state)
{
char *cmd = "\x20";
if (state > 0) {
if (state > 0)
{
cmd = "\x21";
}
sfbus_send_frame(fd, address, 1, cmd);
}
u_int16_t calc_CRC16(char *buffer, u_int8_t len)
{
u_int16_t crc16 = 0xFFFF;
for (u_int8_t pos = 0; pos < len; pos++)
{
char byte_value = *(buffer); // read byte after byte from buffer
buffer++;
crc16 ^= byte_value; // XOR byte into least sig. byte of crc
for (int i = 8; i != 0; i--)
{ // Loop over each bit
if ((crc16 & 0x0001) != 0)
{ // If the LSB is set
crc16 >>= 1; // Shift right and XOR 0xA001
crc16 ^= 0xA001;
}
else
{ // Else LSB is not set
crc16 >>= 1; // Just shift right
}
}
}
return crc16;
}

10
software/pc_client/src/sfbus.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "ftdi485.h"
ssize_t sfbus_recv_frame(int fd, u_int16_t address, char *buffer);
@@ -12,3 +21,4 @@ int sfbus_display_full(int fd, u_int16_t address, u_int8_t flap);
u_int8_t sfbus_read_status(int fd, u_int16_t address, double *voltage, u_int32_t *counter);
void sfbus_reset_device(int fd, u_int16_t address);
void sfbus_motor_power(int fd, u_int16_t address, u_int8_t state);
u_int16_t calc_CRC16(char *buffer, u_int8_t len);

11
software/pc_client/src/wsserver.c
View File

@@ -1,10 +1,17 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include "wsserver.h"
/*
* This section provides a web server to controll the
* device manager through web sockets
*
* by Dennis Gunia - 2025 - www.dennisgunia.de
*/
json_object *(*commandparser_func)(json_object *);

9
software/pc_client/src/wsserver.h
View File

@@ -1,3 +1,12 @@
/*
* This file is part of the split-flap project.
* Copyright (c) 2024-2025 GuniaLabs (www.dennisgunia.de)
* Authors: Dennis Gunia
*
* This program is licenced under AGPL-3.0 license.
*
*/
#include <json-c/json_object.h>
#include <json-c/json_tokener.h>
#include <stdio.h>