├── component.mk ├── library.json ├── Kconfig ├── README.md ├── logging_server.py ├── include └── udp_logging.h ├── udp_logging.c └── LICENSE /component.mk: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "embedded-esp32-component-udp_logging", 3 | "version": "0.0.0+20250731140158" 4 | } -------------------------------------------------------------------------------- /Kconfig: -------------------------------------------------------------------------------- 1 | menu "UDP Logging" 2 | 3 | config LOG_UDP_PORT 4 | int "UDP Port" 5 | default 1337 6 | help 7 | UDP Port to send log output to 8 | 9 | config LOG_UDP_IP 10 | string "IP address to send log output" 11 | default "224.0.0.0" 12 | help 13 | IP address to send log output to 14 | endmenu -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # UDP Logging for esp32 2 | 3 | ## How To 4 | 5 | Just include the component into your project, include the header file and call udp_logging_init() 6 | 7 | #include "udp_logging.h" 8 | 9 | udp_logging_init( "myserver", "3333", udp_logging_vprintf ); 10 | 11 | On the server execute the logging_server.py file using Python v3: 12 | 13 | $ python3 logging_server.py 14 | 15 | ## License 16 | 17 | This code is licensed under the Apache License v2.0 18 | -------------------------------------------------------------------------------- /logging_server.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # Copyright 2017 by Malte Janduda 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | 18 | import socket 19 | import datetime 20 | 21 | UDP_IP = "0.0.0.0" 22 | UDP_PORT = 1337 23 | 24 | sock = socket.socket( socket.AF_INET, socket.SOCK_DGRAM ) 25 | sock.bind( (UDP_IP, UDP_PORT) ) 26 | 27 | print("+============================+") 28 | print("| ESP32 UDP Logging Server |") 29 | print("+============================+") 30 | print("") 31 | 32 | while True: 33 | data, addr = sock.recvfrom(1024) 34 | print(datetime.datetime.now(), data.decode(), end='') 35 | -------------------------------------------------------------------------------- /include/udp_logging.h: -------------------------------------------------------------------------------- 1 | // Copyright 2017 by Malte Janduda 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | #ifndef UDP_LOGGING_MAX_PAYLOAD_LEN 16 | #define UDP_LOGGING_MAX_PAYLOAD_LEN 2048 17 | #endif 18 | 19 | #ifdef __cplusplus 20 | extern "C" { 21 | #endif 22 | 23 | #include "esp_system.h" 24 | #include "esp_log.h" 25 | 26 | #include 27 | extern int udp_log_fd; 28 | 29 | int udp_logging_init(const char *node, const char *service, vprintf_like_t func); 30 | int udp_logging_vprintf( const char *str, va_list l ); 31 | void udp_logging_free(va_list l); 32 | 33 | #ifdef __cplusplus 34 | } 35 | #endif 36 | -------------------------------------------------------------------------------- /udp_logging.c: -------------------------------------------------------------------------------- 1 | // Copyright 2017 by Malte Janduda 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | #include "udp_logging.h" 16 | 17 | #include "esp_system.h" 18 | #include "esp_log.h" 19 | 20 | #include 21 | 22 | #include "lwip/err.h" 23 | #include "lwip/sockets.h" 24 | #include "lwip/sys.h" 25 | #include "lwip/netdb.h" 26 | #include "lwip/dns.h" 27 | #include "freertos/task.h" 28 | static const char *TAG = "udp_logging"; 29 | int udp_log_fd; 30 | static struct sockaddr serveraddr; 31 | static struct addrinfo hints; 32 | static uint8_t buf[UDP_LOGGING_MAX_PAYLOAD_LEN]; 33 | 34 | int get_socket_error_code(int socket) 35 | { 36 | int result; 37 | u32_t optlen = sizeof(int); 38 | if (getsockopt(socket, SOL_SOCKET, SO_ERROR, &result, &optlen) == -1) 39 | { 40 | printf("getsockopt failed"); 41 | return -1; 42 | } 43 | return result; 44 | } 45 | 46 | int show_socket_error_reason(int socket) 47 | { 48 | int err = get_socket_error_code(socket); 49 | printf("UDP socket error %d %s", err, strerror(err)); 50 | return err; 51 | } 52 | 53 | void udp_logging_free(va_list l) 54 | { 55 | if (udp_log_fd != 0) 56 | { 57 | int err = 0; 58 | char *err_buf; 59 | esp_log_set_vprintf(vprintf); 60 | if ((err = shutdown(udp_log_fd, 2)) == 0) 61 | { 62 | vprintf("\nUDP socket shutdown!", l); 63 | } 64 | else 65 | { 66 | asprintf(&err_buf, "\nShutting-down UDP socket failed: %d!\n", err); 67 | vprintf(err_buf, l); 68 | } 69 | 70 | if ((err = close(udp_log_fd)) == 0) 71 | { 72 | vprintf("\nUDP socket closed!", l); 73 | } 74 | else 75 | { 76 | asprintf(&err_buf, "\n Closing UDP socket failed: %d!\n", err); 77 | vprintf(err_buf, l); 78 | } 79 | udp_log_fd = 0; 80 | } 81 | } 82 | 83 | int udp_logging_vprintf(const char *str, va_list l) 84 | { 85 | int err = 0; 86 | int len; 87 | char task_name[16]; 88 | char *cur_task = pcTaskGetName(xTaskGetCurrentTaskHandle()); 89 | strncpy(task_name, cur_task, 16); 90 | task_name[15] = 0; 91 | if (strncmp(task_name, "tiT", 16) != 0) 92 | { 93 | len = vsprintf((char *)buf, str, l); 94 | if ((err = sendto(udp_log_fd, buf, len, 0, (struct sockaddr *)&serveraddr, sizeof(serveraddr))) < 0) 95 | { 96 | show_socket_error_reason(udp_log_fd); 97 | vprintf("\nFreeing UDP Logging. sendto failed!\n", l); 98 | udp_logging_free(l); 99 | return vprintf("UDP Logging freed!\n\n", l); 100 | } 101 | } 102 | return vprintf(str, l); 103 | } 104 | 105 | int udp_logging_init(const char *node, const char *service, vprintf_like_t func) 106 | { 107 | struct timeval send_timeout = {1, 0}; 108 | udp_log_fd = 0; 109 | ESP_LOGI(TAG, "initializing udp logging..."); 110 | 111 | memset(&hints, 0, sizeof(hints)); 112 | hints.ai_flags = AI_V4MAPPED; 113 | hints.ai_socktype = SOCK_DGRAM; 114 | struct addrinfo *res; 115 | sa_family_t family = AF_INET; 116 | int rc = getaddrinfo(node, service, &hints, &res); 117 | if (rc != 0) 118 | { 119 | ESP_LOGI(TAG, "Host not found! (%s)", node); 120 | } 121 | memcpy(&serveraddr, res->ai_addr, sizeof(serveraddr)); 122 | family = res->ai_addr->sa_family; 123 | freeaddrinfo(res); 124 | if ((udp_log_fd = socket(family, SOCK_DGRAM, 0)) < 0) 125 | { 126 | ESP_LOGE(TAG, "Cannot open socket!"); 127 | return -1; 128 | } 129 | 130 | ESP_LOGI(TAG, "Logging to %s", node); 131 | 132 | int err = setsockopt(udp_log_fd, SOL_SOCKET, SO_SNDTIMEO, (const char *)&send_timeout, sizeof(send_timeout)); 133 | if (err < 0) 134 | { 135 | ESP_LOGE("UDP_LOGGING", "Failed to set SO_SNDTIMEO. Error %d", err); 136 | } 137 | 138 | esp_log_set_vprintf(func); 139 | 140 | return 0; 141 | } 142 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------