LIONK

❯ Connecting components made easy!

🔗 Table of Contents

• 📍 Overview
• 👾 Features
• 🧩 Example
• 📂 Repository Structure
• 🧩 Modules
• 🚀 Getting Started
  • 📦 Deployment
  • 🤖 Usage
• 📌 Project Roadmap
• 🤝 Contributing
• 🛠️ Contributing Guidelines
• 🎗 License

📍 Overview

👀 Problem

Managing a diverse set of home and industrial components in an integrated and efficient manner is challenging. Existing solutions often lack flexibility, requiring significant customization and redevelopment when integrating new components. This inflexibility can lead to increased costs and reduced system efficiency.

Additionally, many existing systems are not designed to handle real-time data exchange and monitoring efficiently, leading to delays and potential errors in critical operations. There is also a need for a secure, user-friendly interface that allows administrators and operators to supervise and control the system easily.

🚀 Solution

Lionk Core is a modular platform developed in .NET designed to enable the management and integration of various components through plugins. The project is crafted to cater to end users (operators and administrators) as well as plugin developers, offering maximum flexibility and extensibility. The primary goal is to enhance the quality of life in home environments by allowing seamless integration and management of various components.

The application provides a web interface for configuring components and visualizing data. Users can easily add new plugins to define additional components. The application is published as a Docker image for easy deployment, with each release also publishing new NuGet packages to facilitate plugin development.

Full project description

👾 Features

• Dashboard Data Consultation: Users can add component views to the dashboard to continuously monitor component-specific data through an up-to-date dashboard.
• Alarm Management: Users receive notifications for system failures or specific component alerts.
• Remote Access: The application is accessible remotely via a web browser.
• Application Configuration: Administrators can configure the application, add or remove components, and link components together.
• Plugin Integration: Administrators can integrate, activate, or deactivate third-party plugins.
• User Management: Administrators can manage users and roles within the application.
• Plugin Development: Developers have access to comprehensive documentation and SDKs for creating compatible plugins.
• Cyclical Execution: The application supports cyclical execution of components, enabling them to run at specified intervals automatically.

🧩 Example

Use Case: Home heating system management.

• Energy Storage: Administrators can manage energy storage from a living room chimney.
• Temperature Optimization: The system optimizes heat flow based on storage temperatures using a 3-way valve.
• Auto-Regulation: The system auto-regulates based on the chimney's temperature.
• System Alerts: Notifications are sent if the system fails or if temperatures exceed certain thresholds.

📂 Repository Structure

└── lionk/
    ├── LICENSE.txt
    ├── README.md
    ├── docs/
    │   ├── analysis/             # Contains all documentation related to analysis.
    │   ├── best-practices/       # Contains best practices used in the development of the app.
    │   ├── deployment/           # Contains guides for deploying the app.
    │   └── project-description.md  # General description of the project.
    └── src/
        ├── lionk.sln             # Visual Studio solution file for the Lionk project.
        ├── app/                  # Contains the Visual Studio project files for the Lionk app.
        ├── lib/                  # Contains subfolders for each module.
        ├── test/                 # Contains all unit tests.
        ├── resources/            # Contains project resources such as logs, etc.
        ├── Directory.Build.Props # MSBuild properties for all projects in the solution.
        ├── .editorconfig         # Configuration for coding style and conventions.
        ├── stylecop.json         # StyleCop settings for enforcing code style rules.
        └── DockerFile            # Dockerfile for building the Lionk app.

🧩 Modules

This repo hosts all the software bricks making up our framework. Here's a brief description of each of them. The source code can be found in src/Lib.

🚀 Getting Started

📦 Deployment

To see how to deploy the application, please refer to the deployment guide: Deployment guide.

For a full documentation on how to deploy the application on a raspberry with GPIO enable see Rpi guide

Some basic plugins for raspberry can be found here

🤖 Usage

To see how to use the application, please refer to the user guide: User guide.

📌 Project Roadmap

• [X] Task 1: Deploy version 1.0.0.
• [ ] Task 2: Manage issue and fix bugs.
• [ ] Task 3: Implement Time series data logging and exportation.
• [ ] Task 4: Implement new notification channels.
• [ ] Task 5: Implement plugins repository to simplify the plugin download process.
• [ ] Task 6: TBD

🤝 Contributing

We welcome contributions! Here are several ways you can contribute to the project:

• Report Issues: Submit bug reports or feature requests for the Lionk project.
• Submit Pull Requests: Review open PRs and submit your own to improve the codebase.
• Develop New Plugins: Develop your own plugins and implement the components of your choice!

Please refer to the Contributing Guidelines to learn how to contribute effectively.

You can find the complete documentation of the code here.

Contributor Graph

🎗 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.