diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..973c104 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,133 @@ +Required Notice: Copyright Colin Jaques (https://github.com/CoJaques) + +# PolyForm Noncommercial License 1.0.0 + + + +## Acceptance + +In order to get any license under these terms, you must agree +to them as both strict obligations and conditions to all +your licenses. + +## Copyright License + +The licensor grants you a copyright license for the +software to do everything you might do with the software +that would otherwise infringe the licensor's copyright +in it for any permitted purpose. However, you may +only distribute the software according to [Distribution +License](#distribution-license) and make changes or new works +based on the software according to [Changes and New Works +License](#changes-and-new-works-license). + +## Distribution License + +The licensor grants you an additional copyright license +to distribute copies of the software. Your license +to distribute covers distributing the software with +changes and new works permitted by [Changes and New Works +License](#changes-and-new-works-license). + +## Notices + +You must ensure that anyone who gets a copy of any part of +the software from you also gets a copy of these terms or the +URL for them above, as well as copies of any plain-text lines +beginning with `Required Notice:` that the licensor provided +with the software. For example: + +> Required Notice: Copyright Yoyodyne, Inc. (http://example.com) + +## Changes and New Works License + +The licensor grants you an additional copyright license to +make changes and new works based on the software for any +permitted purpose. + +## Patent License + +The licensor grants you a patent license for the software that +covers patent claims the licensor can license, or becomes able +to license, that you would infringe by using the software. + +## Noncommercial Purposes + +Any noncommercial purpose is a permitted purpose. + +## Personal Uses + +Personal use for research, experiment, and testing for +the benefit of public knowledge, personal study, private +entertainment, hobby projects, amateur pursuits, or religious +observance, without any anticipated commercial application, +is use for a permitted purpose. + +## Noncommercial Organizations + +Use by any charitable organization, educational institution, +public research organization, public safety or health +organization, environmental protection organization, +or government institution is use for a permitted purpose +regardless of the source of funding or obligations resulting +from the funding. + +## Fair Use + +You may have "fair use" rights for the software under the +law. These terms do not limit them. + +## No Other Rights + +These terms do not allow you to sublicense or transfer any of +your licenses to anyone else, or prevent the licensor from +granting licenses to anyone else. These terms do not imply +any other licenses. + +## Patent Defense + +If you make any written claim that the software infringes or +contributes to infringement of any patent, your patent license +for the software granted under these terms ends immediately. If +your company makes such a claim, your patent license ends +immediately for work on behalf of your company. + +## Violations + +The first time you are notified in writing that you have +violated any of these terms, or done anything with the software +not covered by your licenses, your licenses can nonetheless +continue if you come into full compliance with these terms, +and take practical steps to correct past violations, within +32 days of receiving notice. Otherwise, all your licenses +end immediately. + +## No Liability + +***As far as the law allows, the software comes as is, without +any warranty or condition, and the licensor will not be liable +to you for any damages arising out of these terms or the use +or nature of the software, under any kind of legal claim.*** + +## Definitions + +The **licensor** is the individual or entity offering these +terms, and the **software** is the software the licensor makes +available under these terms. + +**You** refers to the individual or entity agreeing to these +terms. + +**Your company** is any legal entity, sole proprietorship, +or other kind of organization that you work for, plus all +organizations that have control over, are under the control of, +or are under common control with that organization. **Control** +means ownership of substantially all the assets of an entity, +or the power to direct its management and policies by vote, +contract, or otherwise. Control can be direct or indirect. + +**Your licenses** are all the licenses granted to you for the +software under these terms. + +**Use** means anything you do with the software requiring one +of your licenses. diff --git a/README.md b/README.md index 4740319..59334f7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # 🚀 DataAggregator -[![.NET 9](https://img.shields.io/badge/.NET-9.0-blueviolet?logo=dotnet&logoColor=white)](https://dotnet.microsoft.com/) -[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](https://www.docker.com/) -[![InfluxDB 3](https://img.shields.io/badge/InfluxDB-3.0-22ADF6?logo=influxdb&logoColor=white)](https://www.influxdata.com/) -[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-15-336791?logo=postgresql&logoColor=white)](https://www.postgresql.org/) +[![.NET 9](https://img.shields.io/badge/.NET-9.0-blueviolet?logo=dotnet&logoColor=white)](https://dotnet.microsoft.com/) +[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](https://www.docker.com/) +[![InfluxDB 3](https://img.shields.io/badge/InfluxDB-3.0-22ADF6?logo=influxdb&logoColor=white)](https://www.influxdata.com/) +[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-15-336791?logo=postgresql&logoColor=white)](https://www.postgresql.org/) -**DataAggregator** is a modular infrastructure for collecting, registering, and processing industrial data. +**DataAggregator** is a modular infrastructure for collecting, registering, and processing industrial data. It provides a flexible backbone to acquire machine signals, store them in time-series and relational databases, and run ML-based processing pipelines. It is designed to scale from a single machine to an entire plant, handling heterogeneous environments through dedicated collectors for each data source. Data can be visualized in real time using tools like Grafana or any custom frontend, while processing can run either at the edge or centrally. This enables the application of custom algorithms or ONNX-based models directly on the collected signals. @@ -41,7 +41,7 @@ DataAggregator/ │ ├─ DataAggregator.Collector.FileCollector/ # File-based collector for demo/testing │ ├─ DataAggregator.Registration/ # Registration service (ASP.NET Core) │ └─ DataAggregator.Processor/ # Processing service (ONNX models, ML logic) -├─ tests/ +├─ tests/ │ ├─ DataAggregator.Registration.Tests/ # Unit tests for Registration │ ├─ DataAggregator.Collector.Tests/ # Unit tests for Registration │ └─ DataAggregator.Processor.Tests/ # Unit tests for Processor @@ -51,13 +51,13 @@ DataAggregator/ ## 🌐 Related Repositories -- 🔧 **Deployment example (full stack with configs, Grafana, etc.)** +- 🔧 **Deployment example (full stack with configs, Grafana, etc.)** 👉 [DataAggregator-demo](https://github.com/CoJaques/DataAggregator-demo) -- 📊 **Model training & analysis pipeline** +- 📊 **Model training & analysis pipeline** 👉 [Data-analysis](https://github.com/CoJaques/Data-analysis) -- 🛠️ **OpenCN fork with connector support** (work in progress) +- 🛠️ **OpenCN fork with connector support** (work in progress) 👉 [OpenCN branch `cmctl-bufferization`](https://gitlab.com/CoJaques/opencn/-/tree/cmctl-bufferization?ref_type=heads) --- @@ -66,10 +66,10 @@ DataAggregator/ - **.NET 9** → Backend services (Collector, Registration, Processor) - **ML.NET** -> Data processing -- **Docker / Docker Compose** → Deployment & orchestration -- **InfluxDB v3** → Time-series data storage -- **PostgreSQL** → Relational storage & metadata -- **Grafana** (in demo repo) → Data visualization +- **Docker / Docker Compose** → Deployment & orchestration +- **InfluxDB v3** → Time-series data storage +- **PostgreSQL** → Relational storage & metadata +- **Grafana** (in demo repo) → Data visualization --- @@ -77,20 +77,29 @@ DataAggregator/ DataAggregator is built around a **modular and distributed architecture**: -- **Collector** → Acquires machine signals (e.g., currents from CNC drives) via OpenCN or file input. -- **Registration** → Manages device registration and configuration in PostgreSQL. -- **Processor** → Extracts features and runs ML inference (ONNX models) to classify machine states. -- **Databases** → InfluxDB v3 stores raw and processed signals; PostgreSQL stores device metadata. +- **Collector** → Acquires machine signals (e.g., currents from CNC drives) via OpenCN or file input. +- **Registration** → Manages device registration and configuration in PostgreSQL. +- **Processor** → Extracts features and runs ML inference (ONNX models) to classify machine states. +- **Databases** → InfluxDB v3 stores raw and processed signals; PostgreSQL stores device metadata. -This design ensures scalability across multiple machines and flexibility for integration with existing industrial setups. +This design ensures scalability across multiple machines and flexibility for integration with existing industrial setups. --- ## 🚀 Getting Started -👉 For a ready-to-use deployment example (including Docker setup, Grafana dashboards, and configs), check out: +👉 For a ready-to-use deployment example (including Docker setup, Grafana dashboards, and configs), check out: 📦 [**DataAggregator-demo**](https://github.com/CoJaques/DataAggregator-demo) +--- +## 📄 License + +This project is licensed under the PolyForm Noncommercial License 1.0.0. +See the [LICENSE](./LICENSE.txt) file for details. + +This project was developed as part of a Bachelor thesis and is published with permission. +Any commercial use is not permitted without prior discussion with the author. + --- `this readme was enhanced by AI to clean the formatting and structure the content`