esp-idf-matter 0.1.0

Run rs-matter on Espressif chips with ESP IDF
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! This module provides the ESP IDF NVS implementation of the `KvBlobStore` trait for storing and loading BLOBs.

use core::fmt::Write;

use esp_idf_svc::nvs::{EspNvs, EspNvsPartition, NvsPartitionId};
use esp_idf_svc::sys::EspError;

use log::{debug, trace};

use rs_matter_stack::matter::error::Error;
use rs_matter_stack::matter::persist::KvBlobStore;

use crate::error::to_persist_error;

type SKey = heapless::String<5>;

/// A `KvBlobStore`` implementation that uses the ESP IDF NVS API
/// to store and load the BLOBs.
///
/// NOTE: Not async (yet)
pub struct EspKvBlobStore<T>(EspNvs<T>)
where
    T: NvsPartitionId;

impl<T> EspKvBlobStore<T>
where
    T: NvsPartitionId,
{
    /// Create a new KV BLOB store instance that would persist in namespace `esp-idf-matter`.
    pub fn new_default(nvs: EspNvsPartition<T>) -> Result<Self, EspError> {
        Self::new(nvs, "esp-idf-matter")
    }

    /// Create a new KV BLOB store instance.
    pub fn new(nvs: EspNvsPartition<T>, namespace: &str) -> Result<Self, EspError> {
        Ok(Self(EspNvs::new(nvs, namespace, true)?))
    }

    fn load<'a>(&self, key: u16, buf: &'a mut [u8]) -> Result<Option<&'a [u8]>, Error> {
        let mut skey = SKey::new();

        let data = self
            .0
            .get_blob(Self::skey(&mut skey, key), buf)
            .map_err(to_persist_error)?;

        debug!("Blob {key}: loaded {:?} bytes", data.map(|data| data.len()));
        trace!(
            "Blob {key} load details: loaded {:?} bytes {data:?}",
            data.map(|data| data.len())
        );

        Ok(data)
    }

    fn store(&mut self, key: u16, data: &[u8]) -> Result<(), Error> {
        let mut skey = SKey::new();

        self.0
            .set_blob(Self::skey(&mut skey, key), data)
            .map_err(to_persist_error)?;

        debug!("Blob {key}: stored {} bytes", data.len());
        trace!(
            "Blob {key} store details: stored {} bytes {data:?}",
            data.len()
        );

        Ok(())
    }

    fn remove(&mut self, key: u16) -> Result<(), Error> {
        let mut skey = SKey::new();

        self.0
            .remove(Self::skey(&mut skey, key))
            .map_err(to_persist_error)?;

        debug!("Blob {key}: removed");

        Ok(())
    }

    fn skey(skey: &mut SKey, key: u16) -> &str {
        skey.clear();
        write!(skey, "{key:04x}").unwrap();

        skey.as_str()
    }
}

impl<T> KvBlobStore for EspKvBlobStore<T>
where
    T: NvsPartitionId,
{
    fn load<'a>(&mut self, key: u16, buf: &'a mut [u8]) -> Result<Option<&'a [u8]>, Error> {
        EspKvBlobStore::load(self, key, buf)
    }

    fn store(&mut self, key: u16, data: &[u8], _buf: &mut [u8]) -> Result<(), Error> {
        EspKvBlobStore::store(self, key, data)
    }

    fn remove(&mut self, key: u16, _buf: &mut [u8]) -> Result<(), Error> {
        EspKvBlobStore::remove(self, key)
    }
}