telraam-rs

Telraam 是一种通过人们在家放置 IOT 设备来收集街道数据的系统。它提供了关于各种交通方式（包括机动车、自行车、行人等）的关键数据。Telraam 网络可以帮助创造交通规划者、当地政府和受影响最严重的社区（即居住和使用这些街道的市民）之间的对话机会：通过将交通计数变成一个开放和可访问的公民科学项目。

本项目是一个用于访问 Telraam 网络捕获数据的库和 CLI。它旨在收集数据，然后可以将其存储在另一个系统中进行分析。请随时提出任何可以改进的建议，或为此项目做出贡献。

入门

本项目需要 Rust 工具链，使用 rustup 安装，或系统包管理器。

从当前发布的版本安装

这将安装来自 Crate.io 公共 Rust 软件包管理器的当前发布包

> cargo install --features=clap --bin telraam telraam-rs

从源代码工作

克隆此仓库

> git clone https://github.com/radical-bike-lobby/telraam-rs.git

注意，以下一系列命令假定您的当前工作目录位于 telraam-rs，即 cd telraam-rs

运行测试

> cargo test --all-features

使用 cargo run 命令直接从项目运行

> cargo run --features=clap -- --help

这也可以从源代码安装

> cargo install --features=clap --path . --bin telraam

运行命令

所有命令均来自 Telraam 文档。您需要登录到您的 Telraam 账户并获取 API 令牌： https://telraam.net/en/admin/mijn-eigen-telraam/tokens

telraam CLI将从环境变量TELRAAM_TOKEN中读取此内容，或者从参数-${TELRAAM_TOKEN}中读取。建议使用环境变量，因为这不会导致令牌出现在日志或shell历史记录中。

使用welcome命令测试您的令牌和CLI是否正常工作，

> telraam welcome
msg = hello! Telraam server 2.0 is up and running

运行时，所有telraam选项都必须遵循--，使用cargo run，

> cargo run --features=clap -- welcome
    Finished dev [unoptimized + debuginfo] target(s) in 0.39s
     Running `target/debug/telraam welcome`
msg = hello! Telraam server 2.0 is up and running

对于其他选项，请使用help

> telraam --help

一些命令有自己的参数

> telraam traffic --help

输出

所有输出目前都是json格式，格式是API中定义的内联类型，如traffic中的报告列表，请参阅traffic文档。

贡献

该项目采用MIT许可。请随意贡献。

让我们共同努力，让我们的街道更安全！