Struct pelcodrs::Message

pub struct Message(_);

Single command message object type.

There are several way to build a message:

• The main constructor Message::new() for "standard" messages.

• Use the builder pattern with MessageBuilder.

• Many convenient constructors are provided for "extended" commands.

• Message::from_bytes() allows to manually specify the address and data words bytes, and will automatically fill the sync byte and checksum.

• Full control of all the bytes values is possible with the trait implementaion From<[u8;7]>.

The bytes of a Message can be accessed with Message::as_ref().

Message objects can also be sent to the target device with PelcoDPort::send_message().

Methods

impl Message

pub fn new(
    address: u8,
    cmd1: Command1,
    cmd2: Command2,
    data1: u8,
    data2: u8
) -> Message

New "standard" command message. This constructor cannot be used for "extended" commands, for which dedicated constructors or Message::from_bytes() should be used.

Example:

let msg = Message::new(
    10,
    Command1::SENSE | Command1::CAMERA_ON_OFF,
    Command2::FOCUS_FAR | Command2::DOWN,
    0x00,
    0x40,
);
assert_eq!(&[0xFF, 0x0A, 0x88, 0x90, 0x00, 0x40, 0x62], msg.as_ref());

pub fn from_bytes(address: u8, words: [u8; 4]) -> Message

Alternate constructor taking the raw words to insert in the message. The sync byte and checksum automatically inserted.

pub fn set_preset(address: u8, preset_id: u8) -> Result<Message>

Set Preset. An error is returned if preset_id is 0, but special values (like "flip 180") are not checked.

pub fn clear_preset(address: u8, preset_id: u8) -> Result<Message>

Clear Preet. An error is returned if preset_id is 0.

pub fn go_to_preset(address: u8, preset_id: u8) -> Result<Message>

Call Preet. An error is returned if preset_id is 0.

pub fn flip_180(address: u8) -> Result<Message>

Call the special preset "rotate 180 degrees".

pub fn go_to_zero_pan(address: u8) -> Result<Message>

Call the special preset "Go To Zero Pan".

pub fn set_auxiliary(address: u8, sub_opcode: u8, aux_id: u8) -> Result<Message>

Set Auxiliary. No particular check is done on the arguments.

pub fn clear_auxiliary(
    address: u8,
    sub_opcode: u8,
    aux_id: u8
) -> Result<Message>

Clear Auxiliary. No particular check is done on the arguments.

pub fn remote_reset(address: u8) -> Result<Message>

Reset.

pub fn set_zone_start(address: u8, zone_id: u8) -> Result<Message>

Set Zone Start.

pub fn set_zone_end(address: u8, zone_id: u8) -> Result<Message>

Set Zone End.

pub fn write_char_to_screen(
    address: u8,
    column: u8,
    character: char
) -> Result<Message>

Write Character To Screen.

pub fn clear_screen(address: u8) -> Result<Message>

Clear Screen.

pub fn alarm_acknowledge(address: u8, alarm_no: u8) -> Result<Message>

Alarm Acknowledge.

pub fn zone_scan_on(address: u8) -> Result<Message>

Zone Scan On.

pub fn zone_scan_off(address: u8) -> Result<Message>

Zone Scan Off.

pub fn set_pattern_start(address: u8, pattern_id: u8) -> Result<Message>

Record Pattern Start.

pub fn set_pattern_stop(address: u8, pattern_id: u8) -> Result<Message>

Record Pattern End.

pub fn run_pattern(address: u8, pattern_id: u8) -> Result<Message>

Run Pattern.

pub fn set_zoom_speed(address: u8, speed: ZoomSpeed) -> Result<Message>

Set Zoom Speed.

pub fn set_focus_speed(address: u8, speed: FocusSpeed) -> Result<Message>

Set Focus Speed.

pub fn reset_camera_to_defaults(address: u8) -> Result<Message>

Reset Camera to Defaults.

pub fn auto_focus(address: u8, ctrl: AutoCtrl) -> Result<Message>

Auto Focus.

pub fn auto_iris(address: u8, cmd: AutoCtrl) -> Result<Message>

Auto Iris.

pub fn agc(address: u8, cmd: AutoCtrl) -> Result<Message>

AGC.

pub fn backlight_compensation(address: u8, ctrl: OnOff) -> Result<Message>

Backlight Compensation.

pub fn auto_white_balance(address: u8, ctrl: OnOff) -> Result<Message>

Auto White Balance.

pub fn enable_device_phase_delay_mode(address: u8) -> Result<Message>

Enable Device Phase Delay Mode.

pub fn set_shutter_speed(address: u8, ctrl: ShutterSpeed) -> Result<Message>

Set Shutter Speed.

pub fn adjust_line_lock_phase_delay(
    address: u8,
    ctrl: AdjustmentValue
) -> Result<Message>

Adjust Line Lock Phase Delay.

pub fn adjust_white_balance_rb(
    address: u8,
    ctrl: AdjustmentValue
) -> Result<Message>

Adjust White Balance (R-B)

pub fn adjust_white_balance_mg(
    address: u8,
    ctrl: AdjustmentValue
) -> Result<Message>

Adjust White Balance (M-G)

pub fn adjust_gain(address: u8, ctrl: AdjustmentValue) -> Result<Message>

Adjust Gain.

pub fn adjust_auto_iris_level(
    address: u8,
    ctrl: AdjustmentValue
) -> Result<Message>

Adjust Auto-Iris Level

pub fn adjust_auto_iris_peak(
    address: u8,
    ctrl: AdjustmentValue
) -> Result<Message>

Adjust Auto-Iris Peak Value.

pub fn query() -> Result<Message>

Query.

Trait Implementations

impl AsRef<[u8]> for Message

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl From<[u8; 7]> for Message

fn from(array: [u8; 7]) -> Self

Create a Message by specifying all the bytes manually:

let msg = Message::from([11, 22, 33, 44, 55, 66, 77]);
assert_eq!(&[11, 22, 33, 44, 55, 66, 77], msg.as_ref());

impl From<MessageBuilder> for Message

fn from(draft: MessageBuilder) -> Self

Performs the conversion.

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Message

impl PartialEq<Message> for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl Debug for Message

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'_> TryFrom<&'_ [u8]> for Message

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.