1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-09 00:00:04 +01:00

minimal-raw-serial

Add a minimal example showing how to set up, send and receive on a
serial tty in the event loop.
This commit is contained in:
Andy Green 2019-12-08 16:34:13 +00:00
parent fb25b64b83
commit 8c2114a430
4 changed files with 358 additions and 1 deletions

View file

@ -360,7 +360,10 @@ lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len)
len, 0, &wsi->udp->sa, wsi->udp->salen);
} else
#endif
n = send(wsi->desc.sockfd, (char *)buf, len, MSG_NOSIGNAL);
if (wsi->role_ops->file_handle)
n = write(wsi->desc.filefd, buf, len);
else
n = send(wsi->desc.sockfd, (char *)buf, len, MSG_NOSIGNAL);
// lwsl_info("%s: sent len %d result %d", __func__, len, n);
#if defined(LWS_WITH_UDP)

View file

@ -0,0 +1,77 @@
cmake_minimum_required(VERSION 2.8)
include(CheckCSourceCompiles)
set(SAMP lws-minimal-raw-serial)
set(SRCS minimal-raw-file.c)
# If we are being built as part of lws, confirm current build config supports
# reqconfig, else skip building ourselves.
#
# If we are being built externally, confirm installed lws was configured to
# support reqconfig, else error out with a helpful message about the problem.
#
MACRO(require_lws_config reqconfig _val result)
if (DEFINED ${reqconfig})
if (${reqconfig})
set (rq 1)
else()
set (rq 0)
endif()
else()
set(rq 0)
endif()
if (${_val} EQUAL ${rq})
set(SAME 1)
else()
set(SAME 0)
endif()
if (LWS_WITH_MINIMAL_EXAMPLES AND NOT ${SAME})
if (${_val})
message("${SAMP}: skipping as lws being built without ${reqconfig}")
else()
message("${SAMP}: skipping as lws built with ${reqconfig}")
endif()
set(${result} 0)
else()
if (LWS_WITH_MINIMAL_EXAMPLES)
set(MET ${SAME})
else()
CHECK_C_SOURCE_COMPILES("#include <libwebsockets.h>\nint main(void) {\n#if defined(${reqconfig})\n return 0;\n#else\n fail;\n#endif\n return 0;\n}\n" HAS_${reqconfig})
if (NOT DEFINED HAS_${reqconfig} OR NOT HAS_${reqconfig})
set(HAS_${reqconfig} 0)
else()
set(HAS_${reqconfig} 1)
endif()
if ((HAS_${reqconfig} AND ${_val}) OR (NOT HAS_${reqconfig} AND NOT ${_val}))
set(MET 1)
else()
set(MET 0)
endif()
endif()
if (NOT MET)
if (${_val})
message(FATAL_ERROR "This project requires lws must have been configured with ${reqconfig}")
else()
message(FATAL_ERROR "Lws configuration of ${reqconfig} is incompatible with this project")
endif()
endif()
endif()
ENDMACRO()
set(requirements 1)
require_lws_config(LWS_WITH_SERVER 1 requirements)
if (requirements)
add_executable(${SAMP} ${SRCS})
if (websockets_shared)
target_link_libraries(${SAMP} websockets_shared)
add_dependencies(${SAMP} websockets_shared)
else()
target_link_libraries(${SAMP} websockets)
endif()
endif()

View file

