use bytes::{Buf, BufMut, Bytes, BytesMut};
use std::net::SocketAddr;
use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
use tokio::sync::Mutex;
use crate::proto::{
cotp::CotpPdu,
s7::{
clock::PlcDateTime,
header::{Area, PduType, S7Header, TransportSize},
read_var::{AddressItem, ReadVarRequest, ReadVarResponse},
szl::{SzlRequest, SzlResponse},
write_var::{WriteItem, WriteVarRequest, WriteVarResponse},
},
tpkt::TpktFrame,
};
use crate::{
connection::{connect, Connection},
error::{Error, Result},
types::ConnectParams,
};
#[derive(Debug, Clone)]
pub struct MultiReadItem {
pub area: Area,
pub db_number: u16,
pub start: u32,
pub length: u16,
pub transport: TransportSize,
}
impl MultiReadItem {
pub fn db(db: u16, start: u32, length: u16) -> Self {
Self {
area: Area::DataBlock,
db_number: db,
start,
length,
transport: TransportSize::Byte,
}
}
}
#[derive(Debug, Clone)]
pub struct MultiWriteItem {
pub area: Area,
pub db_number: u16,
pub start: u32,
pub data: Bytes,
}
impl MultiWriteItem {
pub fn db(db: u16, start: u32, data: impl Into<Bytes>) -> Self {
Self {
area: Area::DataBlock,
db_number: db,
start,
data: data.into(),
}
}
}
struct Inner<T> {
transport: T,
connection: Connection,
pdu_ref: u16,
request_timeout: std::time::Duration,
}
pub struct S7Client<T: AsyncRead + AsyncWrite + Unpin + Send> {
inner: Mutex<Inner<T>>,
params: ConnectParams,
}
impl<T: AsyncRead + AsyncWrite + Unpin + Send> S7Client<T> {
pub async fn from_transport(transport: T, params: ConnectParams) -> Result<Self> {
let mut t = transport;
let connection = connect(&mut t, ¶ms).await?;
let timeout = params.request_timeout;
Ok(S7Client {
inner: Mutex::new(Inner {
transport: t,
connection,
pdu_ref: 1,
request_timeout: timeout,
}),
params,
})
}
pub fn request_timeout(&self) -> std::time::Duration {
self.params.request_timeout
}
pub async fn set_request_timeout(&self, timeout: std::time::Duration) {
let mut inner = self.inner.lock().await;
inner.request_timeout = timeout;
}
pub fn get_param(&self, name: &str) -> Result<std::time::Duration> {
match name {
"request_timeout" => Ok(self.params.request_timeout),
"connect_timeout" => Ok(self.params.connect_timeout),
"pdu_size" => Err(Error::PlcError {
code: 0,
message: "pdu_size is not a Duration; use .params.pdu_size directly".into(),
}),
_ => Err(Error::PlcError {
code: 0,
message: format!("unknown parameter: {name}"),
}),
}
}
pub fn set_param(&mut self, name: &str, value: std::time::Duration) -> Result<()> {
match name {
"request_timeout" => {
self.params.request_timeout = value;
Ok(())
}
_ => Err(Error::PlcError {
code: 0,
message: format!("unknown parameter: {name}"),
}),
}
}
fn next_pdu_ref(inner: &mut Inner<T>) -> u16 {
inner.pdu_ref = inner.pdu_ref.wrapping_add(1);
inner.pdu_ref
}
async fn send_s7(
inner: &mut Inner<T>,
param_buf: Bytes,
data_buf: Bytes,
pdu_ref: u16,
pdu_type: PduType,
) -> Result<()> {
let header = S7Header {
pdu_type,
reserved: 0,
pdu_ref,
param_len: param_buf.len() as u16,
data_len: data_buf.len() as u16,
error_class: None,
error_code: None,
};
let mut s7b = BytesMut::new();
header.encode(&mut s7b);
s7b.extend_from_slice(¶m_buf);
s7b.extend_from_slice(&data_buf);
let dt = CotpPdu::Data {
tpdu_nr: 0,
last: true,
payload: s7b.freeze(),
};
let mut cotpb = BytesMut::new();
dt.encode(&mut cotpb);
let tpkt = TpktFrame {
payload: cotpb.freeze(),
};
let mut tb = BytesMut::new();
tpkt.encode(&mut tb)?;
inner.transport.write_all(&tb).await?;
Ok(())
}
async fn recv_s7(inner: &mut Inner<T>) -> Result<(S7Header, Bytes)> {
let timeout = inner.request_timeout;
let mut tpkt_hdr = [0u8; 4];
tokio::time::timeout(timeout, inner.transport.read_exact(&mut tpkt_hdr))
.await
.map_err(|_| Error::Timeout(timeout))??;
let total = u16::from_be_bytes([tpkt_hdr[2], tpkt_hdr[3]]) as usize;
if total < 4 {
return Err(Error::UnexpectedResponse);
}
let mut payload = vec![0u8; total - 4];
tokio::time::timeout(timeout, inner.transport.read_exact(&mut payload))
.await
.map_err(|_| Error::Timeout(timeout))??;
let mut b = Bytes::from(payload);
if b.remaining() < 3 {
return Err(Error::UnexpectedResponse);
}
let _li = b.get_u8();
let cotp_code = b.get_u8();
if cotp_code != 0xF0 {
return Err(Error::UnexpectedResponse);
}
b.advance(1);
let header = S7Header::decode(&mut b)?;
Ok((header, b))
}
pub async fn db_read(&self, db: u16, start: u32, length: u16) -> Result<Bytes> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = ReadVarRequest {
items: vec![AddressItem {
area: Area::DataBlock,
db_number: db,
start,
bit_offset: 0,
length,
transport: TransportSize::Byte,
}],
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "db_read")?;
if body.remaining() >= 2 {
body.advance(2); }
let resp = ReadVarResponse::decode(&mut body, 1)?;
if resp.items.is_empty() {
return Err(Error::UnexpectedResponse);
}
if resp.items[0].return_code != 0xFF {
return Err(Error::PlcError {
code: resp.items[0].return_code as u32,
message: "item error".into(),
});
}
Ok(resp.items[0].data.clone())
}
pub async fn read_area(
&self,
area: Area,
db_number: u16,
start: u32,
element_count: u16,
transport: TransportSize,
) -> Result<Bytes> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = ReadVarRequest {
items: vec![AddressItem {
area,
db_number,
start,
bit_offset: 0,
length: element_count,
transport,
}],
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "read_area")?;
if body.remaining() >= 2 {
body.advance(2);
}
let resp = ReadVarResponse::decode(&mut body, 1)?;
if resp.items.is_empty() {
return Err(Error::UnexpectedResponse);
}
if resp.items[0].return_code != 0xFF {
return Err(Error::PlcError {
code: resp.items[0].return_code as u32,
message: "item error".into(),
});
}
Ok(resp.items[0].data.clone())
}
pub async fn read_multi_vars(&self, items: &[MultiReadItem]) -> Result<Vec<Bytes>> {
if items.is_empty() {
return Ok(Vec::new());
}
const S7_HEADER: usize = 10;
const PARAM_OVERHEAD: usize = 2; const ADDR_ITEM_SIZE: usize = 12;
const DATA_ITEM_OVERHEAD: usize = 4;
const MAX_ITEMS_PER_PDU: usize = 20;
let mut inner = self.inner.lock().await;
let pdu_size = inner.connection.pdu_size as usize;
let max_req_payload = pdu_size.saturating_sub(S7_HEADER + PARAM_OVERHEAD);
let max_resp_payload = pdu_size.saturating_sub(S7_HEADER + PARAM_OVERHEAD);
let mut results = vec![Bytes::new(); items.len()];
let mut batch_start = 0;
while batch_start < items.len() {
let mut batch_end = batch_start;
let mut req_bytes_used = 0usize;
let mut resp_bytes_used = 0usize;
while batch_end < items.len() && (batch_end - batch_start) < MAX_ITEMS_PER_PDU {
let item = &items[batch_end];
let item_resp_size =
DATA_ITEM_OVERHEAD + item.length as usize + (item.length as usize % 2);
if batch_end > batch_start
&& (req_bytes_used + ADDR_ITEM_SIZE > max_req_payload
|| resp_bytes_used + item_resp_size > max_resp_payload)
{
break;
}
req_bytes_used += ADDR_ITEM_SIZE;
resp_bytes_used += item_resp_size;
batch_end += 1;
}
let batch = &items[batch_start..batch_end];
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = ReadVarRequest {
items: batch
.iter()
.map(|item| AddressItem {
area: item.area,
db_number: item.db_number,
start: item.start,
bit_offset: 0,
length: item.length,
transport: TransportSize::Byte,
})
.collect(),
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "read_multi_vars")?;
if body.remaining() >= 2 {
body.advance(2); }
let resp = ReadVarResponse::decode(&mut body, batch.len())?;
for (i, item) in resp.items.into_iter().enumerate() {
if item.return_code != 0xFF {
return Err(Error::PlcError {
code: item.return_code as u32,
message: format!("item {} error", batch_start + i),
});
}
results[batch_start + i] = item.data;
}
batch_start = batch_end;
}
Ok(results)
}
pub async fn write_multi_vars(&self, items: &[MultiWriteItem]) -> Result<()> {
if items.is_empty() {
return Ok(());
}
const S7_HEADER: usize = 10;
const PARAM_OVERHEAD: usize = 2; const ADDR_ITEM_SIZE: usize = 12;
const DATA_ITEM_OVERHEAD: usize = 4; const MAX_ITEMS_PER_PDU: usize = 20;
let mut inner = self.inner.lock().await;
let pdu_size = inner.connection.pdu_size as usize;
let max_payload = pdu_size.saturating_sub(S7_HEADER + PARAM_OVERHEAD);
let mut batch_start = 0;
while batch_start < items.len() {
let mut batch_end = batch_start;
let mut bytes_used = 0usize;
while batch_end < items.len() && (batch_end - batch_start) < MAX_ITEMS_PER_PDU {
let item = &items[batch_end];
let data_len = item.data.len();
let item_size = ADDR_ITEM_SIZE + DATA_ITEM_OVERHEAD + data_len + (data_len % 2);
if batch_end > batch_start && bytes_used + item_size > max_payload {
break;
}
bytes_used += item_size;
batch_end += 1;
}
let batch = &items[batch_start..batch_end];
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = WriteVarRequest {
items: batch
.iter()
.map(|item| WriteItem {
address: AddressItem {
area: item.area,
db_number: item.db_number,
start: item.start,
bit_offset: 0,
length: item.data.len() as u16,
transport: TransportSize::Byte,
},
data: item.data.clone(),
})
.collect(),
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "write_multi_vars")?;
if body.remaining() >= 2 {
body.advance(2); }
let resp = WriteVarResponse::decode(&mut body, batch.len())?;
for (i, &code) in resp.return_codes.iter().enumerate() {
if code != 0xFF {
return Err(Error::PlcError {
code: code as u32,
message: format!("item {} write error", batch_start + i),
});
}
}
batch_start = batch_end;
}
Ok(())
}
pub async fn db_write(&self, db: u16, start: u32, data: &[u8]) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = WriteVarRequest {
items: vec![WriteItem {
address: AddressItem {
area: Area::DataBlock,
db_number: db,
start,
bit_offset: 0,
length: data.len() as u16,
transport: TransportSize::Byte,
},
data: Bytes::copy_from_slice(data),
}],
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "db_write")?;
if body.has_remaining() {
body.advance(2); }
let resp = WriteVarResponse::decode(&mut body, 1)?;
if resp.return_codes[0] != 0xFF {
return Err(Error::PlcError {
code: resp.return_codes[0] as u32,
message: "write error".into(),
});
}
Ok(())
}
pub async fn write_area(
&self,
area: Area,
db_number: u16,
start: u32,
transport: TransportSize,
data: &[u8],
) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = WriteVarRequest {
items: vec![WriteItem {
address: AddressItem {
area,
db_number,
start,
bit_offset: 0,
length: data.len() as u16,
transport,
},
data: Bytes::copy_from_slice(data),
}],
};
let mut param_buf = BytesMut::new();
req.encode(&mut param_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "write_area")?;
if body.has_remaining() {
body.advance(2);
}
let resp = WriteVarResponse::decode(&mut body, 1)?;
if resp.return_codes[0] != 0xFF {
return Err(Error::PlcError {
code: resp.return_codes[0] as u32,
message: "write_area error".into(),
});
}
Ok(())
}
pub async fn ab_read(
&self,
area: Area,
db_number: u16,
start: u32,
length: u16,
) -> Result<Bytes> {
let items = [MultiReadItem {
area,
db_number,
start,
length,
transport: TransportSize::Byte,
}];
let mut results = self.read_multi_vars(&items).await?;
Ok(results.swap_remove(0))
}
pub async fn ab_write(
&self,
area: Area,
db_number: u16,
start: u32,
data: &[u8],
) -> Result<()> {
let items = [MultiWriteItem {
area,
db_number,
start,
data: Bytes::copy_from_slice(data),
}];
self.write_multi_vars(&items).await
}
pub async fn read_szl(&self, szl_id: u16, szl_index: u16) -> Result<SzlResponse> {
let payload = self.read_szl_payload(szl_id, szl_index).await?;
let mut b = payload;
Ok(SzlResponse::decode(&mut b)?)
}
async fn read_szl_payload(&self, szl_id: u16, szl_index: u16) -> Result<Bytes> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let req = SzlRequest { szl_id, szl_index };
let mut param_buf = BytesMut::new();
req.encode_params(&mut param_buf);
let mut data_buf = BytesMut::new();
req.encode_data(&mut data_buf);
Self::send_s7(
&mut inner,
param_buf.freeze(),
data_buf.freeze(),
pdu_ref,
PduType::UserData,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
if body.remaining() < header.param_len as usize {
return Err(Error::UnexpectedResponse);
}
body.advance(header.param_len as usize);
if body.remaining() < 4 {
return Ok(Bytes::new());
}
let return_code = body.get_u8();
let _transport = body.get_u8();
let _data_len = body.get_u16();
if return_code != 0xFF {
return Ok(Bytes::new());
}
Ok(body.copy_to_bytes(body.remaining()))
}
pub async fn read_clock(&self) -> Result<PlcDateTime> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let mut param_buf = BytesMut::new();
param_buf.extend_from_slice(&[0x00, 0x01, 0x12, 0x04, 0xF5, 0x00]);
Self::send_s7(
&mut inner,
param_buf.freeze(),
Bytes::new(),
pdu_ref,
PduType::UserData,
)
.await?;
let (_header, mut body) = Self::recv_s7(&mut inner).await?;
if body.remaining() > 8 {
body.advance(body.remaining() - 8);
}
Ok(PlcDateTime::decode(&mut body)?)
}
pub async fn copy_ram_to_rom(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::copy_from_slice(&[
0x00, 0x01, 0x12, 0x04, 0x43, 0x44, 0x01, 0x00,
]);
Self::send_s7(&mut inner, param, Bytes::new(), pdu_ref, PduType::UserData).await?;
let (header, _body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "copy_ram_to_rom")?;
Ok(())
}
pub async fn compress(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::copy_from_slice(&[
0x00, 0x01, 0x12, 0x04, 0x42, 0x44, 0x01, 0x00,
]);
Self::send_s7(&mut inner, param, Bytes::new(), pdu_ref, PduType::UserData).await?;
let (header, _body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "compress")?;
Ok(())
}
async fn simple_control(inner: &mut Inner<T>, pdu_ref: u16, func: u8) -> Result<()> {
let param = Bytes::copy_from_slice(&[func, 0x00]);
Self::send_s7(inner, param, Bytes::new(), pdu_ref, PduType::Job).await?;
let (header, _body) = Self::recv_s7(inner).await?;
check_plc_error(&header, "plc_control")?;
Ok(())
}
pub async fn plc_stop(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
Self::simple_control(&mut inner, pdu_ref, 0x29).await
}
pub async fn plc_hot_start(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
Self::simple_control(&mut inner, pdu_ref, 0x28).await
}
pub async fn plc_cold_start(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
Self::simple_control(&mut inner, pdu_ref, 0x2A).await
}
pub async fn get_plc_status(&self) -> Result<crate::types::PlcStatus> {
let payload = self.read_szl_payload(0x0424, 0x0000).await?;
if payload.len() < 12 {
return Ok(crate::types::PlcStatus::Unknown);
}
let status_byte = payload[11];
match status_byte {
0x00 => Ok(crate::types::PlcStatus::Unknown),
0x04 => Ok(crate::types::PlcStatus::Stop),
0x08 => Ok(crate::types::PlcStatus::Run),
0x03 => Ok(crate::types::PlcStatus::Stop),
_ => Ok(crate::types::PlcStatus::Stop),
}
}
pub async fn get_order_code(&self) -> Result<crate::types::OrderCode> {
let payload = self.read_szl_payload(0x0011, 0x0000).await?;
if payload.len() < 8 {
return Err(Error::UnexpectedResponse);
}
let n = payload.len();
let (v1, v2, v3) = if n >= 3 {
(payload[n - 3], payload[n - 2], payload[n - 1])
} else {
(0, 0, 0)
};
let mut b = payload.clone();
let szl_id = b.get_u16();
let _szl_idx = b.get_u16();
let entry_len = b.get_u16() as usize;
let entry_count = b.get_u16() as usize;
if (szl_id == 0x0011 || szl_id == 0x001C) && entry_len >= 4 && entry_count > 0 {
for _ in 0..entry_count {
if b.remaining() < entry_len { break; }
let entry_idx = b.get_u16();
let string_len = entry_len - 2;
let raw = b.copy_to_bytes(string_len);
if entry_idx == 0x0001 {
let null_end = raw.iter().position(|&x| x == 0).unwrap_or(string_len);
let code = String::from_utf8_lossy(&raw[..null_end]).trim().to_string();
if !code.is_empty() {
return Ok(crate::types::OrderCode { code, v1, v2, v3 });
}
}
}
}
let code = scan_ascii_fields(&payload, 10, 4).into_iter().find(|s| {
let su = s.to_uppercase();
(su.starts_with("6ES") || su.starts_with("6AV") || su.starts_with("6GK"))
&& s.len() >= 10
&& s.bytes().all(|c| c.is_ascii_graphic() || c == b' ')
}).unwrap_or_default();
Ok(crate::types::OrderCode { code, v1, v2, v3 })
}
pub async fn get_cpu_info(&self) -> Result<crate::types::CpuInfo> {
let payload = self.read_szl_payload(0x001C, 0x0000).await?;
if payload.len() < 8 {
return Err(Error::UnexpectedResponse);
}
let mut b = payload.clone();
let szl_id = b.get_u16();
let _szl_idx = b.get_u16();
let entry_len = b.get_u16() as usize;
let entry_count = b.get_u16() as usize;
if szl_id == 0x001C && entry_len >= 4 && entry_count > 0 {
let mut module_type = String::new();
let mut module_type_canonical = String::new(); let mut serial_number = String::new();
let mut as_name = String::new();
let mut copyright = String::new();
let mut module_name = String::new();
for _ in 0..entry_count {
if b.remaining() < entry_len { break; }
let entry_idx = b.get_u16();
let string_len = entry_len - 2;
let raw = b.copy_to_bytes(string_len);
let null_end = raw.iter().position(|&x| x == 0).unwrap_or(string_len);
let val = String::from_utf8_lossy(&raw[..null_end]).trim().to_string();
match entry_idx {
0x0001 => { if as_name.is_empty() { as_name = val; } }
0x0002 => { if module_type.is_empty() { module_type = val; } }
0x0003 => { if module_name.is_empty() { module_name = val; } }
0x0004 => { if copyright.is_empty() { copyright = val; } }
0x0005 => { if serial_number.is_empty() { serial_number = val; } }
0x0007 => { if module_type_canonical.is_empty() { module_type_canonical = val; } }
_ => {}
}
}
if !module_type_canonical.is_empty() {
module_type = module_type_canonical;
}
if module_name.is_empty() && !as_name.is_empty() {
module_name = as_name.clone();
}
if !module_type.is_empty() || !serial_number.is_empty() || !as_name.is_empty() {
let protocol = detect_protocol(&payload, &module_type);
return Ok(crate::types::CpuInfo {
module_type,
serial_number,
as_name,
copyright,
module_name,
protocol,
});
}
}
let data = payload.as_ref();
let (module_type, serial_number, as_name, copyright, module_name) =
parse_sub_record_fields(data);
if !module_type.is_empty() || !serial_number.is_empty() {
let protocol = detect_protocol(&payload, &module_type);
return Ok(crate::types::CpuInfo {
module_type,
serial_number,
as_name,
copyright,
module_name,
protocol,
});
}
let mut module_type = String::new();
let mut serial_number = String::new();
let mut as_name = String::new();
let mut copyright = String::new();
let mut module_name = String::new();
let mut scan = 0;
while scan < data.len() {
if data[scan].is_ascii_graphic() || data[scan] == b' ' {
let start = scan;
while scan < data.len() && (data[scan].is_ascii_graphic() || data[scan] == b' ') {
scan += 1;
}
let val = String::from_utf8_lossy(&data[start..scan]).trim().to_string();
if val.len() >= 3 {
let tag = if start >= 2 && data[start - 2] == 0x00 {
Some(data[start - 1])
} else {
None
};
let su = val.to_uppercase();
if su.contains("BOOT") || su.starts_with("P B") || su.starts_with("HBOOT") {
} else if tag == Some(0x07) && module_type.is_empty() {
module_type = val;
} else if tag == Some(0x08) && module_name.is_empty() {
module_name = val;
} else if tag == Some(0x05) && as_name.is_empty() {
as_name = val;
} else if tag == Some(0x06) && copyright.is_empty() {
copyright = val;
} else if tag == Some(0x04) && serial_number.is_empty() {
serial_number = val;
} else if val.contains('-')
&& val.chars().filter(|c| c.is_ascii_digit()).count() >= 4
&& !val.starts_with("6ES7")
&& serial_number.is_empty()
{
serial_number = val;
} else if su.contains("CPU") && su.contains("PN") && module_type.is_empty() {
module_type = val;
} else if module_type.is_empty() && val.len() >= 8 && !su.contains("MC_") {
module_type = val;
}
}
} else {
scan += 1;
}
}
let protocol = detect_protocol(&payload, &module_type);
Ok(crate::types::CpuInfo {
module_type,
serial_number,
as_name,
copyright,
module_name,
protocol,
})
}
pub async fn get_cp_info(&self) -> Result<crate::types::CpInfo> {
let payload = self.read_szl_payload(0x0131, 0x0001).await?;
let mut b = payload.clone();
if b.remaining() < 8 {
return Ok(crate::types::CpInfo {
max_pdu_len: 0, max_connections: 0, max_mpi_rate: 0, max_bus_rate: 0,
});
}
let szl_id = b.get_u16();
let _szl_idx = b.get_u16();
let entry_len = b.get_u16() as usize;
let entry_count = b.get_u16() as usize;
if szl_id == 0x0131 && entry_len >= 12 && entry_count >= 1 && b.remaining() >= entry_len {
let _entry_idx = b.get_u16();
let max_pdu_len = b.get_u16() as u32;
let max_connections = b.get_u16() as u32;
let max_mpi_rate = b.get_u32();
let max_bus_rate = b.get_u32();
return Ok(crate::types::CpInfo {
max_pdu_len,
max_connections,
max_mpi_rate,
max_bus_rate,
});
}
Ok(crate::types::CpInfo {
max_pdu_len: 0,
max_connections: 0,
max_mpi_rate: 0,
max_bus_rate: 0,
})
}
pub async fn read_module_list(&self) -> Result<Vec<crate::types::ModuleEntry>> {
let payload = self.read_szl_payload(0x00A0, 0x0000).await?;
if payload.len() < 6 {
return Ok(Vec::new());
}
let mut b = payload;
let _block_len = b.get_u16();
let _szl_id = b.get_u16();
let _szl_ix = b.get_u16();
skip_szl_entry_header(&mut b);
let mut modules = Vec::new();
while b.remaining() >= 2 {
modules.push(crate::types::ModuleEntry {
module_type: b.get_u16(),
});
}
Ok(modules)
}
pub async fn list_blocks(&self) -> Result<crate::types::BlockList> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::from_static(&[0x00, 0x01, 0x12, 0x04, 0x11, 0x43, 0x01, 0x00]);
let data = Bytes::from_static(&[0x0A, 0x00, 0x00, 0x00]);
Self::send_s7(&mut inner, param, data, pdu_ref, PduType::UserData).await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
if body.remaining() < header.param_len as usize {
return Err(Error::UnexpectedResponse);
}
body.advance(header.param_len as usize);
if body.remaining() < 4 {
return Ok(crate::types::BlockList { total_count: 0, entries: Vec::new() });
}
let _ret_val = body.get_u8();
let _tr_size = body.get_u8();
let data_len = body.get_u16() as usize;
if data_len < 28 || body.remaining() < 28 {
return Ok(crate::types::BlockList { total_count: 0, entries: Vec::new() });
}
let mut entries = Vec::new();
let mut total_count: u32 = 0;
for _ in 0..7 {
let _zero = body.get_u8();
let block_type = body.get_u8() as u16;
let count = body.get_u16();
total_count += count as u32;
entries.push(crate::types::BlockListEntry { block_type, count });
}
Ok(crate::types::BlockList { total_count, entries })
}
pub async fn list_blocks_of_type(&self, block_type: u8) -> Result<Vec<u16>> {
let mut numbers: Vec<u16> = Vec::new();
let mut first = true;
let mut seq: u8 = 0x00;
loop {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let (param, data) = if first {
let mut p = BytesMut::with_capacity(8);
p.extend_from_slice(&[0x00, 0x01, 0x12, 0x04, 0x11, 0x43, 0x02, 0x00]);
let mut d = BytesMut::with_capacity(6);
d.extend_from_slice(&[0xFF, 0x09, 0x00, 0x02, 0x30, block_type]);
(p.freeze(), d.freeze())
} else {
let mut p = BytesMut::with_capacity(12);
p.extend_from_slice(&[0x00, 0x01, 0x12, 0x08, 0x12, 0x43, 0x02, seq, 0x00, 0x00, 0x00, 0x00]);
let d = Bytes::from_static(&[0x0A, 0x00, 0x00, 0x00]);
(p.freeze(), d)
};
Self::send_s7(&mut inner, param, data, pdu_ref, PduType::UserData).await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
if body.remaining() < header.param_len as usize {
return Err(Error::UnexpectedResponse);
}
let param_bytes = body.slice(..header.param_len as usize);
let done = param_bytes.len() >= 10 && param_bytes[8] == 0x00;
seq = if param_bytes.len() >= 8 { param_bytes[7] } else { 0 };
body.advance(header.param_len as usize);
drop(inner);
if body.remaining() < 4 { break; }
let ret_val = body.get_u8();
let _tr_size = body.get_u8();
let data_len = body.get_u16() as usize;
if ret_val != 0xFF || data_len < 4 || body.remaining() < data_len { break; }
let item_count = ((data_len - 4) / 4) + 1;
for _ in 0..item_count {
if body.remaining() < 4 { break; }
let block_num = body.get_u16();
let _unknown = body.get_u8();
let _lang = body.get_u8();
numbers.push(block_num);
}
first = false;
if done { break; }
}
numbers.sort_unstable();
Ok(numbers)
}
async fn block_info_query(
&self,
_func: u8,
block_type: u8,
block_number: u16,
) -> Result<Bytes> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::from_static(&[0x00, 0x01, 0x12, 0x04, 0x11, 0x43, 0x03, 0x00]);
let mut data_buf = BytesMut::with_capacity(12);
data_buf.extend_from_slice(&[0xFF, 0x09, 0x00, 0x08, 0x30, block_type]);
let n = block_number as u32;
data_buf.put_u8((n / 10000) as u8 + 0x30);
data_buf.put_u8(((n % 10000) / 1000) as u8 + 0x30);
data_buf.put_u8(((n % 1000) / 100) as u8 + 0x30);
data_buf.put_u8(((n % 100) / 10) as u8 + 0x30);
data_buf.put_u8((n % 10) as u8 + 0x30);
data_buf.put_u8(0x41);
Self::send_s7(&mut inner, param, data_buf.freeze(), pdu_ref, PduType::UserData).await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
let param_len = header.param_len as usize;
if body.remaining() < param_len {
return Err(Error::UnexpectedResponse);
}
let params = body.slice(..param_len);
body.advance(param_len);
if params.len() >= 12 {
let err_no = u16::from_be_bytes([params[10], params[11]]);
if err_no != 0 {
return Err(Error::PlcError {
code: err_no as u32,
message: format!("block info error: ErrNo=0x{err_no:04X}"),
});
}
}
if body.remaining() < 4 {
return Err(Error::UnexpectedResponse);
}
let ret_val = body.get_u8();
let _tr_size = body.get_u8();
let _data_len = body.get_u16();
if ret_val != 0xFF {
return Err(Error::PlcError {
code: ret_val as u32,
message: format!("block info RetVal=0x{ret_val:02X}"),
});
}
Ok(body.copy_to_bytes(body.remaining()))
}
pub async fn get_ag_block_info(
&self,
block_type: u8,
block_number: u16,
) -> Result<crate::types::BlockInfo> {
self.get_block_info(0x13, block_type, block_number).await
}
pub async fn get_pg_block_info(
&self,
block_type: u8,
block_number: u16,
) -> Result<crate::types::BlockInfo> {
self.get_block_info(0x14, block_type, block_number).await
}
async fn get_block_info(
&self,
func: u8,
block_type: u8,
block_number: u16,
) -> Result<crate::types::BlockInfo> {
let payload = self
.block_info_query(func, block_type, block_number)
.await?;
if payload.len() < 40 {
return Err(Error::UnexpectedResponse);
}
let mut b = payload;
let _cst_b = b.get_u8();
let blk_type: u16 = b.get_u8().into();
let _cst_w1 = b.get_u16();
let _cst_w2 = b.get_u16();
let _cst_pp = b.get_u16();
let _unknown_1 = b.get_u8();
let flags = b.get_u8() as u16;
let language = b.get_u8() as u16;
let _sub_blk = b.get_u8();
let _blk_number = b.get_u16(); let len_load_mem = b.get_u32();
let _blk_sec = b.get_u32();
let _code_ms = b.get_u32();
let _code_dy = b.get_u16();
let _intf_ms = b.get_u32();
let _intf_dy = b.get_u16();
let sbb_len = b.get_u16();
let _add_len = b.get_u16();
let local_data = b.get_u16();
let mc7_size = b.get_u16();
fn read_str(b: &mut Bytes, n: usize) -> String {
let s = b.slice(..n.min(b.remaining()));
b.advance(n.min(b.remaining()));
let end = s.iter().position(|&x| x == 0).unwrap_or(s.len());
String::from_utf8_lossy(&s[..end]).trim().to_string()
}
let author = read_str(&mut b, 8);
let family = read_str(&mut b, 8);
let header = read_str(&mut b, 8);
let version = if b.remaining() >= 1 { b.get_u8() as u16 } else { 0 };
let _unk2 = if b.remaining() >= 1 { b.get_u8() } else { 0 };
let checksum = if b.remaining() >= 2 { b.get_u16() } else { 0 };
Ok(crate::types::BlockInfo {
block_type: blk_type,
block_number,
language,
flags,
size: (len_load_mem.min(0xFFFF)) as u16,
size_ram: sbb_len,
mc7_size,
local_data,
checksum,
version,
author,
family,
header,
date: String::new(),
})
}
pub async fn set_session_password(&self, password: &str) -> Result<()> {
let encrypted = crate::types::encrypt_password(password);
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::copy_from_slice(&[0x12, 0x00]);
let data = Bytes::copy_from_slice(&encrypted);
Self::send_s7(&mut inner, param, data, pdu_ref, PduType::Job).await?;
let (header, _body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "set_session_password")?;
Ok(())
}
pub async fn clear_session_password(&self) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let param = Bytes::copy_from_slice(&[0x11, 0x00]);
Self::send_s7(&mut inner, param, Bytes::new(), pdu_ref, PduType::Job).await?;
let (header, _body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "clear_session_password")?;
Ok(())
}
pub async fn get_protection(&self) -> Result<crate::types::Protection> {
let payload = self.read_szl_payload(0x0032, 0x0004).await?;
if payload.len() < 14 {
return Err(Error::UnexpectedResponse);
}
let mut b = payload;
let _block_len = b.get_u16();
let _szl_id = b.get_u16();
let _szl_ix = b.get_u16();
skip_szl_entry_header(&mut b);
let scheme_szl = b.get_u16();
let scheme_module = b.get_u16();
let scheme_bus = b.get_u16();
let level = b.get_u16();
let pass_wort = if b.remaining() >= 8 {
String::from_utf8_lossy(&b[..8]).trim().to_string()
} else {
String::new()
};
let password_set = pass_wort.eq_ignore_ascii_case("PASSWORD");
Ok(crate::types::Protection {
scheme_szl,
scheme_module,
scheme_bus,
level,
password_set,
})
}
pub async fn delete_block(&self, block_type: u8, block_number: u16) -> Result<()> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let mut param = BytesMut::with_capacity(6);
param.extend_from_slice(&[0x1F, 0x00, block_type, 0x00]);
param.put_u16(block_number);
Self::send_s7(
&mut inner,
param.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, _body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "delete_block")?;
Ok(())
}
pub async fn upload(&self, block_type: u8, block_number: u16) -> Result<Vec<u8>> {
let mut inner = self.inner.lock().await;
let pdu_ref = Self::next_pdu_ref(&mut inner);
let mut param = BytesMut::with_capacity(6);
param.extend_from_slice(&[0x1D, 0x00, block_type, 0x00]);
param.put_u16(block_number);
Self::send_s7(
&mut inner,
param.freeze(),
Bytes::new(),
pdu_ref,
PduType::Job,
)
.await?;
let (header, mut body) = Self::recv_s7(&mut inner).await?;
check_plc_error(&header, "upload_start")?;
if body.remaining() < 8 {
return Err(Error::UnexpectedResponse);
}
if body.remaining() >= 2 {
body.advance(2); }
let upload_id = body.get_u32();
let _total_len = body.get_u32();
let mut block_data = Vec::new();
loop {
let chunk_pdu_ref = Self::next_pdu_ref(&mut inner);
let mut dparam = BytesMut::with_capacity(6);
dparam.extend_from_slice(&[0x1D, 0x01]);
dparam.put_u32(upload_id);
Self::send_s7(
&mut inner,
dparam.freeze(),
Bytes::new(),
chunk_pdu_ref,
PduType::Job,
)
.await?;
let (dheader, mut dbody) = Self::recv_s7(&mut inner).await?;
check_plc_error(&dheader, "upload_data")?;
if dbody.remaining() >= 2 {
dbody.advance(2);
}
if dbody.is_empty() {
break; }
if block_data.is_empty() && dbody.remaining() >= 4 {
if dbody[0] == 0xFF || dbody[0] == 0x00 {
dbody.advance(4);
}
}
let chunk = dbody.copy_to_bytes(dbody.remaining());
block_data.extend_from_slice(&chunk);
if chunk.len() < inner.connection.pdu_size as usize - 50 {
break;
}
if block_data.len() > 1024 * 1024 * 4 {
return Err(Error::UnexpectedResponse);
}
}
let end_pdu_ref = Self::next_pdu_ref(&mut inner);
let mut eparam = BytesMut::with_capacity(6);
eparam.extend_from_slice(&[0x1D, 0x02]);
eparam.put_u32(upload_id);
Self::send_s7(
&mut inner,
eparam.freeze(),
Bytes::new(),
end_pdu_ref,
PduType::Job,
)
.await?;
let (eheader, _ebody) = Self::recv_s7(&mut inner).await?;
check_plc_error(&eheader, "upload_end")?;
Ok(block_data)
}
pub async fn db_get(&self, db_number: u16) -> Result<Vec<u8>> {
self.upload(0x41, db_number).await }
pub async fn download(&self, block_type: u8, block_number: u16, data: &[u8]) -> Result<()> {
let total_len = data.len() as u32;
let mut inner = self.inner.lock().await;
let pdu_avail = (inner.connection.pdu_size as usize).saturating_sub(50);
let start_ref = Self::next_pdu_ref(&mut inner);
let mut sparam = BytesMut::with_capacity(10);
sparam.extend_from_slice(&[0x1E, 0x00, block_type, 0x00]);
sparam.put_u16(block_number);
sparam.put_u32(total_len);
let chunk_len = pdu_avail.min(data.len());
let first_chunk = Bytes::copy_from_slice(&data[..chunk_len]);
Self::send_s7(
&mut inner,
sparam.freeze(),
first_chunk,
start_ref,
PduType::Job,
)
.await?;
let (sheader, mut sbody) = Self::recv_s7(&mut inner).await?;
check_plc_error(&sheader, "download_start")?;
if sbody.remaining() >= 2 {
sbody.advance(2); }
if sbody.remaining() < 4 {
return Err(Error::UnexpectedResponse);
}
let download_id = sbody.get_u32();
let mut offset = chunk_len;
while offset < data.len() {
let chunk_ref = Self::next_pdu_ref(&mut inner);
let end = (offset + pdu_avail).min(data.len());
let chunk = Bytes::copy_from_slice(&data[offset..end]);
let mut dparam = BytesMut::with_capacity(6);
dparam.extend_from_slice(&[0x1E, 0x01]);
dparam.put_u32(download_id);
Self::send_s7(
&mut inner,
dparam.freeze(),
chunk,
chunk_ref,
PduType::Job,
)
.await?;
let (dheader, _dbody) = Self::recv_s7(&mut inner).await?;
check_plc_error(&dheader, "download_data")?;
offset = end;
}
let end_ref = Self::next_pdu_ref(&mut inner);
let mut eparam = BytesMut::with_capacity(6);
eparam.extend_from_slice(&[0x1E, 0x02]);
eparam.put_u32(download_id);
Self::send_s7(
&mut inner,
eparam.freeze(),
Bytes::new(),
end_ref,
PduType::Job,
)
.await?;
let (eheader, _ebody) = Self::recv_s7(&mut inner).await?;
check_plc_error(&eheader, "download_end")?;
Ok(())
}
pub async fn db_fill(&self, db_number: u16, value: u8) -> Result<()> {
let info = self.get_ag_block_info(0x41, db_number).await?; let size = info.size as usize;
if size == 0 {
return Err(Error::PlcError {
code: 0,
message: format!("DB{db_number} has zero size"),
});
}
let data = vec![value; size];
let chunk_size = 240usize; for offset in (0..size).step_by(chunk_size) {
let end = (offset + chunk_size).min(size);
self.db_write(db_number, offset as u32, &data[offset..end])
.await?;
}
Ok(())
}
}
fn skip_szl_entry_header(data: &mut Bytes) {
if data.len() >= 2 && data[0] == 0x00 && data[1] > 0 && data[1] <= 200 {
data.advance(2);
}
}
fn scan_ascii_fields(data: &[u8], max_count: usize, min_len: usize) -> Vec<String> {
let mut fields = Vec::new();
let mut i = 0;
while i < data.len() && fields.len() < max_count {
if !data[i].is_ascii_graphic() && data[i] != b' ' {
i += 1;
continue;
}
let start = i;
while i < data.len() && (data[i].is_ascii_graphic() || data[i] == b' ') {
i += 1;
}
let s = String::from_utf8_lossy(&data[start..i]).trim().to_string();
if s.len() >= min_len {
fields.push(s);
}
}
fields
}
fn parse_sub_record_fields(b: &[u8]) -> (String, String, String, String, String) {
let mut module_type = String::new();
let mut serial_number = String::new();
let mut as_name = String::new();
let mut copyright = String::new();
let mut module_name = String::new();
let mut i = 0;
while i + 2 < b.len() {
if b[i] == 0x00 && (1..=8).contains(&b[i + 1]) {
let tag = b[i + 1];
let start = i + 2;
let mut end = start;
while end < b.len() && b[end] != 0x00 {
end += 1;
}
let raw = &b[start..end];
let val = String::from_utf8_lossy(raw).trim().to_string();
let su = val.to_uppercase();
if !val.is_empty() && !su.contains("BOOT") && !su.starts_with("P B") {
match tag {
0x01 => {
if !val.starts_with("6ES") && module_type.is_empty() {
module_type = val;
}
}
0x05 => { if as_name.is_empty() { as_name = val; } }
0x06 => { if serial_number.is_empty() { serial_number = val; } }
0x07 => { if module_type.is_empty() { module_type = val; } }
0x08 => { if module_name.is_empty() { module_name = val; } }
_ => {}
}
}
i = end;
} else {
i += 1;
}
}
if copyright.is_empty() {
let mut scan = 0;
while scan < b.len() {
if b[scan].is_ascii_graphic() || b[scan] == b' ' {
let s = scan;
while scan < b.len() && (b[scan].is_ascii_graphic() || b[scan] == b' ') {
scan += 1;
}
let val = String::from_utf8_lossy(&b[s..scan]).trim().to_string();
let su = val.to_uppercase();
if val.len() >= 3 {
if su.contains("BOOT") || su.starts_with("P B") {
copyright = val;
break;
}
}
} else {
scan += 1;
}
}
}
(module_type, serial_number, as_name, copyright, module_name)
}
fn detect_protocol(_payload: &[u8], module_type: &str) -> crate::types::Protocol {
let upper = module_type.to_uppercase();
let is_s7plus = upper.contains("1500")
|| upper.contains("1200")
|| upper.contains("ET 200SP")
|| upper.contains("ET200SP")
|| (upper.contains("CPU") && {
let after_cpu = upper.find("CPU").map(|i| &upper[i+3..]).unwrap_or("");
let num: String = after_cpu.chars().skip_while(|c| !c.is_ascii_digit()).take_while(|c| c.is_ascii_digit()).collect();
matches!(num.get(..2), Some("12") | Some("15"))
});
if is_s7plus {
crate::types::Protocol::S7Plus
} else {
crate::types::Protocol::S7
}
}
fn s7_error_description(ec: u8, ecd: u8) -> &'static str {
match (ec, ecd) {
(0x81, 0x04) => "function not supported or access denied by PLC",
(0x81, 0x01) => "reserved by HW or SW function not available",
(0x82, 0x04) => "PLC is in STOP mode, function not possible",
(0x05, 0x01) => "invalid block type number",
(0xD2, 0x01) => "object already exists, download rejected",
(0xD2, 0x02) => "object does not exist, upload failed",
(0xD6, 0x01) => "password protection violation",
(0xD6, 0x05) => "insufficient privilege for this operation",
_ => "unknown error",
}
}
fn check_plc_error(header: &S7Header, context: &str) -> Result<()> {
if let (Some(ec), Some(ecd)) = (header.error_class, header.error_code) {
if ec != 0 || ecd != 0 {
let detail = s7_error_description(ec, ecd);
return Err(Error::PlcError {
code: ((ec as u32) << 8) | ecd as u32,
message: format!("{}: {} (error_class=0x{ec:02X}, error_code=0x{ecd:02X})", context, detail),
});
}
}
Ok(())
}
impl S7Client<crate::transport::TcpTransport> {
pub async fn connect(addr: SocketAddr, params: ConnectParams) -> Result<Self> {
let transport =
crate::transport::TcpTransport::connect(addr, params.connect_timeout).await?;
Self::from_transport(transport, params).await
}
}
impl S7Client<crate::UdpTransport> {
pub async fn connect_udp(addr: SocketAddr, params: ConnectParams) -> Result<Self> {
let transport = crate::UdpTransport::connect(addr)
.await
.map_err(Error::Io)?;
Self::from_transport(transport, params).await
}
}
#[cfg(test)]
mod tests {
use super::*;
use bytes::BufMut;
use crate::proto::{
cotp::CotpPdu,
s7::{
header::{PduType, S7Header},
negotiate::NegotiateResponse,
},
tpkt::TpktFrame,
};
use tokio::io::{duplex, AsyncReadExt, AsyncWriteExt};
async fn mock_plc_db_read(mut server_io: tokio::io::DuplexStream, response_data: Vec<u8>) {
let mut buf = vec![0u8; 4096];
let _ = server_io.read(&mut buf).await;
let cc = CotpPdu::ConnectConfirm {
dst_ref: 1,
src_ref: 1,
};
let mut cb = BytesMut::new();
cc.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame {
payload: cb.freeze(),
}
.encode(&mut tb)
.unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let neg = NegotiateResponse {
max_amq_calling: 1,
max_amq_called: 1,
pdu_length: 480,
};
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData,
reserved: 0,
pdu_ref: 1,
param_len: 8,
data_len: 0,
error_class: Some(0),
error_code: Some(0),
}
.encode(&mut s7b);
neg.encode(&mut s7b);
let dt = CotpPdu::Data {
tpdu_nr: 0,
last: true,
payload: s7b.freeze(),
};
let mut cb = BytesMut::new();
dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame {
payload: cb.freeze(),
}
.encode(&mut tb)
.unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData,
reserved: 0,
pdu_ref: 2,
param_len: 2,
data_len: (4 + response_data.len()) as u16,
error_class: Some(0),
error_code: Some(0),
}
.encode(&mut s7b);
s7b.extend_from_slice(&[0x04, 0x01]); s7b.put_u8(0xFF); s7b.put_u8(0x04); s7b.put_u16((response_data.len() * 8) as u16);
s7b.extend_from_slice(&response_data);
let dt = CotpPdu::Data {
tpdu_nr: 0,
last: true,
payload: s7b.freeze(),
};
let mut cb = BytesMut::new();
dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame {
payload: cb.freeze(),
}
.encode(&mut tb)
.unwrap();
server_io.write_all(&tb).await.unwrap();
}
#[tokio::test]
async fn db_read_returns_data() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
let expected = vec![0xDE, 0xAD, 0xBE, 0xEF];
tokio::spawn(mock_plc_db_read(server_io, expected.clone()));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let data = client.db_read(1, 0, 4).await.unwrap();
assert_eq!(&data[..], &expected[..]);
}
async fn mock_plc_multi_read(
mut server_io: tokio::io::DuplexStream,
items: Vec<Vec<u8>>, ) {
let mut buf = vec![0u8; 4096];
let _ = server_io.read(&mut buf).await;
let cc = CotpPdu::ConnectConfirm { dst_ref: 1, src_ref: 1 };
let mut cb = BytesMut::new();
cc.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let neg = NegotiateResponse { max_amq_calling: 1, max_amq_called: 1, pdu_length: 480 };
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 1,
param_len: 8, data_len: 0, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
neg.encode(&mut s7b);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let item_count = items.len() as u8;
let mut data_bytes = BytesMut::new();
for item_data in &items {
data_bytes.put_u8(0xFF); data_bytes.put_u8(0x04); data_bytes.put_u16((item_data.len() * 8) as u16);
data_bytes.extend_from_slice(item_data);
if item_data.len() % 2 != 0 {
data_bytes.put_u8(0x00); }
}
let data_len = data_bytes.len() as u16;
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 2,
param_len: 2, data_len, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
s7b.extend_from_slice(&[0x04, item_count]); s7b.extend_from_slice(&data_bytes);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
#[tokio::test]
async fn read_multi_vars_returns_all_items() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
let item1 = vec![0xDE, 0xAD, 0xBE, 0xEF];
let item2 = vec![0x01, 0x02];
tokio::spawn(mock_plc_multi_read(server_io, vec![item1.clone(), item2.clone()]));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let items = [MultiReadItem::db(1, 0, 4), MultiReadItem::db(2, 10, 2)];
let results = client.read_multi_vars(&items).await.unwrap();
assert_eq!(results.len(), 2);
assert_eq!(&results[0][..], &item1[..]);
assert_eq!(&results[1][..], &item2[..]);
}
#[tokio::test]
async fn read_multi_vars_empty_returns_empty() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_multi_read(server_io, vec![]));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let results = client.read_multi_vars(&[]).await.unwrap();
assert!(results.is_empty());
}
async fn mock_plc_multi_write(
mut server_io: tokio::io::DuplexStream,
pdu_size: u16,
batches: Vec<usize>,
) {
let mut buf = vec![0u8; 65536];
let _ = server_io.read(&mut buf).await;
let cc = CotpPdu::ConnectConfirm { dst_ref: 1, src_ref: 1 };
let mut cb = BytesMut::new(); cc.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let neg = NegotiateResponse { max_amq_calling: 1, max_amq_called: 1, pdu_length: pdu_size };
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 1,
param_len: 8, data_len: 0, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
neg.encode(&mut s7b);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
for (i, item_count) in batches.iter().enumerate() {
let _ = server_io.read(&mut buf).await;
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: (i + 2) as u16,
param_len: 2, data_len: *item_count as u16,
error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
s7b.extend_from_slice(&[0x05, *item_count as u8]); for _ in 0..*item_count {
s7b.put_u8(0xFF); }
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
}
#[tokio::test]
async fn write_multi_vars_returns_ok() {
let (client_io, server_io) = duplex(65536);
let params = ConnectParams::default();
tokio::spawn(mock_plc_multi_write(server_io, 480, vec![2]));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let items = [
MultiWriteItem::db(1, 0, vec![0xAA, 0xBB, 0xCC, 0xDD]),
MultiWriteItem::db(2, 10, vec![0x01, 0x02]),
];
client.write_multi_vars(&items).await.unwrap();
}
#[tokio::test]
async fn write_multi_vars_empty_returns_ok() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_multi_write(server_io, 480, vec![]));
let client = S7Client::from_transport(client_io, params).await.unwrap();
client.write_multi_vars(&[]).await.unwrap();
}
#[tokio::test]
async fn write_multi_vars_batches_when_pdu_limit_exceeded() {
let (client_io, server_io) = duplex(65536);
let params = ConnectParams::default();
tokio::spawn(mock_plc_multi_write(server_io, 64, vec![1, 1]));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let items = [
MultiWriteItem::db(1, 0, vec![0x11u8; 20]),
MultiWriteItem::db(2, 0, vec![0x22u8; 20]),
];
client.write_multi_vars(&items).await.unwrap();
}
#[tokio::test]
async fn read_multi_vars_batches_when_pdu_limit_exceeded() {
use crate::proto::s7::negotiate::NegotiateResponse;
async fn mock_split_pdu(mut server_io: tokio::io::DuplexStream) {
let mut buf = vec![0u8; 4096];
let _ = server_io.read(&mut buf).await;
let cc = CotpPdu::ConnectConfirm { dst_ref: 1, src_ref: 1 };
let mut cb = BytesMut::new(); cc.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let neg = NegotiateResponse {
max_amq_calling: 1, max_amq_called: 1, pdu_length: 64,
};
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 1,
param_len: 8, data_len: 0, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
neg.encode(&mut s7b);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let payloads: &[&[u8]] = &[&[0x11u8; 30], &[0x22u8; 30]];
for (i, payload) in payloads.iter().enumerate() {
let _ = server_io.read(&mut buf).await;
let bit_len = (payload.len() * 8) as u16;
let mut data_bytes = BytesMut::new();
data_bytes.put_u8(0xFF);
data_bytes.put_u8(0x04);
data_bytes.put_u16(bit_len);
data_bytes.extend_from_slice(payload);
if payload.len() % 2 != 0 { data_bytes.put_u8(0x00); }
let data_len = data_bytes.len() as u16;
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: (i + 2) as u16,
param_len: 2, data_len, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
s7b.extend_from_slice(&[0x04, 0x01]);
s7b.extend_from_slice(&data_bytes);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
}
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_split_pdu(server_io));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let items = [MultiReadItem::db(1, 0, 30), MultiReadItem::db(2, 0, 30)];
let results = client.read_multi_vars(&items).await.unwrap();
assert_eq!(results.len(), 2);
assert_eq!(&results[0][..], &[0x11u8; 30][..]);
assert_eq!(&results[1][..], &[0x22u8; 30][..]);
}
async fn mock_handshake(server_io: &mut (impl AsyncRead + AsyncWrite + Unpin)) {
let mut buf = vec![0u8; 4096];
let _ = server_io.read(&mut buf).await;
let cc = CotpPdu::ConnectConfirm { dst_ref: 1, src_ref: 1 };
let mut cb = BytesMut::new(); cc.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
let _ = server_io.read(&mut buf).await;
let neg = NegotiateResponse { max_amq_calling: 1, max_amq_called: 1, pdu_length: 480 };
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 1,
param_len: 8, data_len: 0, error_class: Some(0), error_code: Some(0),
}.encode(&mut s7b);
neg.encode(&mut s7b);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
async fn mock_plc_control(
mut server_io: tokio::io::DuplexStream,
ok: bool,
) {
let mut buf = vec![0u8; 4096];
mock_handshake(&mut server_io).await;
let _ = server_io.read(&mut buf).await;
let (ec, ecd) = if ok { (0u8, 0u8) } else { (0x81u8, 0x04u8) };
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::AckData, reserved: 0, pdu_ref: 2,
param_len: 0, data_len: 0,
error_class: Some(ec), error_code: Some(ecd),
}.encode(&mut s7b);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
#[tokio::test]
async fn plc_stop_succeeds() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_control(server_io, true));
let client = S7Client::from_transport(client_io, params).await.unwrap();
client.plc_stop().await.unwrap();
}
#[tokio::test]
async fn plc_hot_start_succeeds() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_control(server_io, true));
let client = S7Client::from_transport(client_io, params).await.unwrap();
client.plc_hot_start().await.unwrap();
}
#[tokio::test]
async fn plc_cold_start_succeeds() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_control(server_io, true));
let client = S7Client::from_transport(client_io, params).await.unwrap();
client.plc_cold_start().await.unwrap();
}
#[tokio::test]
async fn plc_stop_rejected_returns_error() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_control(server_io, false));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let result = client.plc_stop().await;
assert!(result.is_err());
}
async fn mock_plc_status(
mut server_io: tokio::io::DuplexStream,
status_byte: u8,
) {
let mut buf = vec![0u8; 4096];
mock_handshake(&mut server_io).await;
let _ = server_io.read(&mut buf).await;
let mut szl_payload = [0u8; 12];
szl_payload[0..2].copy_from_slice(&0x0424u16.to_be_bytes());
szl_payload[6..8].copy_from_slice(&0x0001u16.to_be_bytes()); szl_payload[11] = status_byte;
let params: [u8; 8] = [0x00, 0x01, 0x12, 0x08, 0x12, 0x84, 0x01, 0x00];
let data_envelope: [u8; 4] = [0xFF, 0x09, 0x00, 0x0C];
let param_len = params.len() as u16;
let data_len = (data_envelope.len() + szl_payload.len()) as u16;
let mut s7b = BytesMut::new();
S7Header {
pdu_type: PduType::UserData, reserved: 0, pdu_ref: 2,
param_len, data_len,
error_class: None, error_code: None,
}.encode(&mut s7b);
s7b.extend_from_slice(¶ms);
s7b.extend_from_slice(&data_envelope);
s7b.extend_from_slice(&szl_payload);
let dt = CotpPdu::Data { tpdu_nr: 0, last: true, payload: s7b.freeze() };
let mut cb = BytesMut::new(); dt.encode(&mut cb);
let mut tb = BytesMut::new();
TpktFrame { payload: cb.freeze() }.encode(&mut tb).unwrap();
server_io.write_all(&tb).await.unwrap();
}
#[tokio::test]
async fn get_plc_status_returns_run() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_status(server_io, 0x08));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let status = client.get_plc_status().await.unwrap();
assert_eq!(status, crate::types::PlcStatus::Run);
}
#[tokio::test]
async fn get_plc_status_returns_stop() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_status(server_io, 0x04));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let status = client.get_plc_status().await.unwrap();
assert_eq!(status, crate::types::PlcStatus::Stop);
}
#[tokio::test]
async fn get_plc_status_returns_unknown() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_status(server_io, 0x00));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let status = client.get_plc_status().await.unwrap();
assert_eq!(status, crate::types::PlcStatus::Unknown);
}
#[tokio::test]
async fn get_plc_status_unknown_byte_returns_stop() {
let (client_io, server_io) = duplex(4096);
let params = ConnectParams::default();
tokio::spawn(mock_plc_status(server_io, 0xFF));
let client = S7Client::from_transport(client_io, params).await.unwrap();
let status = client.get_plc_status().await.unwrap();
assert_eq!(status, crate::types::PlcStatus::Stop);
}
}