provident 0.3.1

Unofficial client for the Provident (MeterConnex) utility metering portal: meters, usage history, and reports
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

// SPDX-License-Identifier: GPL-3.0-only

use std::collections::VecDeque;

use crate::http::Request;
use crate::models::api::internal::meter_tree::{
    Meter, TreeNode, get_children, get_parent_tree, root_nodes,
};
use crate::models::common::{MeterId, NodeId};

use super::Account;
use crate::Result;

impl Account {
    /// Every metering point visible to this account, in tree order.
    ///
    /// Reads the whole meter tree: the top two levels in one request, then one request per
    /// group the server left unexpanded.
    #[maybe_async::maybe_async]
    pub async fn meters(&self) -> Result<Vec<Meter>> {
        let request = Request::get(root_nodes::PATH)
            .query(&root_nodes::RootNodesRequest::default())?
            .build();
        let mut pending: VecDeque<TreeNode> = self
            .http
            .send::<root_nodes::RootNodesResponse>(request)
            .await?
            .into();

        let mut meters = Vec::new();
        while let Some(node) = pending.pop_front() {
            if node.meter_id().is_some() {
                meters.push(Meter::try_from(&node)?);
            } else if let Some(group_id) = node.group_id().filter(|_| node.has_unloaded_children())
            {
                let request = Request::get(get_children::PATH)
                    .query(&get_children::GetChildrenRequest { group_id })?
                    .build();
                let children = self
                    .http
                    .send::<get_children::GetChildrenResponse>(request)
                    .await?;
                pending.extend(children);
            }
        }
        Ok(meters)
    }

    /// The account's meter with this id, if any.
    #[maybe_async::maybe_async]
    pub async fn meter(&self, id: MeterId) -> Result<Option<Meter>> {
        let meters = self.meters().await?;
        Ok(meters.into_iter().find(|meter| meter.id == id))
    }

    /// The account's meter with this serial number ("Meter #", e.g. `23166694-2`), if any.
    #[maybe_async::maybe_async]
    pub async fn meter_by_serial(&self, serial: &str) -> Result<Option<Meter>> {
        let meters = self.meters().await?;
        Ok(meters.into_iter().find(|meter| meter.serial == serial))
    }

    /// Groups above `node`, root-first (organization, site, floor, …, the account's group).
    /// Use [`TreeNode::is_site`] to find the building.
    #[maybe_async::maybe_async]
    pub async fn location(&self, node: impl Into<NodeId>) -> Result<Vec<TreeNode>> {
        let request = Request::get(get_parent_tree::PATH)
            .query(&get_parent_tree::GetParentTreeRequest {
                node_id: node.into(),
            })?
            .build();
        Ok(self
            .http
            .send::<get_parent_tree::GetParentTreeResponse>(request)
            .await?)
    }
}