@ -0,0 +1,46 @@
# lws minimal raw serial example
This demonstrates adopting a file descriptor representing a serial device
into the event loop, printing a string on it every couple of seconds and
showing any serial that is received.
The serial terminal is configured for 115200 8N1.
```
$ ./lws-minimal-raw-serial <tty, eg, /dev/ttyUSB0>
```
## build
```
$ cmake . && make
```
## usage
```
[2019/12/08 16:30:53:4436] U: LWS minimal raw serial
[2019/12/08 16:30:53:5016] E: callback_ntpc: set up system ops for set_clock
[2019/12/08 16:30:54:8061] N: callback_ntpc: Unix time: 1575822654
[2019/12/08 16:30:54:8253] N: LWS_CALLBACK_RAW_ADOPT_FILE
[2019/12/08 16:30:54:8364] N: callback_ntpc: LWS_CALLBACK_RAW_CLOSE
[2019/12/08 16:30:54:8456] N: LWS_CALLBACK_RAW_WRITEABLE_FILE
[2019/12/08 16:30:56:8455] N: LWS_CALLBACK_RAW_WRITEABLE_FILE
[2019/12/08 16:30:58:8460] N: LWS_CALLBACK_RAW_WRITEABLE_FILE
[2019/12/08 16:30:59:1570] N: LWS_CALLBACK_RAW_RX_FILE
[2019/12/08 16:30:59:1604] N:
[2019/12/08 16:30:59:1641] N: 0000: 62 b
[2019/12/08 16:30:59:1644] N:
[2019/12/08 16:31:00:8463] N: LWS_CALLBACK_RAW_WRITEABLE_FILE
[2019/12/08 16:31:01:6392] N: LWS_CALLBACK_RAW_RX_FILE
[2019/12/08 16:31:01:6397] N:
[2019/12/08 16:31:01:6407] N: 0000: 65 e
[2019/12/08 16:31:01:6411] N:
[2019/12/08 16:31:02:8463] N: LWS_CALLBACK_RAW_WRITEABLE_FILE
... .
```
The remote serial connection will show the string sent every 2s.

View file

