Skip to main content

zwave_bridge/
config.rs

1//! The bridge's configuration file (TOML).
2
3use serde::Deserialize;
4use std::path::PathBuf;
5
6/// The whole configuration.
7#[derive(Debug, Clone, Deserialize)]
8#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
9#[serde(deny_unknown_fields)]
10pub struct Config {
11    /// The controller.
12    pub serial: Serial,
13    /// Where state lives.
14    #[serde(default)]
15    pub store: Store,
16    /// The broker.
17    #[serde(default)]
18    pub mqtt: Mqtt,
19    /// Home Assistant discovery.
20    #[serde(default)]
21    pub homeassistant: HomeAssistant,
22    /// Network behavior.
23    #[serde(default)]
24    pub network: Network,
25    /// The device library.
26    #[serde(default)]
27    pub devices: Devices,
28}
29
30/// Device configuration files in Z-Wave JS's format.
31#[derive(Debug, Clone, Default, Deserialize)]
32#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
33#[serde(deny_unknown_fields)]
34pub struct Devices {
35    /// The `config/devices` directory of an `@zwave-js/config` release.
36    #[serde(default)]
37    pub dir: Option<PathBuf>,
38}
39
40/// The controller's port.
41#[derive(Debug, Clone, Deserialize)]
42#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
43#[serde(deny_unknown_fields)]
44pub struct Serial {
45    /// A serial device (`/dev/ttyUSB0`, `/dev/serial/by-id/...`) or `tcp://host:port`.
46    pub port: String,
47}
48
49/// State on disk.
50#[derive(Debug, Clone, Deserialize)]
51#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
52#[serde(deny_unknown_fields)]
53pub struct Store {
54    /// Directory for `nodes.json`, `keys.json` and NVM backups.
55    #[serde(default = "default_dir")]
56    pub dir: PathBuf,
57}
58
59fn default_dir() -> PathBuf {
60    PathBuf::from("/var/lib/zwave-bridge")
61}
62
63impl Default for Store {
64    fn default() -> Self {
65        Store { dir: default_dir() }
66    }
67}
68
69/// The MQTT broker.
70#[derive(Debug, Clone, Deserialize)]
71#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
72#[serde(deny_unknown_fields)]
73pub struct Mqtt {
74    /// Host.
75    #[serde(default = "default_host")]
76    pub host: String,
77    /// Port.
78    #[serde(default = "default_port")]
79    pub port: u16,
80    /// Client id.
81    #[serde(default = "default_client_id")]
82    pub client_id: String,
83    /// User name.
84    #[serde(default)]
85    pub username: Option<String>,
86    /// Password.
87    #[serde(default)]
88    pub password: Option<String>,
89    /// A file holding the password (read at start), instead of `password`.
90    #[serde(default)]
91    pub password_file: Option<PathBuf>,
92    /// Topic prefix.
93    #[serde(default = "default_base")]
94    pub base_topic: String,
95    /// Keep-alive, seconds.
96    #[serde(default = "default_keep_alive")]
97    pub keep_alive: u64,
98}
99
100fn default_host() -> String {
101    "127.0.0.1".into()
102}
103fn default_port() -> u16 {
104    1883
105}
106fn default_client_id() -> String {
107    "zwave-bridge".into()
108}
109fn default_base() -> String {
110    "zwave".into()
111}
112fn default_keep_alive() -> u64 {
113    30
114}
115
116impl Default for Mqtt {
117    fn default() -> Self {
118        Mqtt {
119            host: default_host(),
120            port: default_port(),
121            client_id: default_client_id(),
122            username: None,
123            password: None,
124            password_file: None,
125            base_topic: default_base(),
126            keep_alive: default_keep_alive(),
127        }
128    }
129}
130
131/// Home Assistant MQTT discovery.
132#[derive(Debug, Clone, Deserialize)]
133#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
134#[serde(deny_unknown_fields)]
135pub struct HomeAssistant {
136    /// Publish discovery configs.
137    #[serde(default = "yes")]
138    pub enabled: bool,
139    /// Discovery prefix.
140    #[serde(default = "default_prefix")]
141    pub discovery_prefix: String,
142}
143
144fn yes() -> bool {
145    true
146}
147fn default_prefix() -> String {
148    "homeassistant".into()
149}
150
151impl Default for HomeAssistant {
152    fn default() -> Self {
153        HomeAssistant {
154            enabled: true,
155            discovery_prefix: default_prefix(),
156        }
157    }
158}
159
160/// Network behavior.
161#[derive(Debug, Clone, Deserialize)]
162#[cfg_attr(feature = "schema", derive(serde::Serialize, schemars::JsonSchema))]
163#[serde(deny_unknown_fields)]
164pub struct Network {
165    /// Wake-up interval configured on sleeping nodes, seconds.
166    #[serde(default = "default_wake")]
167    pub wake_up_interval: u32,
168    /// How long inclusion and exclusion wait for a node, seconds.
169    #[serde(default = "default_inclusion")]
170    pub inclusion_timeout: u64,
171}
172
173fn default_wake() -> u32 {
174    3600
175}
176fn default_inclusion() -> u64 {
177    60
178}
179
180impl Default for Network {
181    fn default() -> Self {
182        Network {
183            wake_up_interval: default_wake(),
184            inclusion_timeout: default_inclusion(),
185        }
186    }
187}
188
189impl Config {
190    /// Parses a configuration file's text.
191    pub fn parse(text: &str) -> Result<Config, String> {
192        toml::from_str(text).map_err(|e| e.to_string())
193    }
194}
195
196#[cfg(test)]
197mod tests {
198    use super::*;
199
200    #[test]
201    fn minimal_and_full() {
202        let c = Config::parse("[serial]\nport = \"/dev/ttyUSB0\"\n").unwrap();
203        assert_eq!(c.mqtt.base_topic, "zwave");
204        assert!(c.homeassistant.enabled);
205        let c = Config::parse(
206            "[serial]\nport = \"tcp://127.0.0.1:4545\"\n[store]\ndir = \"/tmp/z\"\n[mqtt]\nhost = \"broker\"\nport = 1884\nbase_topic = \"home/zwave\"\n[homeassistant]\nenabled = false\n[network]\nwake_up_interval = 7200\n",
207        )
208        .unwrap();
209        assert_eq!(
210            (
211                c.mqtt.port,
212                c.network.wake_up_interval,
213                c.homeassistant.enabled
214            ),
215            (1884, 7200, false)
216        );
217        assert!(Config::parse("[serial]\nport = \"x\"\nbogus = 1\n").is_err());
218    }
219}