{"id":18147438,"url":"https://github.com/thestaticturtle/esphome_syslog","last_synced_at":"2025-04-14T19:20:20.869Z","repository":{"id":43907585,"uuid":"337727110","full_name":"TheStaticTurtle/esphome_syslog","owner":"TheStaticTurtle","description":"A simple syslog component for esphome","archived":false,"fork":false,"pushed_at":"2024-08-06T17:50:06.000Z","size":30,"stargazers_count":68,"open_issues_count":6,"forks_count":25,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-13T18:17:13.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheStaticTurtle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-10T13:07:51.000Z","updated_at":"2025-03-24T15:22:50.000Z","dependencies_parsed_at":"2025-01-16T00:11:48.945Z","dependency_job_id":"fa3ddd66-af56-436f-9a40-cf9f53e975a4","html_url":"https://github.com/TheStaticTurtle/esphome_syslog","commit_stats":{"total_commits":18,"total_committers":4,"mean_commits":4.5,"dds":0.2222222222222222,"last_synced_commit":"6cab1982b9122404abc0441a16ae4a3da40909aa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheStaticTurtle%2Fesphome_syslog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheStaticTurtle%2Fesphome_syslog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheStaticTurtle%2Fesphome_syslog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheStaticTurtle%2Fesphome_syslog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheStaticTurtle","download_url":"https://codeload.github.com/TheStaticTurtle/esphome_syslog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248943428,"owners_count":21186958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-01T22:06:33.137Z","updated_at":"2025-04-14T19:20:20.833Z","avatar_url":"https://github.com/TheStaticTurtle.png","language":"C++","readme":"# esphome_syslog\n\nA simple syslog component for esphome. The component is designed to auto attach itself to the logger core module (like the MQTT component does with the `log_topic`)\n\nThis component uses the https://github.com/arcao/Syslog library version 2.0 at its core\n\n## How to\n\n### Manually\nTo install, locate your `esphome` folder, create a folder named `custom_components` got into it and execute \n```shell\ngit clone https://github.com/TheStaticTurtle/esphome_syslog.git\nmv esphome_syslog/components/syslog .\nrm -rf esphome_syslog\n```\n### YAML\n```yaml\nexternal_components:\n  - source: github://TheStaticTurtle/esphome_syslog\n    components: [syslog]\n```\n\n### Configuration\nSimply add this to the configuration of your esphome node: \n```yaml\nsyslog:\n```\n\nWhen used like this, the component will simply **broadcast its log to everyone on the network** to change this behavior you can add the `ip_address` and `port` option like this:\n```yaml\nsyslog:\n    ip_address: \"192.168.1.53\"\n    port: 514\n```\n\nDefault behavior strips the esphome color tags from the log (The `033[0;xxx` and the `#033[0m`) if you do not want this set the `strip_colors` option to `False`.\n\nDefault behavior also sets `enable_logger` to `True` if you wish to disable sending logger messages and only use the `syslog.log` action you can do so by setting it to `False`:\n\nThe action `syslog.log` has 3 settings:\n```yaml\nthen:\n    - syslog.log:\n        level: 7\n        tag: \"custom_action\"\n        payload: \"My log message\"\n```\n\nDue to the differences in log levels of syslog and esphome I had to translate them, here is a table:\n| Esphome level                  | Syslog level |\n|--------------------------------|--------------|\n| ESPHOME_LOG_LEVEL_NONE         | LOG_EMERG    |\n| ESPHOME_LOG_LEVEL_ERROR        | LOG_ERR      |\n| ESPHOME_LOG_LEVEL_WARN         | LOG_WARNING  |\n| ESPHOME_LOG_LEVEL_INFO         | LOG_INFO     |\n| ESPHOME_LOG_LEVEL_CONFIG       | LOG_NOTICE   |\n| ESPHOME_LOG_LEVEL_DEBUG        | LOG_DEBUG    |\n| ESPHOME_LOG_LEVEL_VERBOSE      | LOG_DEBUG    |\n| ESPHOME_LOG_LEVEL_VERY_VERBOSE | LOG_DEBUG    |\n\nThis table is however open to discussion as it's my interpretation, if you want to change it you can do so in the `syslog_component.cpp` file and change the array at line 22\n\n## Warning\nThis component should not break anything and should work with everything however if it doesn't please open an issue. \nI have successfully tested this component with an esp8266 and an esp32. BUT The esp32 seems to have issue when there is a lot of thing to send very fast which you can see turing boot when it prints the config, see [my comment in issue #7](https://github.com/TheStaticTurtle/esphome_syslog/issues/7#issuecomment-1236194816) for more details . \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthestaticturtle%2Fesphome_syslog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthestaticturtle%2Fesphome_syslog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthestaticturtle%2Fesphome_syslog/lists"}