@ -0,0 +1,231 @@
/*
* lws-minimal-raw-file
*
* Written in 2010-2019 by Andy Green <andy@warmcat.com>
*
* This file is made available under the Creative Commons CC0 1.0
* Universal Public Domain Dedication.
*
* This demonstrates dealing with a serial port
*/
#include <libwebsockets.h>
#include <string.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <termios.h>
#include <sys/ioctl.h>
#if defined(__linux__)
#include <asm/ioctls.h>
#include <linux/serial.h>
#endif
struct raw_vhd {
lws_sorted_usec_list_t sul;
struct lws *wsi;
int filefd;
};
static char filepath[256];
static void
sul_cb(lws_sorted_usec_list_t *sul)
{
struct raw_vhd *v = lws_container_of(sul, struct raw_vhd, sul);
lws_callback_on_writable(v->wsi);
lws_sul_schedule(lws_get_context(v->wsi), 0, &v->sul, sul_cb,
2 * LWS_USEC_PER_SEC);
}
static int
callback_raw_test(struct lws *wsi, enum lws_callback_reasons reason,
void *user, void *in, size_t len)
{
struct raw_vhd *vhd = (struct raw_vhd *)lws_protocol_vh_priv_get(
lws_get_vhost(wsi), lws_get_protocol(wsi));
#if defined(__linux__)
struct serial_struct s_s;
#endif
lws_sock_file_fd_type u;
struct termios tio;
uint8_t buf[1024];
int n;
switch (reason) {
case LWS_CALLBACK_PROTOCOL_INIT:
vhd = lws_protocol_vh_priv_zalloc(lws_get_vhost(wsi),
lws_get_protocol(wsi), sizeof(struct raw_vhd));
vhd->filefd = lws_open(filepath, O_RDWR);
if (vhd->filefd == -1) {
lwsl_err("Unable to open %s\n", filepath);
return 1;
}
tcflush(vhd->filefd, TCIOFLUSH);
#if defined(__linux__)
if (ioctl(vhd->filefd, TIOCGSERIAL, &s_s) == 0) {
s_s.closing_wait = ASYNC_CLOSING_WAIT_NONE;
ioctl(vhd->filefd, TIOCSSERIAL, &s_s);
}
#endif
/* enforce suitable tty state */
memset(&tio, 0, sizeof tio);
if (tcgetattr(vhd->filefd, &tio)) {
close(vhd->filefd);
vhd->filefd = -1;
return -1;
}
cfsetispeed(&tio, B115200);
cfsetospeed(&tio, B115200);
tio.c_lflag &= ~(ISIG | ICANON | IEXTEN | ECHO |
#if defined(__linux__)
XCASE |
#endif
ECHOE | ECHOK | ECHONL | ECHOCTL | ECHOKE);
tio.c_iflag &= ~(INLCR | IGNBRK | IGNPAR | IGNCR | ICRNL |
IMAXBEL | IXON | IXOFF | IXANY
#if defined(__linux__)
| IUCLC
#endif
| 0xff);
tio.c_oflag = 0;
tio.c_cc[VMIN] = 1;
tio.c_cc[VTIME] = 0;
tio.c_cc[VEOF] = 1;
tio.c_cflag &= ~(
#if defined(__linux__)
CBAUD |
#endif
CSIZE | CSTOPB | PARENB | CRTSCTS);
tio.c_cflag |= 0x1412 | CS8 | CREAD | CLOCAL;
tcsetattr(vhd->filefd, TCSANOW, &tio);
u.filefd = (lws_filefd_type)(long long)vhd->filefd;
if (!lws_adopt_descriptor_vhost(lws_get_vhost(wsi),
LWS_ADOPT_RAW_FILE_DESC, u,
"raw-test", NULL)) {
lwsl_err("Failed to adopt fifo descriptor\n");
close(vhd->filefd);
vhd->filefd = -1;
return 1;
}
break;
case LWS_CALLBACK_PROTOCOL_DESTROY:
if (vhd && vhd->filefd != -1)
close(vhd->filefd);
break;
/* callbacks related to raw file descriptor */
case LWS_CALLBACK_RAW_ADOPT_FILE:
lwsl_notice("LWS_CALLBACK_RAW_ADOPT_FILE\n");
vhd->wsi = wsi;
lws_sul_schedule(lws_get_context(wsi), 0, &vhd->sul, sul_cb, 1);
break;
case LWS_CALLBACK_RAW_RX_FILE:
lwsl_notice("LWS_CALLBACK_RAW_RX_FILE\n");
n = read(vhd->filefd, buf, sizeof(buf));
if (n < 0) {
lwsl_err("Reading from %s failed\n", filepath);
return 1;
}
lwsl_hexdump_level(LLL_NOTICE, buf, n);
break;
case LWS_CALLBACK_RAW_CLOSE_FILE:
lwsl_notice("LWS_CALLBACK_RAW_CLOSE_FILE\n");
lws_sul_schedule(lws_get_context(wsi), 0, &vhd->sul, sul_cb, LWS_SET_TIMER_USEC_CANCEL);
break;
case LWS_CALLBACK_RAW_WRITEABLE_FILE:
lwsl_notice("LWS_CALLBACK_RAW_WRITEABLE_FILE\n");
if (lws_write(wsi, (uint8_t *)"hello-this-is-written-every-couple-of-seconds\r\n", 47, LWS_WRITE_RAW) != 47)
return -1;
break;
default:
break;
}
return 0;
}
static struct lws_protocols protocols[] = {
{ "raw-test", callback_raw_test, 0, 0 },
{ NULL, NULL, 0, 0 } /* terminator */
};
static int interrupted;
void sigint_handler(int sig)
{
interrupted = 1;
}
int main(int argc, const char **argv)
{
struct lws_context_creation_info info;
struct lws_context *context;
const char *p;
int n = 0, logs = LLL_USER | LLL_ERR | LLL_WARN | LLL_NOTICE
/* for LLL_ verbosity above NOTICE to be built into lws,
* lws must have been configured and built with
* -DCMAKE_BUILD_TYPE=DEBUG instead of =RELEASE */
/* | LLL_INFO */ /* | LLL_PARSER */ /* | LLL_HEADER */
/* | LLL_EXT */ /* | LLL_CLIENT */ /* | LLL_LATENCY */
/* | LLL_DEBUG */;
signal(SIGINT, sigint_handler);
if ((p = lws_cmdline_option(argc, argv, "-d")))
logs = atoi(p);
lws_set_log_level(logs, NULL);
lwsl_user("LWS minimal raw serial\n");
if (argc < 2) {
lwsl_user("Usage: %s <serial device> "
" eg, /dev/ttyUSB0\n", argv[0]);
return 1;
}
signal(SIGINT, sigint_handler);
memset(&info, 0, sizeof info); /* otherwise uninitialized garbage */
info.port = CONTEXT_PORT_NO_LISTEN_SERVER; /* no listen socket for demo */
info.protocols = protocols;
lws_strncpy(filepath, argv[1], sizeof(filepath));
context = lws_create_context(&info);
if (!context) {
lwsl_err("lws init failed\n");
return 1;
}
while (n >= 0 && !interrupted)
n = lws_service(context, 0);
lws_context_destroy(context);
return 0;
}