fundamentum-sdk-api 0.3.0

HTTP client targeting Fundamentum IoT devices RestAPI
Documentation 
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

<p align="left">
    <a href="https://crates.io/crates/fundamentum-sdk-api"><img src="https://img.shields.io/crates/v/fundamentum-sdk-api.svg" alt="Crates.io"></a>
    <a href="https://docs.rs/fundamentum-sdk-api"><img src="https://docs.rs/fundamentum-sdk-api/badge.svg" alt="Docs.rs"></a>
</p>

# Fundamentum SDK API

Rust HTTP client targeting Fundamentum IoT devices RestAPI.

Here are some references to the official documentation for the targeted
RestAPI:

- [Production API latest][prod-api-latest-swagger]
- [Develop API latest][dev-api-latest-swagger]

[prod-api-latest-swagger]: https://devices.fundamentum-iot.com/api/v3/docs/
[dev-api-latest-swagger]: https://devices.fundamentum-iot-dev.com/api/v3/docs/

## Getting Started

To get started with the SDK, you'll need to install Rust. You can follow the
instructions on the official Rust website: [Install
Rust](https://www.rust-lang.org/tools/install).

### Example

```rust
use fundamentum_sdk_api::client::{
    api_version::V3,
    config::{ApiConfig, ClientConfig},
    sdk_api::SdkApi,
};

#[tokio::main]
async fn main() {
    let client_config = ClientConfig {
        base_path: "http://devices-gateway.fundamentum.test".to_owned(),
        ..ClientConfig::default()
    };

    let api_config = ApiConfig {
        project_id: 1,
        region_id: 2,
        registry_id: 3,
        access_token: "access_token".to_owned(),
    };

    let api: SdkApi<V3> = SdkApi::new(client_config, &api_config);
    api.status().await.unwrap();
}
```

## Development setup

Please see the [development setup guide](doc/development-setup.md).

## License

Licensed under Apache License, Version 2.0 [LICENSE](LICENSE)