Emoncms 项目安装与使用教程

1. 项目目录结构及介绍

Emoncms 是一个开源的能源数据处理、记录和可视化工具。其项目目录结构如下：

emoncms/
├── docs/
├── lib/
├── modules/
├── theme/
├── scripts/
├── tests/
├── .gitignore
├── .htaccess
├── .jshintrc
├── COPYRIGHT.txt
├── LICENSE.txt
├── SECURITY.md
├── composer.json
├── core.php
├── default-settings.ini
├── default-settings.php
├── default-emonpi-settings.php
├── emoncms_graphic.png
├── example-settings.ini
├── example-settings.php
├── index.php
├── locale.php
├── param.php
├── php-info.php
├── process_settings.php
├── readme.md
├── route.php
├── settings.env.ini
└── version.json

目录介绍

• docs/: 包含项目的文档文件。
• lib/: 包含项目依赖的库文件。
• modules/: 包含项目的各个模块，如 Graph、Dashboards、App 等。
• theme/: 包含项目的主题文件。
• scripts/: 包含项目的脚本文件，用于自动化任务等。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• .htaccess: Apache 服务器配置文件。
• .jshintrc: JavaScript 代码风格检查配置文件。
• COPYRIGHT.txt: 版权声明文件。
• LICENSE.txt: 项目许可证文件。
• SECURITY.md: 安全相关文档。
• composer.json: PHP 依赖管理配置文件。
• core.php: 项目核心文件。
• default-settings.ini: 默认配置文件。
• default-settings.php: 默认配置文件。
• default-emonpi-settings.php: 针对 EmonPi 设备的默认配置文件。
• emoncms_graphic.png: 项目图标文件。
• example-settings.ini: 示例配置文件。
• example-settings.php: 示例配置文件。
• index.php: 项目入口文件。
• locale.php: 多语言配置文件。
• param.php: 参数配置文件。
• php-info.php: PHP 信息文件。
• process_settings.php: 处理设置文件。
• readme.md: 项目自述文件。
• route.php: 路由配置文件。
• settings.env.ini: 环境配置文件。
• version.json: 项目版本信息文件。

2. 项目启动文件介绍

Emoncms 的启动文件是 index.php。该文件是项目的入口点，负责初始化项目并加载必要的配置和模块。

index.php 文件内容概述

• 加载配置文件: 加载 default-settings.php 和 settings.env.ini 等配置文件。
• 初始化核心模块: 加载 core.php 文件，初始化项目核心功能。
• 路由处理: 使用 route.php 文件处理请求路由。
• 模块加载: 根据配置加载各个模块，如 Graph、Dashboards、App 等。

3. 项目配置文件介绍

Emoncms 的配置文件主要位于项目根目录和 modules/ 目录中。以下是主要的配置文件及其作用：

主要配置文件

• default-settings.ini: 默认配置文件，包含数据库连接、缓存设置等。
• default-settings.php: PHP 格式的默认配置文件。
• settings.env.ini: 环境配置文件，用于不同环境的配置。
• route.php: 路由配置文件，定义 URL 与处理函数的映射关系。
• core.php: 核心配置文件，包含项目的基本设置和初始化代码。

模块配置文件

• modules/ 目录下的每个模块通常有自己的配置文件，例如 modules/graph/config.php 用于 Graph 模块的配置。

配置文件示例

; default-settings.ini 示例
[database]
host = "localhost"
username = "emoncms"
password = "password"
dbname = "emoncms"

[redis]
enabled = true
host = "localhost"
port = 6379

通过这些配置文件，用户可以自定义 Emoncms 的行为，如数据库连接、缓存设置、模块启用等。

---

以上是 Emoncms 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你顺利安装和使用 Emoncms 项目。