use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use crate::serial::{ConnectionSummary, FlowControl, FlushTarget, PortInfo};
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct OpenArgs {
pub port: String,
#[serde(default)]
pub name: Option<String>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub baud_rate: u32,
#[serde(default = "default_data_bits")]
pub data_bits: String,
#[serde(default = "default_stop_bits")]
pub stop_bits: String,
#[serde(default = "default_parity")]
pub parity: String,
#[serde(default = "default_flow_control")]
pub flow_control: String,
#[serde(default = "default_log_capacity")]
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub log_capacity: usize,
#[serde(default = "default_true")]
pub log_enabled: bool,
#[serde(default)]
pub reconnect_policy: crate::serial::ReconnectPolicy,
#[serde(default)]
pub tx_framing: Option<crate::framing::TxFramingConfig>,
#[serde(default)]
pub rx_framing: Option<crate::framing::RxFramingConfig>,
#[serde(default)]
pub rx_parser: Option<crate::framing::ParserConfig>,
#[serde(default)]
pub protocol: Option<crate::framing::ProtocolPreset>,
}
fn default_log_capacity() -> usize {
1024
}
fn default_true() -> bool {
true
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct CloseArgs {
pub connection_id: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ListConnectionsArgs {}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct WriteArgs {
pub connection_id: String,
pub data: String,
#[serde(default = "default_encoding")]
pub encoding: String,
#[serde(default)]
pub tx_framing: Option<crate::framing::TxFramingConfig>,
#[serde(default)]
pub protocol: Option<crate::framing::ProtocolPreset>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ReadArgs {
pub connection_id: String,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_timeout_ms_schema")]
pub timeout_ms: Option<u64>,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_positive_timeout_ms_schema")]
pub no_new_rx_timeout_ms: Option<u64>,
#[serde(default = "default_max_buffered_bytes")]
#[schemars(schema_with = "crate::schema_helpers::read_max_buffered_bytes_schema")]
pub max_buffered_bytes: usize,
#[serde(default = "default_encoding")]
pub encoding: String,
#[serde(default)]
pub r#match: Option<crate::match_config::MatchRequest>,
#[serde(default)]
pub rx_framing: Option<crate::framing::RxFramingConfig>,
#[serde(default)]
pub rx_parser: Option<crate::framing::ParserConfig>,
#[serde(default)]
pub protocol: Option<crate::framing::ProtocolPreset>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct FlushArgs {
pub connection_id: String,
#[serde(default = "default_flush_target")]
pub target: FlushTarget,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SetDtrRtsArgs {
pub connection_id: String,
pub dtr: bool,
pub rts: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SetFlowControlArgs {
pub connection_id: String,
pub flow_control: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SendBreakArgs {
pub connection_id: String,
#[serde(default = "default_break_duration_ms")]
#[schemars(schema_with = "crate::schema_helpers::timeout_ms_schema")]
pub duration_ms: u64,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SubscribeArgs {
pub connection_id: String,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_timeout_ms_schema")]
pub timeout_ms: Option<u64>,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_positive_timeout_ms_schema")]
pub no_new_rx_timeout_ms: Option<u64>,
#[serde(default = "default_encoding")]
pub encoding: String,
#[serde(default = "default_subscribe_buffered_bytes")]
#[schemars(schema_with = "crate::schema_helpers::stream_buffered_bytes_schema")]
pub max_buffered_bytes: usize,
#[serde(default = "default_subscribe_poll_ms")]
#[schemars(schema_with = "crate::schema_helpers::poll_interval_ms_schema")]
pub poll_interval_ms: u64,
#[serde(default)]
pub r#match: Option<crate::match_config::MatchRequest>,
#[serde(default)]
pub rx_framing: Option<crate::framing::RxFramingConfig>,
#[serde(default)]
pub rx_parser: Option<crate::framing::ParserConfig>,
#[serde(default)]
pub protocol: Option<crate::framing::ProtocolPreset>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct UnsubscribeArgs {
pub connection_id: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct GetStatusArgs {
pub connection_id: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ReconfigureArgs {
pub connection_id: String,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub baud_rate: Option<u32>,
#[serde(default)]
pub data_bits: Option<String>,
#[serde(default)]
pub stop_bits: Option<String>,
#[serde(default)]
pub parity: Option<String>,
#[serde(default)]
pub flow_control: Option<String>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ListProfilesArgs {}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct OpenProfileArgs {
pub profile: String,
#[serde(default)]
pub name: Option<String>,
#[serde(default = "default_log_capacity")]
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub log_capacity: usize,
#[serde(default = "default_true")]
pub log_enabled: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ListPortsResult {
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub count: usize,
pub ports: Vec<PortInfo>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct OpenResult {
pub connection_id: String,
pub name: Option<String>,
pub port: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub baud_rate: u32,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ListConnectionsResult {
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub count: usize,
pub connections: Vec<ConnectionSummary>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct CloseResult {
pub connection_id: String,
pub name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct WriteResult {
pub connection_id: String,
pub name: Option<String>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub bytes_written: usize,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub decoded_bytes: usize,
pub encoding: String,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct FrameResult {
pub data: String,
pub encoding: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub frame_index: usize,
pub frame_type: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub parsed: Option<crate::framing::ParsedFrame>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ReadResult {
pub connection_id: String,
pub name: Option<String>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub bytes_read: usize,
pub encoding: String,
pub data: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub timeout_ms: u64,
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub no_new_rx_timeout_ms: Option<u64>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub elapsed_ms: u64,
pub stop_reason: String,
pub truncated: bool,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub bytes_observed: usize,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub bytes_returned: usize,
#[serde(default)]
pub matched: bool,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub match_index: Option<usize>,
#[serde(default, skip_serializing_if = "Option::is_none")]
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub match_frame_index: Option<usize>,
#[serde(skip_serializing_if = "Option::is_none")]
pub frames: Option<Vec<FrameResult>>,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub frames_dropped: usize,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct FlushResult {
pub connection_id: String,
pub name: Option<String>,
pub target: FlushTarget,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SetDtrRtsResult {
pub connection_id: String,
pub name: Option<String>,
pub dtr: bool,
pub rts: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SetFlowControlResult {
pub connection_id: String,
pub name: Option<String>,
pub flow_control: FlowControl,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SendBreakResult {
pub connection_id: String,
pub name: Option<String>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub duration_ms: u64,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub actual_duration_ms: u64,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SubscribeResult {
pub connection_id: String,
pub name: Option<String>,
pub encoding: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub max_buffered_bytes: usize,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub poll_interval_ms: u64,
pub replaced_previous: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct UnsubscribeResult {
pub connection_id: String,
pub name: Option<String>,
pub was_active: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct GetStatusResult {
pub connection_id: String,
pub name: Option<String>,
pub port: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub baud_rate: u32,
pub data_bits: String,
pub stop_bits: String,
pub parity: String,
pub flow_control: String,
pub is_open: bool,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub tx_bytes: u64,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub rx_bytes: u64,
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub last_activity_ms: Option<u64>,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub read_ops: u64,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub write_ops: u64,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub truncation_count: u64,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub notification_drop_count: u64,
pub port_info: Option<crate::serial::PortInfo>,
pub state: crate::serial::ConnectionState,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub reconnect_attempts: u64,
pub last_error: Option<String>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ReconfigureResult {
pub connection_id: String,
pub name: Option<String>,
pub port: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub baud_rate: u32,
pub data_bits: String,
pub stop_bits: String,
pub parity: String,
pub flow_control: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ProfileSummary {
pub name: String,
pub selector: crate::profiles::ProfileSelector,
pub defaults: crate::profiles::ProfileDefaults,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ListProfilesResult {
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub count: usize,
pub profiles: Vec<ProfileSummary>,
}
pub fn default_data_bits() -> String {
"8".into()
}
pub fn default_stop_bits() -> String {
"1".into()
}
pub fn default_parity() -> String {
"none".into()
}
pub fn default_flow_control() -> String {
"none".into()
}
pub fn default_encoding() -> String {
"utf8".into()
}
pub fn default_max_buffered_bytes() -> usize {
2048
}
pub fn default_flush_target() -> FlushTarget {
FlushTarget::Both
}
pub fn default_break_duration_ms() -> u64 {
250
}
pub fn default_subscribe_buffered_bytes() -> usize {
2048
}
pub fn default_subscribe_poll_ms() -> u64 {
200
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct SaveProfileArgs {
pub connection_id: String,
pub profile_name: String,
#[serde(default)]
pub overwrite: bool,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct SaveProfileResult {
pub name: String,
pub selector: crate::profiles::ProfileSelector,
pub defaults: crate::profiles::ProfileDefaults,
pub created: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct DeleteProfileArgs {
pub profile_name: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct DeleteProfileResult {
pub profile_name: String,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct GetLogArgs {
pub connection_id: String,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub since_ms: Option<u64>,
#[serde(default)]
#[schemars(schema_with = "crate::schema_helpers::option_uint_schema")]
pub limit: Option<usize>,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct GetLogResult {
pub log_enabled: bool,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub capacity: usize,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub total_events: usize,
pub events: Vec<crate::log_buffer::LogEntry>,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ClearLogArgs {
pub connection_id: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ClearLogResult {
pub connection_id: String,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ExportLogArgs {
pub connection_id: String,
pub path: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ExportLogResult {
pub connection_id: String,
pub path: String,
#[schemars(schema_with = "crate::schema_helpers::uint_schema")]
pub events_written: usize,
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ReconnectArgs {
pub connection_id: String,
}
#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct ReconnectResult {
pub connection_id: String,
pub name: Option<String>,
pub port: String,
pub state: crate::serial::ConnectionState,
}