Create a hello, world project for the FixedIT Data Agent #24
Conversation
WalkthroughReplaced root README TOC with markdown-toc markers; added Server-side Dashboards and expanded Edge Device examples including a Hello, World and timelapse S3 example with diagrams and images. Added Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant Device as Edge Device
participant Telegraf
participant Output as Stdout (JSON)
Note over User,Device: Deploy "Hello, World!" example
User->>Device: Upload `project-hello-world/config.conf`
Device->>Telegraf: Start with env (SYNC_INTERVAL_SECONDS, TELEGRAF_DEBUG)
rect rgba(150,200,255,0.12)
Telegraf->>Telegraf: Schedule exec input (global interval)
Telegraf->>Telegraf: Schedule exec input (5s override)
Telegraf-->>Output: Emit JSON-formatted "Hello, World!" metrics
end
Note over Telegraf,Output: Repeats per configured intervals
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
Emojis break the links to a section of the README. Using custom anchors does not work with autogeneration.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
project-hello-world/README.md (1)
156-179: Consider more precise wording.The phrase "every now and then" on line 179 is somewhat informal and imprecise. Consider using "periodically" or "at the configured intervals" for more technical precision.
Apply this diff:
-You should now see some internal Telegraf logs on `stderr` and the JSON messages with the "Hello, World!" string appearing every now and then on `stdout`. +You should now see some internal Telegraf logs on `stderr` and the JSON messages with the "Hello, World!" string appearing periodically on `stdout`.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
project-hello-world/.images/bundled-configs.pngis excluded by!**/*.pngproject-hello-world/.images/config-page.pngis excluded by!**/*.pngproject-hello-world/.images/influxdb.pngis excluded by!**/*.pngproject-hello-world/.images/logs-page.pngis excluded by!**/*.pngproject-hello-world/.images/settings.pngis excluded by!**/*.png
📒 Files selected for processing (3)
README.md(2 hunks)project-hello-world/README.md(1 hunks)project-hello-world/config.conf(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
project-*/**
⚙️ CodeRabbit configuration file
project-*/**: Each example project for the FixedIT Data Agent should be self-contained and designed as a standalone example / tutorial showing how to use the FixedIT Data Agent. The project should be well documented and include all the necessary files to run the example. A reader should be able to understand the background and the purpose of the project, and be able to understand the implementation details and how to use it. If the project includes a dashboard, it should be placed in a new folder in the repo-root/dashboard-deployments/ directory instead of being included in the project folder. In the README for the project, the first time the FixedIT Data Agent is mentioned, we should link to the product page: https://fixedit.ai/products-data-agent/ Emphasize that these solutions are accessible to system integrators and IT professionals without requiring complex C/C++ ACAP development. Highlight that custom edge intelligence can be implemented using familiar IT tools (configuration files, shell scripts, REST APIs) rather than traditional embedded programming approaches. Note that bash does not exist on the Axis devices, so .sh scripts should be written in portable shell syntax.
README Structure: All project README files should follow the standardized template at.project_readme_template.md. This template ensures consistent documentation that serves both audiences: (1) IT professionals who want plug-and-play solutions, and (2) developers who want to customize and extend the examples. The template enforces a logical structure: 1) Introduction and background (project purpose, how it works, why choose this approach) 2) Technical explanation and quick start guide (compatibility, setup, troubleshooting) 3) Developer-oriented notes (local testing, implementation details)
Key README Requirements: - Include compatibility sections for both AXIS OS and FixedIT Data Agent versions - Explain host testing and its limitations and why certain parts require actual Axis d...
Files:
project-hello-world/config.confproject-hello-world/README.md
**/*
⚙️ CodeRabbit configuration file
This repository serves FixedIT Data Agent users across a spectrum from plug-and-play dashboard deployment to advanced edge device customization. Consider whether changes maintain accessibility for both DevOps professionals (server-side focus) and developers (edge customization focus). If new features are added or existing ones changed significantly, ensure documentation clearly explains the intended audience and usage level. We use prettier for formatting of common file formats like markdown, yaml, json, etc. Example projects should be placed in the repo-root in a directory named project-*/. Whenever referencing Axis device model names like "D4100-VE mk II" or "M3045", prefix it with "AXIS" in capital letters (e.g. "AXIS D4100-VE mk II"). When using Axis as a company name, use "Axis Communications", note that all-caps is only used when "AXIS" is used in their product names, not their company name. When using the name of an Axis product, google on the name to verify that it is correctly identified. Avoid using 'cameras' or 'Axis cameras' unless the solution in related to visual analytics, otherwise prefer using 'Axis devices' to show that the FixedIT Data Agent also works with strobes, speakers, door stations, etc. Images used for the README should be placed in a directory called .images/ in the affected project folder. These images might also be referred to from other sources like the top-level README.md file.
Files:
project-hello-world/config.confREADME.mdproject-hello-world/README.md
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation files should clearly communicate the dual audience: (1) server-side dashboard users who want to keep agent with bundled configs, and (2) edge device developers who want to customize agent behavior. Ensure examples and instructions are appropriate for the intended skill level and use case. Since this is a public repository, we should not include any sensitive information, the instructions should be easily understandable for a wide audience, and we should avoid using any jargon or technical terms that are not commonly used.
Anchor Links: For headings that contain Unicode characters (emojis, special characters) or backticks, use HTML anchor tags to ensure consistent linking behavior across different platforms (GitHub, VS Code, etc.). Add a separate line with<a id="anchor-name"></a>before the heading, and update the table of contents to reference this manual anchor.
Files:
README.mdproject-hello-world/README.md
🪛 LanguageTool
project-hello-world/README.md
[grammar] ~30-~30: There might be a mistake here.
Context: ...ight green: Input nodes / data ingestion - Red: Output nodes / notifications - Ligh...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...tion - Red: Output nodes / notifications - Light gray: Configuration data ## Why C...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...Contents - Compatibility - [AXIS OS Compatibility](#axis-os-compatib...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ompatibility) - AXIS OS Compatibility - [FixedIT Data Agent Compatibility](#fixed...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...y) - FixedIT Data Agent Compatibility - Quick Setup - [Files](#fi...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...data-agent-compatibility) - Quick Setup - Files - [Configuration Details]...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...) - Quick Setup - Files - [Configuration Details](#configuration-de...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...Files - Configuration Details - [Running the Example Together with the De...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...e Together with the Default Config Files](#running-the-example-together-with-the-default-config-files) - [Local Testing on Host](#local-testing-on...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...t-config-files) - Local Testing on Host - Prerequisites - [Test...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ocal-testing-on-host) - Prerequisites - Test Commands <!-- toc...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...IS OS version**: No special requirements - Required tools: None ### FixedIT Data...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...y - Minimum Data Agent version: 1.1 - Required features: `SYNC_INTERVAL_SECO...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...utton next to the "Bundled config files" in the "Configuration" tab of the FixedI...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...the global interval (default 60 seconds) - Another message every 5 seconds ![Logs ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...g components: 1. Input Configurations - Global interval input: Uses the exec inp...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...rval override 2. Output Configuration - Uses the file output plugin configured t...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... format is set to "json" 3. Data Flow - By default, all intputs are connected to...
(QB_NEW_EN)
[grammar] ~118-~118: Ensure spelling is correct
Context: ... 3. Data Flow - By default, all intputs are connected to all outputs. ## Runni...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~124-~124: Ensure spelling is correct
Context: ...ot of output in the "Logs" tab. This is beacuse your new "output everything to stdout" ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~179-~179: Consider an alternative to strengthen your wording.
Context: ...th the "Hello, World!" string appearing every now and then on stdout.
(EVERY_NOW_AND_THEN)
🪛 markdownlint-cli2 (0.18.1)
README.md
9-9: Link fragments should be valid
(MD051, link-fragments)
11-11: Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (12)
project-hello-world/config.conf (4)
4-19: LGTM! Clear agent configuration.The global agent settings are well-documented with helpful comments explaining how users can configure these values through the FixedIT Data Agent UI.
27-40: LGTM! Well-configured first input.The exec input with global interval is correctly configured with appropriate data format settings and clear documentation.
45-61: LGTM! Interval override demonstrates key concept.The second input effectively demonstrates how to override the global interval for specific inputs, which is a valuable learning point for users.
70-78: LGTM! Output configuration is appropriate.The stdout JSON output is perfect for a Hello World example, allowing users to easily see the results in the Logs tab.
README.md (2)
7-15: Verify TOC anchor links match manual HTML anchors.The dynamic TOC block generates URL-encoded anchor links (e.g.,
#%F0%9F%93%8A-server-side-dashboards), but manual HTML anchors are defined at lines 17 and 29 using plain IDs (e.g.,<a id="server-side-dashboards"></a>).Verify that the TOC generation tool correctly resolves these links to the manual anchors. If not, the TOC links may not work correctly on all platforms.
Test the links by clicking them in your preview or checking the generated TOC output.
35-56: LGTM! Excellent Hello World introduction.The new section provides a clear, concise introduction to the Hello World project with a helpful Mermaid diagram that visually explains the workflow. The color-coded diagram makes it easy to understand the data flow.
project-hello-world/README.md (6)
1-8: LGTM! Clear introduction and explanation.The opening effectively introduces the Hello World concept and explains how the two inputs work with different intervals. The explanation of the stdout output capture is clear and helpful.
9-33: LGTM! Excellent visual diagram with color scheme guide.The Mermaid flowchart provides a clear visual representation of the workflow, and the color scheme legend helps readers understand the diagram conventions. This is a great touch for educational documentation.
34-39: LGTM! Strong value proposition.This section effectively communicates the key benefit—enabling edge workflows without C/C++ ACAP development, making it accessible to IT professionals. This aligns perfectly with the coding guidelines' emphasis on accessibility.
57-68: LGTM! Comprehensive compatibility information.The compatibility section clearly specifies AXIS OS requirements (none) and FixedIT Data Agent version requirements (1.1 for
SYNC_INTERVAL_SECONDS), which helps users quickly determine if they can use this example.
69-100: LGTM! Excellent step-by-step quick setup.The setup instructions are clear, well-illustrated with screenshots, and include helpful explanations of what users should observe. The reconfiguration step (step 4) is particularly valuable as it teaches users how to modify the behavior.
130-154: LGTM! Excellent advanced diagram showing all-to-all connections.The diagram effectively illustrates how all inputs connect to all outputs when bundled configs are enabled, using color coding to distinguish between bundled (blue) and new (red) components. This helps users understand Telegraf's default behavior.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation files should clearly communicate the dual audience: (1) server-side dashboard users who want to keep agent with bundled configs, and (2) edge device developers who want to customize agent behavior. Ensure examples and instructions are appropriate for the intended skill level and use case. Since this is a public repository, we should not include any sensitive information, the instructions should be easily understandable for a wide audience, and we should avoid using any jargon or technical terms that are not commonly used.
Anchor Links: For headings that contain Unicode characters (emojis, special characters) or backticks, use HTML anchor tags to ensure consistent linking behavior across different platforms (GitHub, VS Code, etc.). Add a separate line with<a id="anchor-name"></a>before the heading, and update the table of contents to reference this manual anchor.
Files:
README.md
**/*
⚙️ CodeRabbit configuration file
This repository serves FixedIT Data Agent users across a spectrum from plug-and-play dashboard deployment to advanced edge device customization. Consider whether changes maintain accessibility for both DevOps professionals (server-side focus) and developers (edge customization focus). If new features are added or existing ones changed significantly, ensure documentation clearly explains the intended audience and usage level. We use prettier for formatting of common file formats like markdown, yaml, json, etc. Example projects should be placed in the repo-root in a directory named project-*/. Whenever referencing Axis device model names like "D4100-VE mk II" or "M3045", prefix it with "AXIS" in capital letters (e.g. "AXIS D4100-VE mk II"). When using Axis as a company name, use "Axis Communications", note that all-caps is only used when "AXIS" is used in their product names, not their company name. When using the name of an Axis product, google on the name to verify that it is correctly identified. Avoid using 'cameras' or 'Axis cameras' unless the solution in related to visual analytics, otherwise prefer using 'Axis devices' to show that the FixedIT Data Agent also works with strobes, speakers, door stations, etc. Images used for the README should be placed in a directory called .images/ in the affected project folder. These images might also be referred to from other sources like the top-level README.md file.
Files:
README.md
🪛 LanguageTool
README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... - Server-side Dashboards - [System Monitoring with InfluxDB2 and Gra...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...em Monitoring with InfluxDB2 and Grafana](#system-monitoring-with-influxdb2-and-grafana) - [Edge Device Customization](#edge-device-...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...nd-grafana) - Edge Device Customization - Hello, World! - [Creati...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...device-customization) - Hello, World! - [Creating a Timelapse with AWS S3 Upload]...
(QB_NEW_EN)
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
project-hello-world/README.md(1 hunks)project-hello-world/config.conf(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- project-hello-world/config.conf
🧰 Additional context used
📓 Path-based instructions (3)
project-*/**
⚙️ CodeRabbit configuration file
project-*/**: Each example project for the FixedIT Data Agent should be self-contained and designed as a standalone example / tutorial showing how to use the FixedIT Data Agent. The project should be well documented and include all the necessary files to run the example. A reader should be able to understand the background and the purpose of the project, and be able to understand the implementation details and how to use it. If the project includes a dashboard, it should be placed in a new folder in the repo-root/dashboard-deployments/ directory instead of being included in the project folder. In the README for the project, the first time the FixedIT Data Agent is mentioned, we should link to the product page: https://fixedit.ai/products-data-agent/ Emphasize that these solutions are accessible to system integrators and IT professionals without requiring complex C/C++ ACAP development. Highlight that custom edge intelligence can be implemented using familiar IT tools (configuration files, shell scripts, REST APIs) rather than traditional embedded programming approaches. Note that bash does not exist on the Axis devices, so .sh scripts should be written in portable shell syntax.
README Structure: All project README files should follow the standardized template at.project_readme_template.md. This template ensures consistent documentation that serves both audiences: (1) IT professionals who want plug-and-play solutions, and (2) developers who want to customize and extend the examples. The template enforces a logical structure: 1) Introduction and background (project purpose, how it works, why choose this approach) 2) Technical explanation and quick start guide (compatibility, setup, troubleshooting) 3) Developer-oriented notes (local testing, implementation details)
Key README Requirements: - Include compatibility sections for both AXIS OS and FixedIT Data Agent versions - Explain host testing and its limitations and why certain parts require actual Axis d...
Files:
project-hello-world/README.md
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation files should clearly communicate the dual audience: (1) server-side dashboard users who want to keep agent with bundled configs, and (2) edge device developers who want to customize agent behavior. Ensure examples and instructions are appropriate for the intended skill level and use case. Since this is a public repository, we should not include any sensitive information, the instructions should be easily understandable for a wide audience, and we should avoid using any jargon or technical terms that are not commonly used.
Anchor Links: For headings that contain Unicode characters (emojis, special characters) or backticks, use HTML anchor tags to ensure consistent linking behavior across different platforms (GitHub, VS Code, etc.). Add a separate line with<a id="anchor-name"></a>before the heading, and update the table of contents to reference this manual anchor.
Files:
project-hello-world/README.md
**/*
⚙️ CodeRabbit configuration file
This repository serves FixedIT Data Agent users across a spectrum from plug-and-play dashboard deployment to advanced edge device customization. Consider whether changes maintain accessibility for both DevOps professionals (server-side focus) and developers (edge customization focus). If new features are added or existing ones changed significantly, ensure documentation clearly explains the intended audience and usage level. We use prettier for formatting of common file formats like markdown, yaml, json, etc. Example projects should be placed in the repo-root in a directory named project-*/. Whenever referencing Axis device model names like "D4100-VE mk II" or "M3045", prefix it with "AXIS" in capital letters (e.g. "AXIS D4100-VE mk II"). When using Axis as a company name, use "Axis Communications", note that all-caps is only used when "AXIS" is used in their product names, not their company name. When using the name of an Axis product, google on the name to verify that it is correctly identified. Avoid using 'cameras' or 'Axis cameras' unless the solution in related to visual analytics, otherwise prefer using 'Axis devices' to show that the FixedIT Data Agent also works with strobes, speakers, door stations, etc. Images used for the README should be placed in a directory called .images/ in the affected project folder. These images might also be referred to from other sources like the top-level README.md file.
Files:
project-hello-world/README.md
🪛 LanguageTool
project-hello-world/README.md
[grammar] ~30-~30: There might be a mistake here.
Context: ...ight green: Input nodes / data ingestion - Red: Output nodes / notifications - Ligh...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...tion - Red: Output nodes / notifications - Light gray: Configuration data ## Why C...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...Contents - Compatibility - [AXIS OS Compatibility](#axis-os-compatib...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ompatibility) - AXIS OS Compatibility - [FixedIT Data Agent Compatibility](#fixed...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...y) - FixedIT Data Agent Compatibility - Quick Setup - [Files](#fi...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...data-agent-compatibility) - Quick Setup - Files - [Configuration Details]...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...) - Quick Setup - Files - [Configuration Details](#configuration-de...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...Files - Configuration Details - [Running the Example Together with the De...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...e Together with the Default Config Files](#running-the-example-together-with-the-default-config-files) - [Local Testing on Host](#local-testing-on...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...t-config-files) - Local Testing on Host - Prerequisites - [Test...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ocal-testing-on-host) - Prerequisites - Test Commands <!-- toc...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...IS OS version**: No special requirements - Required tools: None ### FixedIT Data...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...y - Minimum Data Agent version: 1.1 - Required features: `SYNC_INTERVAL_SECO...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...utton next to the "Bundled config files" in the "Configuration" tab of the FixedI...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...the global interval (default 60 seconds) - Another message every 5 seconds ![Logs ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...g components: 1. Input Configurations - Global interval input: Uses the exec inp...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...rval override 2. Output Configuration - Uses the file output plugin configured t...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... format is set to "json" 3. Data Flow - By default, all inputs are connected to ...
(QB_NEW_EN)
[style] ~179-~179: Consider an alternative to strengthen your wording.
Context: ...th the "Hello, World!" string appearing every now and then on stdout.
(EVERY_NOW_AND_THEN)
daniel-falk
force-pushed
the
hello-world-project
branch
from
26818a8 to
fb345d6
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
project-hello-world/README.md (1)
34-39: Consider explicitly mentioning IT tools for stronger accessibility message.While the current text effectively communicates that no C/C++ ACAP development is required, the coding guidelines suggest explicitly mentioning the familiar IT tools (configuration files, shell scripts, REST APIs). This would strengthen the value proposition for the target audience of system integrators and IT professionals.
Consider adding a sentence like:
With the FixedIT Data Agent, you can create your own edge-based workflows and automations that run directly in the Axis devices. You can do this without knowing anything about the Axis ACAP SDK, C and C++ programming. This makes the edge available to a much wider audience of developers, system integrators and IT professionals. + +Instead of traditional embedded programming, you can implement custom edge intelligence using familiar IT tools like configuration files, shell scripts, and REST APIs—all running directly on Axis devices for seamless deployment.As per coding guidelines
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.coderabbit.yaml(1 hunks)project-hello-world/README.md(1 hunks)project-hello-world/config.conf(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
project-*/**
⚙️ CodeRabbit configuration file
project-*/**: Each example project for the FixedIT Data Agent should be self-contained and designed as a standalone example / tutorial showing how to use the FixedIT Data Agent. The project should be well documented and include all the necessary files to run the example. A reader should be able to understand the background and the purpose of the project, and be able to understand the implementation details and how to use it. If the project includes a dashboard, it should be placed in a new folder in the repo-root/dashboard-deployments/ directory instead of being included in the project folder. In the README for the project, the first time the FixedIT Data Agent is mentioned, we should link to the product page: https://fixedit.ai/products-data-agent/ Emphasize that these solutions are accessible to system integrators and IT professionals without requiring complex C/C++ ACAP development. Highlight that custom edge intelligence can be implemented using familiar IT tools (configuration files, shell scripts, REST APIs) rather than traditional embedded programming approaches. Note that bash does not exist on the Axis devices, so .sh scripts should be written in portable shell syntax.
README Structure: All project README files should follow the standardized template at.project_readme_template.md. This template ensures consistent documentation that serves both audiences: (1) IT professionals who want plug-and-play solutions, and (2) developers who want to customize and extend the examples. The template enforces a logical structure: 1) Introduction and background (project purpose, how it works, why choose this approach) 2) Technical explanation and quick start guide (compatibility, setup, troubleshooting) 3) Developer-oriented notes (local testing, implementation details)
Key README Requirements: - Include compatibility sections for both AXIS OS and FixedIT Data Agent versions - Explain host testing and its limitations and why certain parts require actual Axis d...
Files:
project-hello-world/config.confproject-hello-world/README.md
**/*
⚙️ CodeRabbit configuration file
This repository serves FixedIT Data Agent users across a spectrum from plug-and-play dashboard deployment to advanced edge device customization. Consider whether changes maintain accessibility for both DevOps professionals (server-side focus) and developers (edge customization focus). If new features are added or existing ones changed significantly, ensure documentation clearly explains the intended audience and usage level. We use prettier for formatting of common file formats like markdown, yaml, json, etc. Example projects should be placed in the repo-root in a directory named project-*/. Whenever referencing Axis device model names like "D4100-VE mk II" or "M3045", prefix it with "AXIS" in capital letters (e.g. "AXIS D4100-VE mk II"). When using Axis as a company name, use "Axis Communications", note that all-caps is only used when "AXIS" is used in their product names, not their company name. When using the name of an Axis product, google on the name to verify that it is correctly identified. Avoid using 'cameras' or 'Axis cameras' unless the solution in related to visual analytics, otherwise prefer using 'Axis devices' to show that the FixedIT Data Agent also works with strobes, speakers, door stations, etc. Images used for the README should be placed in a directory called .images/ in the affected project folder. These images might also be referred to from other sources like the top-level README.md file.
Files:
project-hello-world/config.confproject-hello-world/README.md
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation files should clearly communicate the dual audience: (1) server-side dashboard users who want to keep agent with bundled configs, and (2) edge device developers who want to customize agent behavior. Ensure examples and instructions are appropriate for the intended skill level and use case. Since this is a public repository, we should not include any sensitive information, the instructions should be easily understandable for a wide audience, and we should avoid using any jargon or technical terms that are not commonly used.
Headings should not include special characters like emojis or backticks. The table of contents should be generated with themarkdown-toctool, meaning that we should use the<!-- toc -->and<!-- tocstop -->tags.
Files:
project-hello-world/README.md
🧠 Learnings (3)
📚 Learning: 2025-08-07T15:23:05.927Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#5
File: project-strobe-color-from-github-workflow/README.md:57-62
Timestamp: 2025-08-07T15:23:05.927Z
Learning: In the fixedit-ai/fixedit-data-agent-examples repository, when GitHub generates anchors for headings that contain backticks with spaces around them (like `### `filename` - Description`), it removes the backticks but preserves those spaces as dashes in the anchor, creating triple dashes (---) between the filename and description parts. TOC generators may not handle this correctly and need manual adjustment.
Applied to files:
.coderabbit.yaml
📚 Learning: 2025-10-15T11:33:37.022Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#24
File: README.md:31-34
Timestamp: 2025-10-15T11:33:37.022Z
Learning: In the fixedit-ai/fixedit-data-agent-examples repository, prefer automatic TOC generation using `<!-- toc
Applied to files:
.coderabbit.yaml
📚 Learning: 2025-10-15T11:36:24.077Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#24
File: project-hello-world/README.md:156-179
Timestamp: 2025-10-15T11:36:24.077Z
Learning: The hello-world project (project-hello-world) for the FixedIT Data Agent has no differences between host and device behavior. It works identically on both because it only uses basic echo commands and standard Telegraf features.
Applied to files:
project-hello-world/README.md
🪛 LanguageTool
project-hello-world/README.md
[grammar] ~30-~30: There might be a mistake here.
Context: ...ight green: Input nodes / data ingestion - Red: Output nodes / notifications - Ligh...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...tion - Red: Output nodes / notifications - Light gray: Configuration data ## Why C...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...Contents - Compatibility - [AXIS OS Compatibility](#axis-os-compatib...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ompatibility) - AXIS OS Compatibility - [FixedIT Data Agent Compatibility](#fixed...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...y) - FixedIT Data Agent Compatibility - Quick Setup - [Files](#fi...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...data-agent-compatibility) - Quick Setup - Files - [Configuration Details]...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...) - Quick Setup - Files - [Configuration Details](#configuration-de...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...Files - Configuration Details - [Running the Example Together with the De...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...e Together with the Default Config Files](#running-the-example-together-with-the-default-config-files) - [Local Testing on Host](#local-testing-on...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...t-config-files) - Local Testing on Host - Prerequisites - [Test...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ocal-testing-on-host) - Prerequisites - Test Commands <!-- toc...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...IS OS version**: No special requirements - Required tools: None ### FixedIT Data...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...y - Minimum Data Agent version: 1.1 - Required features: `SYNC_INTERVAL_SECO...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...utton next to the "Bundled config files" in the "Configuration" tab of the FixedI...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...the global interval (default 60 seconds) - Another message every 5 seconds ![Logs ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...g components: 1. Input Configurations - Global interval input: Uses the exec inp...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...rval override 2. Output Configuration - Uses the file output plugin configured t...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... format is set to "json" 3. Data Flow - By default, all inputs are connected to ...
(QB_NEW_EN)
[style] ~179-~179: Consider an alternative to strengthen your wording.
Context: ...th the "Hello, World!" string appearing every now and then on stdout.
(EVERY_NOW_AND_THEN)
🔇 Additional comments (8)
.coderabbit.yaml (1)
77-79: LGTM! Improved Markdown documentation guidelines.The updated guidance correctly mandates using
markdown-tocfor automatic TOC generation with<!-- toc -->and<!-- tocstop -->markers, and prohibits special characters in headings. This aligns well with the retrieved learnings and will ensure consistent documentation across the repository.Based on learnings
project-hello-world/config.conf (1)
1-78: LGTM! Well-structured and documented Telegraf configuration.The configuration demonstrates the core concepts clearly with two interval-based inputs and stdout JSON output. The comments provide helpful context about environment variables and plugin usage. Previous grammar issues have been addressed.
project-hello-world/README.md (6)
1-3: LGTM! Clear introduction with proper product link.The title and introduction are concise and correctly link to the FixedIT Data Agent product page on the first mention, as required by the coding guidelines.
9-26: LGTM! Excellent visual explanation with Mermaid diagram.The diagram clearly illustrates the data flow from inputs through to stdout output, with an intuitive color scheme. The legend helps readers understand the visual language used throughout the documentation.
42-55: LGTM! Proper TOC structure with markdown-toc markers.The table of contents correctly uses
<!-- toc -->and<!-- tocstop -->markers as mandated by the updated guidelines in.coderabbit.yaml. The anchor links are properly formatted without special characters.
57-67: LGTM! Clear compatibility requirements.The compatibility sections provide specific version requirements for both AXIS OS and the FixedIT Data Agent, including the required
SYNC_INTERVAL_SECONDSenvironment variable feature.
69-100: LGTM! Comprehensive quick setup guide with helpful screenshots.The step-by-step instructions are clear and easy to follow, with relevant screenshots for each step. The configuration of environment variables is well-explained with expected outcomes.
156-179: LGTM! Appropriate local testing guidance.The local testing section provides clear prerequisites and test commands. Based on the retrieved learning, this hello-world project works identically on both host and device since it only uses basic echo commands and standard Telegraf features, so no additional limitations documentation is needed here.
Based on learnings
project-hello-world/README.md
Outdated
| ### FixedIT Data Agent Compatibility | ||
|
|
||
| - **Minimum Data Agent version**: 1.1 | ||
| - **Required features**: `SYNC_INTERVAL_SECONDS` environment variable (added in version 1.1). |
There was a problem hiding this comment.
I think for Required features, it makes more sense to mention the associated input parameter itself (SyncIntervalSeconds) rather than the environment variable
There was a problem hiding this comment.
Not sure I agree here since the dependency is on the actual variable. That's what you will see if you look in the config files. Where this environment variable comes from is less important than that it needs to exist. Therefore, I think it might be more confusing to reference the settings field than the variable. What do you think?
daniel-falk
force-pushed
the
hello-world-project
branch
from
fb345d6 to
b6cbb5e
Compare
🎨 Code Formatting RequiredPrettier Formatting IssuesSome files need to be formatted with Prettier (JSON, YAML, Markdown). Files that need prettier formatting:
To fix prettier issues: npx prettier@3.6.0 --write "**/*.{json,yml,yaml,md}" ".github/**/*.{json,yml,yaml,md}" ".*.{yml,yaml,json,md}" --ignore-unknownAfter fixing:
|
daniel-falk
force-pushed
the
hello-world-project
branch
from
b6cbb5e to
304a8a8
Compare
🎨 Code Formatting RequiredPrettier Formatting IssuesSome files need to be formatted with Prettier (JSON, YAML, Markdown). Files that need prettier formatting:
To fix prettier issues: npx prettier@3.6.0 --write "**/*.{json,yml,yaml,md}" ".github/**/*.{json,yml,yaml,md}" ".*.{yml,yaml,json,md}" --ignore-unknownAfter fixing:
|
daniel-falk
force-pushed
the
hello-world-project
branch
from
304a8a8 to
4651367
Compare
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.coderabbit.yaml(1 hunks)README.md(3 hunks)project-hello-world/README.md(1 hunks)project-hello-world/config.conf(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- project-hello-world/config.conf
🧰 Additional context used
📓 Path-based instructions (3)
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Documentation files should clearly communicate the dual audience: (1) server-side dashboard users who want to keep agent with bundled configs, and (2) edge device developers who want to customize agent behavior. Ensure examples and instructions are appropriate for the intended skill level and use case. Since this is a public repository, we should not include any sensitive information, the instructions should be easily understandable for a wide audience, and we should avoid using any jargon or technical terms that are not commonly used.
Headings should not include special characters like emojis or backticks. The table of contents should be generated with themarkdown-toctool, meaning that we should use the<!-- toc -->and<!-- tocstop -->tags.
Files:
README.mdproject-hello-world/README.md
**/*
⚙️ CodeRabbit configuration file
This repository serves FixedIT Data Agent users across a spectrum from plug-and-play dashboard deployment to advanced edge device customization. Consider whether changes maintain accessibility for both DevOps professionals (server-side focus) and developers (edge customization focus). If new features are added or existing ones changed significantly, ensure documentation clearly explains the intended audience and usage level. We use prettier for formatting of common file formats like markdown, yaml, json, etc. Example projects should be placed in the repo-root in a directory named project-*/. Whenever referencing Axis device model names like "D4100-VE mk II" or "M3045", prefix it with "AXIS" in capital letters (e.g. "AXIS D4100-VE mk II"). When using Axis as a company name, use "Axis Communications", note that all-caps is only used when "AXIS" is used in their product names, not their company name. When using the name of an Axis product, google on the name to verify that it is correctly identified. Avoid using 'cameras' or 'Axis cameras' unless the solution in related to visual analytics, otherwise prefer using 'Axis devices' to show that the FixedIT Data Agent also works with strobes, speakers, door stations, etc. Images used for the README should be placed in a directory called .images/ in the affected project folder. These images might also be referred to from other sources like the top-level README.md file.
Files:
README.mdproject-hello-world/README.md
project-*/**
⚙️ CodeRabbit configuration file
project-*/**: Each example project for the FixedIT Data Agent should be self-contained and designed as a standalone example / tutorial showing how to use the FixedIT Data Agent. The project should be well documented and include all the necessary files to run the example. A reader should be able to understand the background and the purpose of the project, and be able to understand the implementation details and how to use it. If the project includes a dashboard, it should be placed in a new folder in the repo-root/dashboard-deployments/ directory instead of being included in the project folder. In the README for the project, the first time the FixedIT Data Agent is mentioned, we should link to the product page: https://fixedit.ai/products-data-agent/ Emphasize that these solutions are accessible to system integrators and IT professionals without requiring complex C/C++ ACAP development. Highlight that custom edge intelligence can be implemented using familiar IT tools (configuration files, shell scripts, REST APIs) rather than traditional embedded programming approaches. Note that bash does not exist on the Axis devices, so .sh scripts should be written in portable shell syntax.
README Structure: All project README files should follow the standardized template at.project_readme_template.md. This template ensures consistent documentation that serves both audiences: (1) IT professionals who want plug-and-play solutions, and (2) developers who want to customize and extend the examples. The template enforces a logical structure: 1) Introduction and background (project purpose, how it works, why choose this approach) 2) Technical explanation and quick start guide (compatibility, setup, troubleshooting) 3) Developer-oriented notes (local testing, implementation details)
Key README Requirements: - Include compatibility sections for both AXIS OS and FixedIT Data Agent versions - Explain host testing and its limitations and why certain parts require actual Axis d...
Files:
project-hello-world/README.md
🧠 Learnings (3)
📚 Learning: 2025-08-07T15:23:05.927Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#5
File: project-strobe-color-from-github-workflow/README.md:57-62
Timestamp: 2025-08-07T15:23:05.927Z
Learning: In the fixedit-ai/fixedit-data-agent-examples repository, when GitHub generates anchors for headings that contain backticks with spaces around them (like `### `filename` - Description`), it removes the backticks but preserves those spaces as dashes in the anchor, creating triple dashes (---) between the filename and description parts. TOC generators may not handle this correctly and need manual adjustment.
Applied to files:
.coderabbit.yamlREADME.md
📚 Learning: 2025-10-15T11:33:37.022Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#24
File: README.md:31-34
Timestamp: 2025-10-15T11:33:37.022Z
Learning: In the fixedit-ai/fixedit-data-agent-examples repository, prefer automatic TOC generation using `<!-- toc
Applied to files:
.coderabbit.yamlREADME.md
📚 Learning: 2025-10-15T11:36:24.077Z
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-data-agent-examples#24
File: project-hello-world/README.md:156-179
Timestamp: 2025-10-15T11:36:24.077Z
Learning: The hello-world project (project-hello-world) for the FixedIT Data Agent has no differences between host and device behavior. It works identically on both because it only uses basic echo commands and standard Telegraf features.
Applied to files:
project-hello-world/README.md
🪛 LanguageTool
README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... - Server-side Dashboards - [System Monitoring with InfluxDB2 and Gra...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...em Monitoring with InfluxDB2 and Grafana](#system-monitoring-with-influxdb2-and-grafana) - [Edge Device Customization Examples](#edg...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...a) - Edge Device Customization Examples - Hello, World! - [Creati...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...stomization-examples) - Hello, World! - [Creating a Timelapse with AWS S3 Upload]...
(QB_NEW_EN)
project-hello-world/README.md
[grammar] ~30-~30: There might be a mistake here.
Context: ...ight green: Input nodes / data ingestion - Red: Output nodes / notifications - Ligh...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...tion - Red: Output nodes / notifications - Light gray: Configuration data ## Why C...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...Contents - Compatibility - [AXIS OS Compatibility](#axis-os-compatib...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ompatibility) - AXIS OS Compatibility - [FixedIT Data Agent Compatibility](#fixed...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...y) - FixedIT Data Agent Compatibility - Quick Setup - [Files](#fi...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...data-agent-compatibility) - Quick Setup - Files - [Configuration Details]...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...) - Quick Setup - Files - [Configuration Details](#configuration-de...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...Files - Configuration Details - [Running the Example Together with the De...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...e Together with the Default Config Files](#running-the-example-together-with-the-default-config-files) - [Local Testing on Host](#local-testing-on...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...t-config-files) - Local Testing on Host - Prerequisites - [Test...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ocal-testing-on-host) - Prerequisites - Test Commands <!-- toc...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...IS OS version**: No special requirements - Required tools: None ### FixedIT Data...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...y - Minimum Data Agent version: 1.1 - Required features: `SYNC_INTERVAL_SECO...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...utton next to the "Bundled config files" in the "Configuration" tab of the FixedI...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...the global interval (default 60 seconds) - Another message every 5 seconds ![Logs ...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...DS` variable. 2. Output Configuration - Uses the file output plugin configured t...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... format is set to "json" 3. Data Flow - By default, all inputs are connected to ...
(QB_NEW_EN)
[style] ~179-~179: Consider an alternative to strengthen your wording.
Context: ...th the "Hello, World!" string appearing every now and then on stdout.
(EVERY_NOW_AND_THEN)
This PR adds a new easy to follow example that will introduce the basic concepts of the FixedIT Data Agent.
This PR also removes the emojis in the section titles of the main README since they break the autogenerated table-of-content.
Summary by CodeRabbit