spaceapi-server 0.3.1

A library that allows you to easily implement a Space API server.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Rust Space API Implementation

[![Build Status](https://img.shields.io/travis/coredump-ch/spaceapi-server-rs/master.svg)](https://travis-ci.org/coredump-ch/spaceapi-server-rs)
[![Test Coverage](https://img.shields.io/coveralls/coredump-ch/spaceapi-server-rs/master.svg)](https://coveralls.io/github/coredump-ch/spaceapi-server-rs)
[![Crates.io Version](https://img.shields.io/crates/v/spaceapi-server.svg)](https://crates.io/crates/spaceapi-server)
[![Crates.io Downloads](https://img.shields.io/crates/d/spaceapi-server.svg)](https://crates.io/crates/spaceapi-server)
[![Dependency Status](https://dependencyci.com/github/coredump-ch/spaceapi-server-rs/badge)](https://dependencyci.com/github/coredump-ch/spaceapi-server-rs)
[![Clippy Linting Result](https://clippy.bashy.io/github/coredump-ch/spaceapi-server-rs/master/badge.svg)](https://clippy.bashy.io/github/coredump-ch/spaceapi-server-rs/master/log)

This is a library that allows an easy implementation of a
[SpaceAPI](http://spaceapi.net/) v0.13 server in Rust.

- Crate Documentation: https://coredump-ch.github.io/spaceapi-server-rs/
- Space API Reference: http://spaceapi.net/documentation


## Usage

See the `examples` directory or our
[Status-Project](https://github.com/coredump-ch/status) for reference.

To run the examples from the project directory:

    $ cargo run --example simple


## Datastores

### Redis

To use the redis storage start the redis server:

    $ redis-server

(...or start it using your favorite init daemon.)

You can access the database with the `redis-cli` tool:

    % redis-cli
    127.0.0.1:6379> SET people_present 1
    OK
    127.0.0.1:6379> GET people_present
    "1"
    127.0.0.1:6379> KEYS *
    1) "people_present"

The values depend on your sensors configuration.


## Docs

You can build docs with `make docs`. Find them in the `target/doc/` directory.

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.