cinnamon 1.0.3

A type-safe Nightscout client for Rust, aiming to simplify the interactions with the confusing Nightscout API.
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
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
use crate::client::NightscoutClient;
use crate::endpoints::Endpoint;
use crate::error::NightscoutError;
use serde::{Deserialize, Serialize};
use serde_json::Value;

pub struct StatusService {
    pub client: NightscoutClient,
}

impl StatusService {
    /// Retrieves the Nightscout server status, version, and settings.
    ///
    /// This is a "Direct Fetch" method. It does not use a query builder; calling this
    /// method immediately initiates the HTTP request.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use cinnamon::client::NightscoutClient;
    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = NightscoutClient::new("[https://ns.example.com](https://ns.example.com)")?;
    /// let status = client.status().get().await?;
    /// println!("Nightscout Version: {}", status.version);
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get(&self) -> Result<Status, NightscoutError> {
        let url = self.client.base_url.join(Endpoint::Status.as_path())?;
        self.client.fetch::<Status>(url).await
    }
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Status {
    pub status: String,
    #[allow(dead_code)]
    pub name: String,
    pub version: String,

    #[serde(rename = "serverTime")]
    pub server_time: String,

    #[serde(rename = "serverTimeEpoch")]
    pub server_time_epoch: i64,

    #[serde(rename = "apiEnabled")]
    pub api_enabled: bool,

    #[serde(rename = "careportalEnabled")]
    pub care_portal_enabled: bool,

    #[serde(rename = "boluscalcEnabled")]
    pub bolus_calc_enabled: bool,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<StatusSettings>,

    #[serde(
        default,
        rename = "extendedSettings",
        skip_serializing_if = "Option::is_none"
    )]
    pub extended_settings: Option<ExtendedSettings>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authorized: Option<bool>,

    #[serde(
        default,
        rename = "runtimeState",
        skip_serializing_if = "Option::is_none"
    )]
    pub runtime_state: Option<String>,

    #[serde(flatten)]
    pub extra: Value,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct StatusSettings {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub units: Option<String>,

    #[serde(
        default,
        rename = "timeFormat",
        skip_serializing_if = "Option::is_none"
    )]
    pub time_format: Option<i64>,

    #[serde(default, rename = "dayStart", skip_serializing_if = "Option::is_none")]
    pub day_start: Option<i64>,

    #[serde(default, rename = "dayEnd", skip_serializing_if = "Option::is_none")]
    pub day_end: Option<i64>,

    #[serde(default, rename = "nightMode", skip_serializing_if = "Option::is_none")]
    pub night_mode: Option<bool>,

    #[serde(default, rename = "editMode", skip_serializing_if = "Option::is_none")]
    pub edit_mode: Option<bool>,

    #[serde(default, rename = "showRawbg", skip_serializing_if = "Option::is_none")]
    pub show_rawbg: Option<String>,

    #[serde(
        default,
        rename = "customTitle",
        skip_serializing_if = "Option::is_none"
    )]
    pub custom_title: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub theme: Option<String>,

    #[serde(
        default,
        rename = "alarmUrgentHigh",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_urgent_high: Option<bool>,

    #[serde(
        default,
        rename = "alarmUrgentHighMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_urgent_high_mins: Option<Vec<i64>>,

    #[serde(default, rename = "alarmHigh", skip_serializing_if = "Option::is_none")]
    pub alarm_high: Option<bool>,

    #[serde(
        default,
        rename = "alarmHighMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_high_mins: Option<Vec<i64>>,

    #[serde(default, rename = "alarmLow", skip_serializing_if = "Option::is_none")]
    pub alarm_low: Option<bool>,

    #[serde(
        default,
        rename = "alarmLowMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_low_mins: Option<Vec<i64>>,

    #[serde(
        default,
        rename = "alarmUrgentLow",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_urgent_low: Option<bool>,

    #[serde(
        default,
        rename = "alarmUrgentLowMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_urgent_low_mins: Option<Vec<i64>>,

    #[serde(
        default,
        rename = "alarmUrgentMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_urgent_mins: Option<Vec<i64>>,

    #[serde(
        default,
        rename = "alarmWarnMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_warn_mins: Option<Vec<i64>>,

    #[serde(
        default,
        rename = "alarmTimeagoWarn",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_timeago_warn: Option<bool>,

    #[serde(
        default,
        rename = "alarmTimeagoWarnMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_timeago_warn_mins: Option<i64>,

    #[serde(
        default,
        rename = "alarmTimeagoUrgent",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_timeago_urgent: Option<bool>,

    #[serde(
        default,
        rename = "alarmTimeagoUrgentMins",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_timeago_urgent_mins: Option<i64>,

    #[serde(
        default,
        rename = "alarmPumpBatteryLow",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_pump_battery_low: Option<bool>,

    #[serde(default, rename = "baseURL", skip_serializing_if = "Option::is_none")]
    pub base_url: Option<String>,

    #[serde(
        default,
        rename = "authDefaultRoles",
        skip_serializing_if = "Option::is_none"
    )]
    pub auth_default_roles: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub language: Option<String>,

    #[serde(default, rename = "scaleY", skip_serializing_if = "Option::is_none")]
    pub scale_y: Option<String>,

    #[serde(
        default,
        rename = "showPlugins",
        skip_serializing_if = "Option::is_none"
    )]
    pub show_plugins: Option<String>,

    #[serde(
        default,
        rename = "showForecast",
        skip_serializing_if = "Option::is_none"
    )]
    pub show_forecast: Option<String>,

    #[serde(
        default,
        rename = "focusHours",
        skip_serializing_if = "Option::is_none"
    )]
    pub focus_hours: Option<i64>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub heartbeat: Option<i64>,

    #[serde(
        default,
        rename = "DEFAULT_FEATURES",
        skip_serializing_if = "Option::is_none"
    )]
    pub default_features: Option<Vec<String>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enable: Option<Vec<String>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub thresholds: Option<StatusThresholds>,

    #[serde(
        default,
        rename = "alarmTypes",
        skip_serializing_if = "Option::is_none"
    )]
    pub alarm_types: Option<Vec<String>>,

    #[serde(
        default,
        rename = "insecureUseHttp",
        skip_serializing_if = "Option::is_none"
    )]
    pub insecure_use_http: Option<bool>,

    #[serde(
        default,
        rename = "secureHstsHeader",
        skip_serializing_if = "Option::is_none"
    )]
    pub secure_hsts_header: Option<bool>,

    #[serde(
        default,
        rename = "secureHstsHeaderIncludeSubdomains",
        skip_serializing_if = "Option::is_none"
    )]
    pub secure_hsts_header_include_subdomains: Option<bool>,

    #[serde(
        default,
        rename = "secureHstsHeaderPreload",
        skip_serializing_if = "Option::is_none"
    )]
    pub secure_hsts_header_preload: Option<bool>,

    #[serde(default, rename = "secureCsp", skip_serializing_if = "Option::is_none")]
    pub secure_csp: Option<bool>,

    #[serde(
        default,
        rename = "deNormalizeDates",
        skip_serializing_if = "Option::is_none"
    )]
    pub de_normalize_dates: Option<bool>,

    #[serde(
        default,
        rename = "showClockDelta",
        skip_serializing_if = "Option::is_none"
    )]
    pub show_clock_delta: Option<bool>,

    #[serde(
        default,
        rename = "showClockLastTime",
        skip_serializing_if = "Option::is_none"
    )]
    pub show_clock_last_time: Option<bool>,

    #[serde(default, rename = "frameUrl1", skip_serializing_if = "Option::is_none")]
    pub frame_url_1: Option<String>,

    #[serde(default, rename = "frameUrl2", skip_serializing_if = "Option::is_none")]
    pub frame_url_2: Option<String>,

    #[serde(default, rename = "frameUrl3", skip_serializing_if = "Option::is_none")]
    pub frame_url_3: Option<String>,

    #[serde(default, rename = "frameUrl4", skip_serializing_if = "Option::is_none")]
    pub frame_url_4: Option<String>,

    #[serde(default, rename = "frameUrl5", skip_serializing_if = "Option::is_none")]
    pub frame_url_5: Option<String>,

    #[serde(default, rename = "frameUrl6", skip_serializing_if = "Option::is_none")]
    pub frame_url_6: Option<String>,

    #[serde(default, rename = "frameUrl7", skip_serializing_if = "Option::is_none")]
    pub frame_url_7: Option<String>,

    #[serde(default, rename = "frameUrl8", skip_serializing_if = "Option::is_none")]
    pub frame_url_8: Option<String>,

    #[serde(
        default,
        rename = "frameName1",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_1: Option<String>,

    #[serde(
        default,
        rename = "frameName2",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_2: Option<String>,

    #[serde(
        default,
        rename = "frameName3",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_3: Option<String>,

    #[serde(
        default,
        rename = "frameName4",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_4: Option<String>,

    #[serde(
        default,
        rename = "frameName5",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_5: Option<String>,

    #[serde(
        default,
        rename = "frameName6",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_6: Option<String>,

    #[serde(
        default,
        rename = "frameName7",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_7: Option<String>,

    #[serde(
        default,
        rename = "frameName8",
        skip_serializing_if = "Option::is_none"
    )]
    pub frame_name_8: Option<String>,

    #[serde(
        default,
        rename = "authFailDelay",
        skip_serializing_if = "Option::is_none"
    )]
    pub auth_fail_delay: Option<i64>,

    #[serde(
        default,
        rename = "adminNotifiesEnabled",
        skip_serializing_if = "Option::is_none"
    )]
    pub admin_notifies_enabled: Option<bool>,

    #[serde(
        default,
        rename = "authenticationPromptOnLoad",
        skip_serializing_if = "Option::is_none"
    )]
    pub authentication_prompt_on_load: Option<bool>,

    #[serde(flatten)]
    pub extra: Value,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct StatusThresholds {
    #[serde(default, rename = "bgHigh", skip_serializing_if = "Option::is_none")]
    pub bg_high: Option<i64>,

    #[serde(
        default,
        rename = "bgTargetTop",
        skip_serializing_if = "Option::is_none"
    )]
    pub bg_target_top: Option<i64>,

    #[serde(
        default,
        rename = "bgTargetBottom",
        skip_serializing_if = "Option::is_none"
    )]
    pub bg_target_bottom: Option<i64>,

    #[serde(default, rename = "bgLow", skip_serializing_if = "Option::is_none")]
    pub bg_low: Option<i64>,

    #[serde(flatten)]
    pub extra: Value,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct ExtendedSettings {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub devicestatus: Option<ExtendedDeviceStatusSettings>,

    #[serde(flatten)]
    pub extra: Value,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct ExtendedDeviceStatusSettings {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub advanced: Option<bool>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub days: Option<i64>,
}