Struct resol_vbus::Telegram
source · Expand description
The Telegram
type stores information according to the VBus protocol version 3.x.
Telegrams are used to transmit small amount of information (up to 21 bytes of payload).
The “identity” of Telegram
values
As described in the corresponding section of the Header
struct VBus data types use
some of their fields as part of their “identity”. In addition to the fields used by the
Header
type the Telegram
type also respects the command
field. That means that two
Telegram
with differing timestamp
and frame_data
fields are still considered
“identical”, if the other fields match.
Fields§
§header: Header
The shared Header
of all VBus protocol types.
command: u8
The command of this Telegram
.
frame_data: [u8; 21]
The actual data from the frames attached to this Telegram
.
Implementations§
source§impl Telegram
impl Telegram
sourcepub fn frame_count_from_command(command: u8) -> u8
pub fn frame_count_from_command(command: u8) -> u8
Get number of frames from a VBus protocol version 3.x command.
Examples
use resol_vbus::Telegram;
assert_eq!(0, Telegram::frame_count_from_command(0x1F));
assert_eq!(1, Telegram::frame_count_from_command(0x3F));
assert_eq!(2, Telegram::frame_count_from_command(0x5F));
assert_eq!(3, Telegram::frame_count_from_command(0x7F));
sourcepub fn frame_count(&self) -> u8
pub fn frame_count(&self) -> u8
Get number of 7-byte frames attached to this Telegram
.
Examples
use resol_vbus::{Telegram, Header};
use resol_vbus::utils::utc_timestamp;
let tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x37,
frame_data: [0u8; 21],
};
assert_eq!(1, tgram.frame_count());
sourcepub fn valid_frame_data_len(&self) -> usize
pub fn valid_frame_data_len(&self) -> usize
Return the length of the valid area of the frame_data
.
Examples
use resol_vbus::{Telegram, Header};
use resol_vbus::utils::utc_timestamp;
let tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x37,
frame_data: [0u8; 21],
};
assert_eq!(7, tgram.valid_frame_data_len());
sourcepub fn valid_frame_data(&self) -> &[u8] ⓘ
pub fn valid_frame_data(&self) -> &[u8] ⓘ
Return the valid area of the frame_data
immutably.
Examples
use resol_vbus::{Telegram, Header};
use resol_vbus::utils::utc_timestamp;
let tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x37,
frame_data: [0u8; 21],
};
assert_eq!(7, tgram.valid_frame_data().len());
sourcepub fn valid_frame_data_mut(&mut self) -> &mut [u8] ⓘ
pub fn valid_frame_data_mut(&mut self) -> &mut [u8] ⓘ
Return the valid area of the frame_data
mutably.
Examples
use resol_vbus::{Telegram, Header};
use resol_vbus::utils::utc_timestamp;
let mut tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x37,
frame_data: [0u8; 21],
};
assert_eq!(7, tgram.valid_frame_data_mut().len());
sourcepub fn id_string(&self) -> String
pub fn id_string(&self) -> String
Creates an identification string for this Telegram
.
The string contains all fields that count towards the “identity” of the Telegram
:
channel
destination_address
source_address
protocol_version
command
Examples
use resol_vbus::{Telegram, Header};
use resol_vbus::utils::utc_timestamp;
let tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x17,
frame_data: [0u8; 21],
};
assert_eq!("11_1213_1415_36_17", tgram.id_string());
Trait Implementations§
source§impl IdHash for Telegram
impl IdHash for Telegram
source§fn id_hash<H: Hasher>(&self, h: &mut H)
fn id_hash<H: Hasher>(&self, h: &mut H)
Returns an identification hash for this Telegram
.
The hash contains all fields that count towards the “identity” of the Telegram
:
channel
destination_address
source_address
protocol_version
command
Examples
use resol_vbus::{Header, Telegram, id_hash};
use resol_vbus::utils::utc_timestamp;
let tgram = Telegram {
header: Header {
timestamp: utc_timestamp(1485688933),
channel: 0x11,
destination_address: 0x1213,
source_address: 0x1415,
protocol_version: 0x36,
},
command: 0x17,
frame_data: [0u8; 21],
};
assert_eq!(7671625633196679790, id_hash(&tgram));