开源项目教程：EvoThings PhoneGap Estimote Beacons

开源项目教程：EvoThings PhoneGap Estimote Beacons

1. 项目目录结构及介绍

EvoThings的PhoneGap Estimote Beacons插件尽管已不再维护，但其结构仍可作为学习资源。以下是对项目主要目录和文件的一个概览：

• master分支：包含了最新但未指定版本的代码。
• examples/beacon-finder：一个示例应用，演示如何使用此插件寻找附近的Estimote Beacon。
  • README.md: 示例应用的说明文档。
• plugin/src：存放核心插件代码的目录，包括JavaScript与平台特定的原生代码（如Objective-C或Java）。
  • plugin.xml: 插件配置文件，定义插件元数据和依赖。
  • README.md, LICENSE.txt: 描述文件与许可协议。
  • *.java, *.m, *.h等: 分别是Android和iOS平台上的原生代码实现。
• gitignore: 指定Git应忽略的文件类型或文件夹。
• package.json: 若有，可能表示开发环境或构建工具的配置，但在该废弃仓库中未明确提及具体用途。

2. 项目的启动文件介绍

由于这是一个Cordova/PhoneGap插件，并不直接有一个“启动文件”如传统应用那样。然而，对于开发者来说，集成的关键通常开始于在主应用程序的配置文件(config.xml)中添加此插件以及在JavaScript环境中初始化对插件的使用。例如，在Cordova应用中，你可能会在onDeviceReady事件处理函数中引入插件功能，这是大多数Cordova应用的“启动逻辑”起点。

document.addEventListener('deviceready', onDeviceReady, false);

function onDeviceReady() {
    // 这里调用PhoneGap Estimote Beacons插件的相关方法
}

3. 项目的配置文件介绍

主要配置文件：plugin.xml

• 作用：这个文件是Cordova插件的核心配置文件，它定义了插件的元数据，包括名称、作者、版本，以及所需权限和平台特定的XML片段。
• 内容示例：

  <?xml version="1.0" encoding="UTF-8"?>
  <plugin id="..." version="...">
      <!-- 插件的详细信息 -->
      <name>Estimote Cordova/PhoneGap Plugin</name>
      <description>...description...</description>
      <!-- 平台相关的配置 -->
      <platform name="android">
          <!-- android平台的特殊配置 -->
      </platform>
      <platform name="ios">
          <!-- ios平台的特殊配置 -->
      </platform>
  </plugin>
  

其他配置相关：config.xml

虽然不直接属于插件本身，但对于使用该插件的应用程序而言，config.xml用于启用插件的功能。在你的应用程序的根目录下的config.xml添加如下行以安装此插件（虽然实际操作因项目不再维护而不可行）：

<gap:plugin name="phonegap-estimotebeacons" />

请注意，因为此项目已经不再维护，推荐考虑使用替代方案，如Peter Metz的cordova-plugin-ibeacon来支持Estimote beacon功能。