From 77be9483b00bdd57882be8e36f898076e46e93a5 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Sun, 2 Apr 2023 18:39:36 +0700 Subject: [PATCH 1/9] Rework PIR data and fetch status --- crates/core/src/bc/model.rs | 8 +-- crates/core/src/bc/xml.rs | 49 ++++++++++++++++++- .../src/bc_protocol/connection/udpsource.rs | 13 +++-- dissector/baichuan.lua | 3 ++ src/pir/cmdline.rs | 2 +- src/pir/mod.rs | 21 ++++++-- 6 files changed, 81 insertions(+), 15 deletions(-) diff --git a/crates/core/src/bc/model.rs b/crates/core/src/bc/model.rs index 141c84f..05de6e9 100644 --- a/crates/core/src/bc/model.rs +++ b/crates/core/src/bc/model.rs @@ -27,10 +27,6 @@ pub const MSG_ID_MOTION_REQUEST: u32 = 31; pub const MSG_ID_MOTION: u32 = 33; /// Version messages have this ID pub const MSG_ID_VERSION: u32 = 80; -/// Getting PIR status messages have this ID -pub const MSG_ID_GET_PIR_ALARM: u32 = 212; -/// Setting PIR status messages have this ID -pub const MSG_ID_START_PIR_ALARM: u32 = 213; /// Ping messages have this ID pub const MSG_ID_PING: u32 = 93; /// General system info messages have this ID @@ -45,6 +41,10 @@ pub const MSG_ID_TALK: u32 = 202; pub const MSG_ID_GET_LED_STATUS: u32 = 208; /// Setting the LED status is done with this ID pub const MSG_ID_SET_LED_STATUS: u32 = 209; +/// Getting PIR status messages have this ID +pub const MSG_ID_GET_PIR_ALARM: u32 = 212; +/// Setting PIR status messages have this ID +pub const MSG_ID_START_PIR_ALARM: u32 = 213; /// UDP Keep alive pub const MSG_ID_UDP_KEEP_ALIVE: u32 = 234; /// Battery message initiaed by the camera diff --git a/crates/core/src/bc/xml.rs b/crates/core/src/bc/xml.rs index add10c2..5a979e6 100644 --- a/crates/core/src/bc/xml.rs +++ b/crates/core/src/bc/xml.rs @@ -336,7 +336,54 @@ pub struct RfAlarmCfg { /// reduce False alarm boolean pub reduceFalseAlarm: u8, /// XML time block for all week days - pub timeBlockList: String, + #[yaserde(rename = "timeBlockList")] + pub time_block_list: TimeBlockList, + /// The alarm handle to attach to this Rf + #[yaserde(rename = "alarmHandle")] + pub alarm_handle: AlarmHandle, +} + +/// TimeBlockList XML +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +#[yaserde(rename = "timeBlockList")] +pub struct TimeBlockList { + /// List of time block entries which disable/enable the PIR at a time + #[yaserde(rename = "timeBlock")] + pub time_block: Vec, +} + +/// TimeBlock XML Used to set the time to enable/disable PIR dectection +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +#[yaserde(rename = "timeBlock")] +pub struct TimeBlock { + /// Whether to enable or disable for this time block + pub enable: u8, + /// The day of the week for this block + pub weekDay: String, + /// Time to start this block + #[yaserde(rename = "beginHour")] + pub begin_hour: u8, + /// Time to end this block + #[yaserde(rename = "endHour")] + pub end_hour: u8, +} + +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +/// AlarmHandle Xml +pub struct AlarmHandle { + /// Items in the alarm handle + pub item: Vec, +} + +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +/// An item in the alarm handle +#[yaserde(rename = "item")] +pub struct AlarmHandleItem { + /// The channel ID + pub channel: u8, + /// The handle type: Known values, comma seperated list of snap,rec,push + #[yaserde(rename = "handleType")] + pub handle_type: String, } /// TalkConfig xml diff --git a/crates/core/src/bc_protocol/connection/udpsource.rs b/crates/core/src/bc_protocol/connection/udpsource.rs index 3bc0ddc..3ab3733 100644 --- a/crates/core/src/bc_protocol/connection/udpsource.rs +++ b/crates/core/src/bc_protocol/connection/udpsource.rs @@ -253,12 +253,15 @@ impl UdpPayloadSource { fn handle_ack(&mut self, ack: UdpAck) { let start = ack.packet_id; - self.sent.retain(|&k, _| k > start); + // -1 is the special case of no messages recieved + if start != 0xFFFFFFFF { + self.sent.retain(|&k, _| k > start); - for (idx, &value) in ack.payload.iter().enumerate() { - let packet_id = (start + 1) + idx as u32; - if value > 0 { - self.sent.remove(&packet_id); + for (idx, &value) in ack.payload.iter().enumerate() { + let packet_id = (start + 1) + idx as u32; + if value > 0 { + self.sent.remove(&packet_id); + } } } } diff --git a/dissector/baichuan.lua b/dissector/baichuan.lua index 34259c5..d5b2079 100644 --- a/dissector/baichuan.lua +++ b/dissector/baichuan.lua @@ -166,6 +166,7 @@ local message_types = { [210]="", [211]=" (write)", [212]="", + [213]=" (write)", [216]=" (write)", [217]="", [218]=" (write)", @@ -179,6 +180,8 @@ local message_types = { [272]="", [273]="", [274]="", + [319]="", + [342]="", } local message_classes = { diff --git a/src/pir/cmdline.rs b/src/pir/cmdline.rs index 36d2ed4..0933c89 100644 --- a/src/pir/cmdline.rs +++ b/src/pir/cmdline.rs @@ -19,5 +19,5 @@ pub struct Opt { pub camera: String, /// Whether to turn the PIR ON or OFF #[structopt(parse(try_from_str = onoff_parse), name = "on|off")] - pub on: bool, + pub on: Option, } diff --git a/src/pir/mod.rs b/src/pir/mod.rs index 724e699..6a028de 100644 --- a/src/pir/mod.rs +++ b/src/pir/mod.rs @@ -27,9 +27,22 @@ pub(crate) use cmdline::Opt; pub(crate) async fn main(opt: Opt, config: Config) -> Result<()> { let camera = find_and_connect(&config, &opt.camera).await?; - camera - .pir_set(opt.on) - .await - .context("Unable to set camera PIR state")?; + if let Some(on) = opt.on { + camera + .pir_set(on) + .await + .context("Unable to set camera PIR state")?; + } else { + let pir_state = camera + .get_pirstate() + .await + .context("Unable to get camera PIR state")?; + let pir_ser = String::from_utf8( + yaserde::ser::serialize_with_writer(&pir_state, vec![], &Default::default()) + .expect("Should Ser the struct"), + ) + .expect("Should be UTF8"); + println!("{}", pir_ser); + } Ok(()) } From 82a39a2fa1a5624a95ef9d30bf3417e7bceb4419 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Mon, 3 Apr 2023 15:06:05 +0700 Subject: [PATCH 2/9] Add PIR to mqtt --- README.md | 4 +- .../src/bc_protocol/connection/udpsource.rs | 2 +- src/mqtt/event_cam.rs | 47 +++++++++++++++++++ src/mqtt/mod.rs | 35 ++++++++++++-- 4 files changed, 83 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 872510b..5592771 100644 --- a/README.md +++ b/README.md @@ -130,10 +130,12 @@ Control messages: Status Messages: `/status offline` Sent when the neolink goes offline this is a LastWill message `/status disconnected` Sent when the camera goes offline -`/status/battery` Sent in reply to a `/query/battery` send an XML encoded version of the battery status +`/status/battery` Sent in reply to a `/query/battery` an XML encoded version of the battery status +`/status/pir` Sent in reply to a `/query/pir` an XML encoded version of the pir status Query Messages: `/query/battery` Request that the camera reports its battery level +`/query/pir` Request that the camera reports its pir status ### Pause diff --git a/crates/core/src/bc_protocol/connection/udpsource.rs b/crates/core/src/bc_protocol/connection/udpsource.rs index 3ab3733..794631d 100644 --- a/crates/core/src/bc_protocol/connection/udpsource.rs +++ b/crates/core/src/bc_protocol/connection/udpsource.rs @@ -254,7 +254,7 @@ impl UdpPayloadSource { fn handle_ack(&mut self, ack: UdpAck) { let start = ack.packet_id; // -1 is the special case of no messages recieved - if start != 0xFFFFFFFF { + if start != 0xFFFFFFFF { self.sent.retain(|&k, _| k > start); for (idx, &value) in ack.payload.iter().enumerate() { diff --git a/src/mqtt/event_cam.rs b/src/mqtt/event_cam.rs index 22d07e6..c2fa812 100644 --- a/src/mqtt/event_cam.rs +++ b/src/mqtt/event_cam.rs @@ -25,6 +25,9 @@ pub(crate) enum Messages { IRLedOff, IRLedAuto, Battery, + PIROn, + PIROff, + PIRQuery, Ptz(Direction), } @@ -349,6 +352,50 @@ impl MessageHandler { } } }, + Messages::PIRQuery => match self.camera.get_pirstate().await { + Err(_) => { + error!("Failed to get pir status"); + "FAIL".to_string() + } + Ok(pir_info) => { + let bytes_res = yaserde::ser::serialize_with_writer( + &pir_info, + vec![], + &Default::default(), + ); + match bytes_res { + Ok(bytes) => match String::from_utf8(bytes) { + Ok(str) => str, + Err(_) => { + error!("Failed to encode pir status"); + "FAIL".to_string() + } + }, + Err(_) => { + error!("Failed to serialise pir status"); + "FAIL".to_string() + } + } + } + }, + Messages::PIROn => { + if self.camera.pir_set(true).await.is_err() { + error!("Failed to turn on the pir"); + self.abort(); + "FAIL".to_string() + } else { + "OK".to_string() + } + } + Messages::PIROff => { + if self.camera.pir_set(false).await.is_err() { + error!("Failed to turn on the pir"); + self.abort(); + "FAIL".to_string() + } else { + "OK".to_string() + } + } Messages::Ptz(direction) => { let (bc_direction, amount) = match direction { Direction::Up(amount) => (BcDirection::Up, amount), diff --git a/src/mqtt/mod.rs b/src/mqtt/mod.rs index 32b3004..37d4faf 100644 --- a/src/mqtt/mod.rs +++ b/src/mqtt/mod.rs @@ -11,6 +11,7 @@ use log::*; /// Control messages: /// /// - `/control/led [on|off]` Turns status LED on/off +/// - `/control/pir [on|off]` Turns PIR on/off /// - `/control/ir [on|off|auto]` Turn IR lights on/off or automatically via light detection /// - `/control/reboot` Reboot the camera /// - `/control/ptz` [up|down|left|right|in|out] (amount) Control the PTZ movements, amount defaults to 32.0 @@ -20,10 +21,12 @@ use log::*; /// `/status offline` Sent when the neolink goes offline this is a LastWill message /// `/status disconnected` Sent when the camera goes offline /// `/status/battery` Sent in reply to a `/query/battery` +/// `/status/pir` Sent in reply to a `/query/pir` /// /// Query Messages: /// -/// `/query/battery` Request that the camera reports its battery level (Not Yet Implemented) +/// `/query/battery` Request that the camera reports its battery level +/// `/query/pir` Request that the camera reports its pir status /// /// /// # Usage @@ -193,7 +196,7 @@ async fn listen_on_camera( message: "on", } => { if event_cam.send_message(Messages::IRLedOn).await.is_err() { - error!("Failed to set camera status light off"); + error!("Failed to set camera status light on"); } } MqttReplyRef { @@ -255,6 +258,22 @@ async fn listen_on_camera( error!("No PTZ Direction given. Please add up/down/left/right/in/out"); } } + MqttReplyRef { + topic: "control/pir", + message: "on", + } => { + if event_cam.send_message(Messages::PIROn).await.is_err() { + error!("Failed to set pir on"); + } + } + MqttReplyRef { + topic: "control/pir", + message: "off", + } => { + if event_cam.send_message(Messages::PIROff).await.is_err() { + error!("Failed to set pir off"); + } + } MqttReplyRef { topic: "query/battery", .. @@ -264,7 +283,17 @@ async fn listen_on_camera( error!("Failed to send battery status reply"); } } - Err(_) => error!("Failed to set camera status light off"), + Err(_) => error!("Failed to get battery status"), + }, + MqttReplyRef { + topic: "query/pir", .. + } => match event_cam.send_message_with_reply(Messages::PIRQuery).await { + Ok(reply) => { + if mqtt.send_message("status/pir", &reply, false).is_err() { + error!("Failed to send pir status reply"); + } + } + Err(_) => error!("Failed to get pir status"), }, _ => {} } From ca5de6445d90f27da6f3ccf2aa263df8fbd8b308 Mon Sep 17 00:00:00 2001 From: Andrew Date: Mon, 3 Apr 2023 17:15:00 +0700 Subject: [PATCH 3/9] Set rfId instead of channelId Missing `:` Missing `None` --- crates/core/src/bc/xml.rs | 4 ++++ crates/core/src/bc_protocol/pirstate.rs | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/core/src/bc/xml.rs b/crates/core/src/bc/xml.rs index 5a979e6..e1e2a87 100644 --- a/crates/core/src/bc/xml.rs +++ b/crates/core/src/bc/xml.rs @@ -238,6 +238,9 @@ pub struct Extension { /// The channel ID. This is usually `0` unless using an NVR #[yaserde(rename = "channelId")] pub channel_id: Option, + /// The rfID used in the PIR + #[yaserde(rename = "rfId")] + pub rf_id: Option, } impl Default for Extension { @@ -248,6 +251,7 @@ impl Default for Extension { user_name: None, token: None, channel_id: None, + rf_id: None, } } } diff --git a/crates/core/src/bc_protocol/pirstate.rs b/crates/core/src/bc_protocol/pirstate.rs index 75a3a85..3a9184d 100644 --- a/crates/core/src/bc_protocol/pirstate.rs +++ b/crates/core/src/bc_protocol/pirstate.rs @@ -18,7 +18,7 @@ impl BcCamera { }, body: BcBody::ModernMsg(ModernMsg { extension: Some(Extension { - channel_id: Some(self.channel_id), + rf_id: Some(self.channel_id), ..Default::default() }), payload: None, @@ -66,7 +66,7 @@ impl BcCamera { }, body: BcBody::ModernMsg(ModernMsg { extension: Some(Extension { - channel_id: Some(self.channel_id), + rf_id: Some(self.channel_id), ..Default::default() }), payload: Some(BcPayloads::BcXml(BcXml { From 618aafef2c81d0e171b568cd5bcef6a5dbf005ac Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Tue, 4 Apr 2023 16:45:16 +0700 Subject: [PATCH 4/9] Added an ability support check to functions --- crates/core/src/bc/model.rs | 2 + crates/core/src/bc/xml.rs | 53 +++++++++++++++++++++++ crates/core/src/bc_protocol.rs | 56 ++++++++++++++++++++++++- crates/core/src/bc_protocol/errors.rs | 16 +++++++ crates/core/src/bc_protocol/ledstate.rs | 2 + crates/core/src/bc_protocol/login.rs | 3 ++ crates/core/src/bc_protocol/motion.rs | 1 + crates/core/src/bc_protocol/pirstate.rs | 2 + crates/core/src/bc_protocol/ptz.rs | 1 + crates/core/src/bc_protocol/reboot.rs | 1 + crates/core/src/bc_protocol/stream.rs | 2 + crates/core/src/bc_protocol/talk.rs | 4 ++ crates/core/src/bc_protocol/time.rs | 2 + crates/core/src/bc_protocol/version.rs | 1 + 14 files changed, 144 insertions(+), 2 deletions(-) diff --git a/crates/core/src/bc/model.rs b/crates/core/src/bc/model.rs index 05de6e9..86a51e9 100644 --- a/crates/core/src/bc/model.rs +++ b/crates/core/src/bc/model.rs @@ -31,6 +31,8 @@ pub const MSG_ID_VERSION: u32 = 80; pub const MSG_ID_PING: u32 = 93; /// General system info messages have this ID pub const MSG_ID_GET_GENERAL: u32 = 104; +/// Used to get the abilities of a user +pub const MSG_ID_ABILITY_INFO: u32 = 151; /// Setting general system info (clock mostly) messages have this ID pub const MSG_ID_SET_GENERAL: u32 = 105; /// Will send the talk config for talk back data to follow this msg diff --git a/crates/core/src/bc/xml.rs b/crates/core/src/bc/xml.rs index e1e2a87..97c8a5f 100644 --- a/crates/core/src/bc/xml.rs +++ b/crates/core/src/bc/xml.rs @@ -82,6 +82,9 @@ pub struct BcXml { /// Recieved on request for battery info #[yaserde(rename = "BatteryInfo")] pub battery_info: Option, + /// Recieved on request for a users persmissions/capabilitoes + #[yaserde(rename = "AbilityInfo")] + pub ability_info: Option, } impl BcXml { @@ -561,6 +564,56 @@ pub struct BatteryInfo { pub battery_version: u32, } +/// The ability battery info +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +pub struct AbilityInfo { + /// Username with this ability + #[yaserde(rename = "userName")] + pub username: String, + /// System permissions + pub system: Option, + /// Network permissions + pub network: Option, + /// Alarm permissions + pub alarm: Option, + /// Image permissions + pub image: Option, + /// Video permissions + pub video: Option, + /// Secutiry permissions + pub security: Option, + /// Replay permissions + pub replay: Option, + /// PTZ permissions + #[yaserde(rename = "PTZ")] + pub ptz: Option, + /// IO permissions + #[yaserde(rename = "IO")] + pub io: Option, + /// Streaming permissions + pub streaming: Option, +} + +/// Ability info for system token +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +pub struct AbilityInfoToken { + /// Submodule for this ability info token + #[yaserde(rename = "subModule")] + pub sub_module: Vec, +} + +/// Token submodule infomation +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +#[yaserde(rename = "subModule")] +pub struct AbilityInfoSubModule { + /// The channel the for the camera usually 0 + #[yaserde(rename = "channelId")] + pub channel_id: Option, + /// The comma seperated list of permissions like this: `general_rw, norm_rw, version_ro` + #[yaserde(rename = "abilityValue")] + pub ability_value: String, +} + /// Convience function to return the xml version used throughout the library pub fn xml_ver() -> String { "1.1".to_string() diff --git a/crates/core/src/bc_protocol.rs b/crates/core/src/bc_protocol.rs index 6d2d1d6..3699f7b 100644 --- a/crates/core/src/bc_protocol.rs +++ b/crates/core/src/bc_protocol.rs @@ -3,10 +3,15 @@ use futures::stream::StreamExt; use log::*; use serde::{Deserialize, Serialize}; use std::net::ToSocketAddrs; -use std::sync::atomic::{AtomicBool, AtomicU16, Ordering}; +use std::{ + collections::HashMap, + sync::atomic::{AtomicBool, AtomicU16, Ordering}, +}; +use tokio::sync::RwLock; use Md5Trunc::*; +mod abilityinfo; mod battery; mod connection; mod credentials; @@ -40,6 +45,13 @@ pub use stream::{StreamData, StreamKind}; pub(crate) type Result = std::result::Result; +#[derive(Clone, Copy)] +enum ReadKind { + ReadOnly, + ReadWrite, + None, +} + /// /// This is the primary struct of this library when interacting with the camera /// @@ -50,6 +62,7 @@ pub struct BcCamera { message_num: AtomicU16, // Certain commands such as logout require the username/pass in plain text.... why....??? credentials: Credentials, + abilities: RwLock>, } /// Used to choode the print format of various status messages like battery levels @@ -334,9 +347,12 @@ impl BcCamera { channel_id, logged_in: AtomicBool::new(false), credentials: Credentials::new(username, passwd), + abilities: Default::default(), }; me.keepalive().await?; - me.monitor_battery(aux_info_format).await?; + if let Err(e) = me.monitor_battery(aux_info_format).await { + warn!("Could not monitor battery: {:?}", e); + } Ok(me) } @@ -355,6 +371,42 @@ impl BcCamera { fn get_credentials(&self) -> &Credentials { &self.credentials } + + async fn has_ability>(&self, name: T) -> ReadKind { + let abilities = self.abilities.read().await; + if let Some(kind) = abilities.get(&name.into()).copied() { + kind + } else { + ReadKind::None + } + } + async fn has_ability_ro>(&self, name: T) -> Result<()> { + let s: String = name.into(); + match self.has_ability(&s).await { + ReadKind::ReadWrite | ReadKind::ReadOnly => Ok(()), + ReadKind::None => Err(Error::MissingAbility { + name: s.clone(), + requested: "read".to_string(), + actual: "none".to_string(), + }), + } + } + async fn has_ability_rw>(&self, name: T) -> Result<()> { + let s: String = name.into(); + match self.has_ability(&s).await { + ReadKind::ReadWrite => Ok(()), + ReadKind::ReadOnly => Err(Error::MissingAbility { + name: s.clone(), + requested: "write".to_string(), + actual: "read".to_string(), + }), + ReadKind::None => Err(Error::MissingAbility { + name: s.clone(), + requested: "write".to_string(), + actual: "none".to_string(), + }), + } + } } /// The Baichuan library has a very peculiar behavior where it always zeros the last byte. I diff --git a/crates/core/src/bc_protocol/errors.rs b/crates/core/src/bc_protocol/errors.rs index e1c53bf..e616821 100644 --- a/crates/core/src/bc_protocol/errors.rs +++ b/crates/core/src/bc_protocol/errors.rs @@ -143,6 +143,22 @@ pub enum Error { #[error(display = "Nom Parsing error: {}", _0)] NomError(String), + /// Raised when a camera/user lacks an ability + #[error( + display = "Missing ability: {} with {} permission has only {}", + name, + requested, + actual + )] + MissingAbility { + /// Name of the ability + name: String, + /// Requested permission (read/write) + requested: String, + /// Actual permission (read/write/none) + actual: String, + }, + /// A generic catch all error #[error(display = "Other error: {}", _0)] Other(&'static str), diff --git a/crates/core/src/bc_protocol/ledstate.rs b/crates/core/src/bc_protocol/ledstate.rs index a15b5cf..472a8ea 100644 --- a/crates/core/src/bc_protocol/ledstate.rs +++ b/crates/core/src/bc_protocol/ledstate.rs @@ -4,6 +4,7 @@ use crate::bc::{model::*, xml::*}; impl BcCamera { /// Get the [LedState] xml which contains the LED status of the camera pub async fn get_ledstate(&self) -> Result { + self.has_ability_ro("ledState").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_get = connection.subscribe(msg_num).await?; @@ -51,6 +52,7 @@ impl BcCamera { /// Set the led lights using the [LedState] xml pub async fn set_ledstate(&self, mut led_state: LedState) -> Result<()> { + self.has_ability_rw("ledState").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); diff --git a/crates/core/src/bc_protocol/login.rs b/crates/core/src/bc_protocol/login.rs index 363d5aa..89754c1 100644 --- a/crates/core/src/bc_protocol/login.rs +++ b/crates/core/src/bc_protocol/login.rs @@ -164,6 +164,9 @@ impl BcCamera { } } } + + // Populate the list of abilities this user has with the camera + self.polulate_abilities().await?; Ok(device_info) } } diff --git a/crates/core/src/bc_protocol/motion.rs b/crates/core/src/bc_protocol/motion.rs index b408ffe..9884bc0 100644 --- a/crates/core/src/bc_protocol/motion.rs +++ b/crates/core/src/bc_protocol/motion.rs @@ -86,6 +86,7 @@ impl BcCamera { /// This message tells the camera to send the motion events to us /// Which are the recieved on msgid 33 async fn start_motion_query(&self) -> Result { + self.has_ability_rw("motion").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); diff --git a/crates/core/src/bc_protocol/pirstate.rs b/crates/core/src/bc_protocol/pirstate.rs index 3a9184d..10be156 100644 --- a/crates/core/src/bc_protocol/pirstate.rs +++ b/crates/core/src/bc_protocol/pirstate.rs @@ -4,6 +4,7 @@ use crate::bc::{model::*, xml::*}; impl BcCamera { /// Get the [RfAlarmCfg] xml which contains the PIR status of the camera pub async fn get_pirstate(&self) -> Result { + self.has_ability_ro("rfAlarm").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_get = connection.subscribe(msg_num).await?; @@ -51,6 +52,7 @@ impl BcCamera { /// Set the PIR sensor using the [RfAlarmCfg] xml pub async fn set_pirstate(&self, rf_alarm_cfg: RfAlarmCfg) -> Result<()> { + self.has_ability_rw("rfAlarm").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_set = connection.subscribe(msg_num).await?; diff --git a/crates/core/src/bc_protocol/ptz.rs b/crates/core/src/bc_protocol/ptz.rs index f7e8e26..c06fee0 100644 --- a/crates/core/src/bc_protocol/ptz.rs +++ b/crates/core/src/bc_protocol/ptz.rs @@ -20,6 +20,7 @@ pub enum Direction { impl BcCamera { /// Send a PTZ message to the camera pub async fn send_ptz(&self, direction: Direction, amount: f32) -> Result<()> { + self.has_ability_rw("control").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_set = connection.subscribe(msg_num).await?; diff --git a/crates/core/src/bc_protocol/reboot.rs b/crates/core/src/bc_protocol/reboot.rs index 2ad7566..4142679 100644 --- a/crates/core/src/bc_protocol/reboot.rs +++ b/crates/core/src/bc_protocol/reboot.rs @@ -4,6 +4,7 @@ use crate::bc::model::*; impl BcCamera { /// Reboot the camera pub async fn reboot(&self) -> Result<()> { + self.has_ability_rw("reboot").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub = connection.subscribe(msg_num).await?; diff --git a/crates/core/src/bc_protocol/stream.rs b/crates/core/src/bc_protocol/stream.rs index 0cafc76..ef3f6df 100644 --- a/crates/core/src/bc_protocol/stream.rs +++ b/crates/core/src/bc_protocol/stream.rs @@ -74,6 +74,7 @@ impl BcCamera { mut buffer_size: usize, strict: bool, ) -> Result { + self.has_ability_rw("preview").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); @@ -208,6 +209,7 @@ impl BcCamera { /// Stop a camera from sending more stream data. pub async fn stop_video(&self, stream: StreamKind) -> Result<()> { + self.has_ability_rw("preview").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_video = connection.subscribe(msg_num).await?; diff --git a/crates/core/src/bc_protocol/talk.rs b/crates/core/src/bc_protocol/talk.rs index f4e08c2..9a37fe7 100644 --- a/crates/core/src/bc_protocol/talk.rs +++ b/crates/core/src/bc_protocol/talk.rs @@ -14,6 +14,7 @@ impl BcCamera { /// It is also sent when the request for talk config returns status code 422 /// pub async fn talk_stop(&self) -> Result<()> { + self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); @@ -58,6 +59,7 @@ impl BcCamera { /// Requests the [`TalkAbility`] xml /// pub async fn talk_ability(&self) -> Result { + self.has_ability_ro("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_get = connection.subscribe(msg_num).await?; @@ -117,6 +119,7 @@ impl BcCamera { /// /// pub async fn talk(&self, adpcm: &[u8], talk_config: TalkConfig) -> Result<()> { + self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); @@ -258,6 +261,7 @@ impl BcCamera { /// /// pub async fn talk_stream(&self, rx: Receiver>, talk_config: TalkConfig) -> Result<()> { + self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); diff --git a/crates/core/src/bc_protocol/time.rs b/crates/core/src/bc_protocol/time.rs index 7ff3bab..a99aec1 100644 --- a/crates/core/src/bc_protocol/time.rs +++ b/crates/core/src/bc_protocol/time.rs @@ -11,6 +11,7 @@ impl BcCamera { /// returns either an error or an option with the offsetted date time /// pub async fn get_time(&self) -> Result> { + self.has_ability_ro("general").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_get_general = connection.subscribe(msg_num).await?; @@ -95,6 +96,7 @@ impl BcCamera { /// returns Ok(()) or error /// pub async fn set_time(&self, timestamp: OffsetDateTime) -> Result<()> { + self.has_ability_rw("general").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_set_general = connection.subscribe(msg_num).await?; diff --git a/crates/core/src/bc_protocol/version.rs b/crates/core/src/bc_protocol/version.rs index e01bf26..b562f5a 100644 --- a/crates/core/src/bc_protocol/version.rs +++ b/crates/core/src/bc_protocol/version.rs @@ -4,6 +4,7 @@ use crate::bc::{model::*, xml::*}; impl BcCamera { /// Request the [VersionInfo] xml pub async fn version(&self) -> Result { + self.has_ability_ro("version").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_version = connection.subscribe(msg_num).await?; From 3014be90082ddbeceaac13e0c435726d08941552 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Tue, 4 Apr 2023 18:49:04 +0700 Subject: [PATCH 5/9] Add abilityinfo.rs --- crates/core/src/bc_protocol/abilityinfo.rs | 104 +++++++++++++++++++++ crates/core/src/bc_protocol/talk.rs | 4 - 2 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 crates/core/src/bc_protocol/abilityinfo.rs diff --git a/crates/core/src/bc_protocol/abilityinfo.rs b/crates/core/src/bc_protocol/abilityinfo.rs new file mode 100644 index 0000000..6718584 --- /dev/null +++ b/crates/core/src/bc_protocol/abilityinfo.rs @@ -0,0 +1,104 @@ +use super::{BcCamera, Error, Result}; +use crate::bc::{model::*, xml::*}; + +impl BcCamera { + /// Get the ability info xml for the current user + pub async fn get_abilityinfo(&self) -> Result { + let connection = self.get_connection(); + let msg_num = self.new_message_num(); + let mut sub_get = connection.subscribe(msg_num).await?; + let get = Bc { + meta: BcMeta { + msg_id: MSG_ID_ABILITY_INFO, + channel_id: self.channel_id, + msg_num, + response_code: 0, + stream_type: 0, + class: 0x6414, + }, + body: BcBody::ModernMsg(ModernMsg { + extension: Some(Extension { + user_name: Some(self.get_credentials().username.clone()), + token: Some("system, streaming, PTZ, IO, security, replay, disk, network, alarm, record, video, image".to_string()), + ..Default::default() + }), + payload: None, + }), + }; + + sub_get.send(get).await?; + let msg = sub_get.recv().await?; + if msg.meta.response_code != 200 { + return Err(Error::CameraServiceUnavaliable); + } + + if let BcBody::ModernMsg(ModernMsg { + payload: + Some(BcPayloads::BcXml(BcXml { + ability_info: Some(ability_info), + .. + })), + .. + }) = msg.body + { + Ok(ability_info) + } else { + Err(Error::UnintelligibleReply { + reply: std::sync::Arc::new(Box::new(msg)), + why: "Expected AbilityInfo xml but it was not recieved", + }) + } + } + + /// Populate ability list of the camera + pub async fn polulate_abilities(&self) -> Result<()> { + let info = self.get_abilityinfo().await?; + let mut abilities: Vec = vec![]; + + let mut tokens: Vec> = vec![ + info.system.as_ref(), + info.network.as_ref(), + info.alarm.as_ref(), + info.image.as_ref(), + info.video.as_ref(), + info.security.as_ref(), + info.replay.as_ref(), + info.ptz.as_ref(), + info.io.as_ref(), + info.streaming.as_ref(), + ]; + for token in tokens.drain(..).flatten() { + for sub_module in token.sub_module.iter() { + abilities.extend( + sub_module + .ability_value + .replace(' ', "") + .split(',') + .map(|s| s.to_string()), + ); + } + } + + let mut locked_abilities = self.abilities.write().await; + for ability in abilities.iter() { + let mut abilities_ro = ability.split('_').map(|s| s.to_string()); + if let (Some(ability_name), Some(ability_kind)) = + (abilities_ro.next(), abilities_ro.next()) + { + match ability_kind.as_str() { + "rw" => { + locked_abilities.insert(ability_name, super::ReadKind::ReadWrite); + } + "ro" => { + locked_abilities.insert(ability_name, super::ReadKind::ReadOnly); + } + _ => { + continue; + } + } + } + } + + Ok(()) + } +} diff --git a/crates/core/src/bc_protocol/talk.rs b/crates/core/src/bc_protocol/talk.rs index 9a37fe7..f4e08c2 100644 --- a/crates/core/src/bc_protocol/talk.rs +++ b/crates/core/src/bc_protocol/talk.rs @@ -14,7 +14,6 @@ impl BcCamera { /// It is also sent when the request for talk config returns status code 422 /// pub async fn talk_stop(&self) -> Result<()> { - self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); @@ -59,7 +58,6 @@ impl BcCamera { /// Requests the [`TalkAbility`] xml /// pub async fn talk_ability(&self) -> Result { - self.has_ability_ro("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); let mut sub_get = connection.subscribe(msg_num).await?; @@ -119,7 +117,6 @@ impl BcCamera { /// /// pub async fn talk(&self, adpcm: &[u8], talk_config: TalkConfig) -> Result<()> { - self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); @@ -261,7 +258,6 @@ impl BcCamera { /// /// pub async fn talk_stream(&self, rx: Receiver>, talk_config: TalkConfig) -> Result<()> { - self.has_ability_rw("talk").await?; let connection = self.get_connection(); let msg_num = self.new_message_num(); From 6a1415913b8eb461418dff47dc92c74baf437d86 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Wed, 5 Apr 2023 11:48:43 +0700 Subject: [PATCH 6/9] Add retry if PIR state returns error code 400 --- crates/core/src/bc_protocol/pirstate.rs | 62 ++++++++++++++++--------- 1 file changed, 40 insertions(+), 22 deletions(-) diff --git a/crates/core/src/bc_protocol/pirstate.rs b/crates/core/src/bc_protocol/pirstate.rs index 10be156..253c273 100644 --- a/crates/core/src/bc_protocol/pirstate.rs +++ b/crates/core/src/bc_protocol/pirstate.rs @@ -1,35 +1,53 @@ use super::{BcCamera, Error, Result}; use crate::bc::{model::*, xml::*}; +use tokio::time::{interval, Duration}; impl BcCamera { /// Get the [RfAlarmCfg] xml which contains the PIR status of the camera pub async fn get_pirstate(&self) -> Result { self.has_ability_ro("rfAlarm").await?; let connection = self.get_connection(); - let msg_num = self.new_message_num(); - let mut sub_get = connection.subscribe(msg_num).await?; - let get = Bc { - meta: BcMeta { - msg_id: MSG_ID_GET_PIR_ALARM, - channel_id: self.channel_id, - msg_num, - response_code: 0, - stream_type: 0, - class: 0x6414, - }, - body: BcBody::ModernMsg(ModernMsg { - extension: Some(Extension { - rf_id: Some(self.channel_id), - ..Default::default() + let msg; + let mut reties: usize = 0; + let mut retry_interval = interval(Duration::from_millis(500)); + loop { + retry_interval.tick().await; + let msg_num = self.new_message_num(); + let mut sub_get = connection.subscribe(msg_num).await?; + let get = Bc { + meta: BcMeta { + msg_id: MSG_ID_GET_PIR_ALARM, + channel_id: self.channel_id, + msg_num, + response_code: 0, + stream_type: 0, + class: 0x6414, + }, + body: BcBody::ModernMsg(ModernMsg { + extension: Some(Extension { + rf_id: Some(self.channel_id), + ..Default::default() + }), + payload: None, }), - payload: None, - }), - }; + }; - sub_get.send(get).await?; - let msg = sub_get.recv().await?; - if msg.meta.response_code != 200 { - return Err(Error::CameraServiceUnavaliable); + sub_get.send(get).await?; + let intermediant_msg = sub_get.recv().await?; + if intermediant_msg.meta.response_code == 400 { + // Retryable + if reties < 5 { + reties += 1; + continue; + } else { + return Err(Error::CameraServiceUnavaliable); + } + } else if intermediant_msg.meta.response_code != 200 { + return Err(Error::CameraServiceUnavaliable); + } else { + msg = intermediant_msg; + break; + } } if let BcBody::ModernMsg(ModernMsg { From 000f75642087598c829a42b466d9de7d4de34d0f Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Wed, 5 Apr 2023 15:27:32 +0700 Subject: [PATCH 7/9] Fmt --- crates/core/src/bc_protocol/login.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/core/src/bc_protocol/login.rs b/crates/core/src/bc_protocol/login.rs index 89754c1..b6b9810 100644 --- a/crates/core/src/bc_protocol/login.rs +++ b/crates/core/src/bc_protocol/login.rs @@ -164,7 +164,7 @@ impl BcCamera { } } } - + // Populate the list of abilities this user has with the camera self.polulate_abilities().await?; Ok(device_info) From 17f3695ca7676c6ed3400584921e9ca29c1822b4 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Wed, 5 Apr 2023 15:30:54 +0700 Subject: [PATCH 8/9] Slight pirstate refractor --- crates/core/src/bc_protocol/pirstate.rs | 43 ++++++++++++------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/crates/core/src/bc_protocol/pirstate.rs b/crates/core/src/bc_protocol/pirstate.rs index 253c273..aa340e8 100644 --- a/crates/core/src/bc_protocol/pirstate.rs +++ b/crates/core/src/bc_protocol/pirstate.rs @@ -7,7 +7,6 @@ impl BcCamera { pub async fn get_pirstate(&self) -> Result { self.has_ability_ro("rfAlarm").await?; let connection = self.get_connection(); - let msg; let mut reties: usize = 0; let mut retry_interval = interval(Duration::from_millis(500)); loop { @@ -33,8 +32,8 @@ impl BcCamera { }; sub_get.send(get).await?; - let intermediant_msg = sub_get.recv().await?; - if intermediant_msg.meta.response_code == 400 { + let msg = sub_get.recv().await?; + if msg.meta.response_code == 400 { // Retryable if reties < 5 { reties += 1; @@ -42,29 +41,27 @@ impl BcCamera { } else { return Err(Error::CameraServiceUnavaliable); } - } else if intermediant_msg.meta.response_code != 200 { + } else if msg.meta.response_code != 200 { return Err(Error::CameraServiceUnavaliable); } else { - msg = intermediant_msg; - break; - } - } - - if let BcBody::ModernMsg(ModernMsg { - payload: - Some(BcPayloads::BcXml(BcXml { - rf_alarm_cfg: Some(pirstate), + // Valid message with response_code == 200 + if let BcBody::ModernMsg(ModernMsg { + payload: + Some(BcPayloads::BcXml(BcXml { + rf_alarm_cfg: Some(pirstate), + .. + })), .. - })), - .. - }) = msg.body - { - Ok(pirstate) - } else { - Err(Error::UnintelligibleReply { - reply: std::sync::Arc::new(Box::new(msg)), - why: "Expected PirSate xml but it was not recieved", - }) + }) = msg.body + { + return Ok(pirstate); + } else { + return Err(Error::UnintelligibleReply { + reply: std::sync::Arc::new(Box::new(msg)), + why: "Expected PirSate xml but it was not recieved", + }); + } + } } } From 16022c8b2819430c5d238ee783a3a16279b61604 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Wed, 5 Apr 2023 15:41:31 +0700 Subject: [PATCH 9/9] Cliipy --- crates/core/src/bc_protocol/connection/discovery.rs | 2 +- crates/core/src/bc_protocol/connection/udpsource.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/core/src/bc_protocol/connection/discovery.rs b/crates/core/src/bc_protocol/connection/discovery.rs index 0019707..25c273a 100644 --- a/crates/core/src/bc_protocol/connection/discovery.rs +++ b/crates/core/src/bc_protocol/connection/discovery.rs @@ -938,7 +938,7 @@ fn generate_cid() -> i32 { } async fn connect() -> Result { - let mut ports: Vec = (53500..54000).into_iter().collect(); + let mut ports: Vec = (53500..54000).collect(); { let mut rng = thread_rng(); ports.shuffle(&mut rng); diff --git a/crates/core/src/bc_protocol/connection/udpsource.rs b/crates/core/src/bc_protocol/connection/udpsource.rs index 794631d..27b7252 100644 --- a/crates/core/src/bc_protocol/connection/udpsource.rs +++ b/crates/core/src/bc_protocol/connection/udpsource.rs @@ -511,7 +511,7 @@ impl futures::AsyncWrite for UdpPayloadSource { /// Helper to create a TcpStream with a connect timeout async fn connect() -> Result { - let mut ports: Vec = (53500..54000).into_iter().collect(); + let mut ports: Vec = (53500..54000).collect(); let mut rng = thread_rng(); ports.shuffle(&mut rng);