1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
//! Contains basic implementations of mandated IEEE 488.2 commands.
//!
//! Mandatory IEEE488.2 commands:
//!
//! | Mnemonic | Name | 488.2 Section |
//! |----------|--------------------------------------|---------------|
//! | *CLS | Clear Status Command | 10.3 |
//! | *ESE | Standard Event Status Enable Command | 10.10 |
//! | *ESE? | Standard Event Status Enable Query | 10.11 |
//! | *ESR? | Standard Event Status Register Query | 10.12 |
//! | *IDN? | Identification Query | 10.14 |
//! | *OPC | Operation Complete Command | 10.18 |
//! | *OPC? | Operation Complete Query | 10.19 |
//! | *RST | Reset Command | 10.32 |
//! | *SRE | Service Request Enable Command | 10.34 |
//! | *SRE? | Service Request Enable Query | 10.35 |
//! | *STB | Read Status Byte Query | 10.36 |
//! | *TST | Self-Test Query | 10.38 |
//! | *WAI | Wait-To-Continue | 10.39 |
//!
//! Note that the comments about the default mandatory commands below are from the IEEE 488.2-1992 document and explain their purpose, not my implementation.
use crate::error::Result;
use crate::format::Character;
use crate::prelude::*;
use crate::{nquery, qonly};
use core::convert::TryInto;
///## 10.3 *CLS, Clear Status Command
///> The Clear Status command clears status data structures, see 11.1.2, and forces the device to the Operation Complete
///> Command Idle State and the Operation Complete Query Idle State, see 12.5.2 and 12.5.3.
///>
///> If the Clear Status command immediately follows a <PROGRAM MESSAGE TERMINATOR>, the Output Queue
///> and the MAV bit will be cleared because any new <PROGRAM MESSAGE> after a <PROGRAM MESSAGE
///> TERMINATOR> clears the Output Queue, see 6.3.2.3.
pub struct ClsCommand;
impl Command for ClsCommand {
nquery!();
fn event(&self, context: &mut Context, _args: &mut Tokenizer) -> Result<()> {
// Clear SESR
context.esr = 0;
// Clear operation register
context.operation.set_condition(0);
context.operation.clear_event();
// Clear questionable register
context.questionable.set_condition(0);
context.questionable.clear_event();
// Clear error buffer
context.errors.clear();
// Clear any device specific status
context.device.cls()
}
}
///## 10.10 *ESE, Standard Event Status Enable Command
///> The Standard Event Status Enable command sets the Standard Event Status Enable Register bits as defined in 11.5.1.3.
///## 10.11 *ESE?, Standard Event Status Enable Query
///> The Standard Event Status Enable query allows the programmer to determine the current contents of the Standard
///> Event Status Enable Register. See 11.5.1.3.
pub struct EseCommand;
impl Command for EseCommand {
fn event(&self, context: &mut Context, args: &mut Tokenizer) -> Result<()> {
if let Some(ese) = args.next_data(true)? {
//Try_into will automatically check min/max for ese datatype (u8)
context.ese = ese.try_into()?;
}
Ok(())
}
fn query(
&self,
context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response.data(context.ese).finish()
}
}
///## 10.12 *ESR?, Standard Event Status Register Query
///> The Standard Event Status Register query allows the programmer to determine the current contents of the Standard
///> Event Status Register. Reading the Standard Event Status Register clears it. See 11.5.1.2.
pub struct EsrCommand;
impl Command for EsrCommand {
qonly!();
fn query(
&self,
context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response
.data(core::mem::replace(&mut context.esr, 0))
.finish()
}
}
///## 10.14 *IDN?, Identification Query
///> The intent of the Identification query is for the unique identification of devices over the system interface.
///
///### 4.1.3.6 SCPI-99 Comments:
///> IEEE 488.2 is purposefully vague about the content of each of the four fields in the response
///> syntax. SCPI adds no further requirement, but here are some suggestions:
///>
///> All devices produced by a company should implement the *IDN? response consistently.
///> * Field 1, the Manufacturer field, should be identical for all devices produced by a single company.
///> * Field 2, the Model field, should NOT contain the word “MODEL”.
///> * Field 4, the Firmware level field, should contain information about all separately revisable subsystems.
///> This information can be contained in single or multiple revision codes.
pub struct IdnCommand<'a> {
pub manufacturer: &'a [u8],
pub model: &'a [u8],
pub serial: &'a [u8],
pub firmware: &'a [u8],
}
impl<'a> Command for IdnCommand<'a> {
qonly!();
fn query(
&self,
_context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response
.data(Character(self.manufacturer))
.data(Character(self.model))
.data(Character(self.serial))
.data(Character(self.firmware))
.finish()
}
}
///## 10.18 *OPC, Operation Complete Command
///> The Operation Complete command causes the device to generate the operation complete message in the Standard
///> Event Status Register when all pending selected device operations have been finished. See 12.5.2.2 for details of
///> operation.
///## 10.19 *OPC?, Operation Complete Query
///> The Operation Complete query places an ASCII character "1" into the device's Output Queue when all pending
///> selected device operations have been finished. See 12.5.3 for details of operation.
///
pub struct OpcCommand;
impl Command for OpcCommand {
fn event(&self, context: &mut Context, _args: &mut Tokenizer) -> Result<()> {
context.push_error(ErrorCode::OperationComplete.into());
Ok(())
}
fn query(
&self,
_context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response.data(true).finish()
}
}
///## 10.32 *RST, Reset Command
///> The Reset command performs a device reset. The Reset command is the third level of reset in a three-level reset
///> strategy, see 17.1.2 and Appendix D. The Reset command shall do the following:
///> * Except as explicitly excluded below, set the device-specific functions to a known state that is independent of
///> the past-use history of the device. Device-specific commands may be provided to program a different reset
///> * state than the original factory-supplied one.
///> * Set the macro defined by *DDT to a device-defined state, see 10.4.
///> * Disable macros, see 10.8.
///> * Force the device into the OCIS state, see 12.5.2.
///> * Force the device into the OQIS state, see 12.5.3.
///> The reset command explicitly shall NOT affect the following:
///> * The state of the IEEE 488.1 interface.
///> * The selected IEEE 488.1 address of the device.
///> * The Output Queue.
///> * Any Event Enable Register setting, including the Standard Event Status Enable Register settings, see
///> 11.4.2.3.4 and 11.5.1.3.4.
///> * Any Event Register setting, including the Standard Event Status Register settings, see 11.4.2.2.4 and
///> 11.5.1.2.4.
///> * The power-on-status-clear flag setting.
///> * Macros defined with the DeÞne Macro Contents command.
///> * Calibration data that affects device specifications.
///> * The Protected User Data query response.
///> * The Resource Description Transfer query response.
///> * The Service Request Enable Register setting, see 11.3.2.4.
///> * The Parallel Poll Enable Register setting, see 11.6.1.4.
///> * The memory register(s) associated with *SAV.
///> The scope of the *LRN? response and *RCL (if implemented) is the same as *RST. See 10.17.3 and 10.29.3.
pub struct RstCommand;
impl Command for RstCommand {
nquery!();
fn event(&self, context: &mut Context, _args: &mut Tokenizer) -> Result<()> {
context.device.rst()
}
}
///## 10.34 *SRE, Service Request Enable Command
///> The Service Request Enable command sets the Service Request Enable Register bits as defined in 11.3.2.
///## 10.35 *SRE?, Service Request Enable Query
///> The Service Request Enable query allows the programmer to determine the current contents of the Service Request
///> Enable Register, see 11.3.2.
pub struct SreCommand;
impl Command for SreCommand {
fn event(&self, context: &mut Context, args: &mut Tokenizer) -> Result<()> {
if let Some(sre) = args.next_data(true)? {
context.sre = sre.try_into()?;
}
Ok(())
}
fn query(
&self,
context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response.data(context.sre).finish()
}
}
///## 10.36 *STB?, Read Status Byte Query
///> The Read Status Byte query allows the programmer to read the status byte and Master Summary Status bit.
pub struct StbCommand;
impl Command for StbCommand {
qonly!();
fn query(
&self,
context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
// Set MAV bit as a message should always exist after
// a query even if there's no output buffer.
response.data(context.get_stb() | 0x10).finish()
}
}
///## 10.38 *TST?, Self-Test Query
///> The self-test query causes an internal self-test and places a response into the Output Queue indicating whether or not
///> the device completed the self-test without any detected errors. Optionally, information on why the self-test was not
///> completed may be contained in the response. The scope of the internal self-test shall appear in the device
///> documentation, see 4.9.
///>
///> The *TST? query shall not require any local operator interaction. It shall not create bus conditions that are violations
///> to the IEEE Std 488.1-1987 or IEEE Std 488.2-1992 standards. Otherwise, the scope of the self-test is completely
///> at the discretion of the device designer.
///>
///> Upon successful completion of *TST?, the device settings shall be restored to their values prior to the *TST?; set to
///> fixed, known values that are stated in the device documentation; or set to values deÞned by the user and stored in local
///> memory.
pub struct TstCommand;
impl Command for TstCommand {
qonly!();
fn query(
&self,
context: &mut Context,
_args: &mut Tokenizer,
response: &mut ResponseUnit,
) -> Result<()> {
response
.data(
context
.device
.tst()
.map(|_| 0i16)
.unwrap_or_else(|err| err.get_code()),
)
.finish()
}
}
///## 10.39 *WAI, Wait-to-Continue Command
///> The Wait-to-Continue command shall prevent the device from executing any further commands or queries until the no-
///> operation-pending flag is TRUE. See 12.5.1.
///>
///> NOTE - In a device that implements only sequential commands, the no-operation-pending flag is always TRUE
pub struct WaiCommand;
impl Command for WaiCommand {
nquery!();
fn event(&self, _context: &mut Context, _args: &mut Tokenizer) -> Result<()> {
Ok(())
}
}
#[macro_export]
macro_rules! ieee488_idn {
($manufacturer:expr, $model:expr, $serial:expr, $firmware:expr) => {
Node {
name: b"*IDN",
optional: false,
handler: Some(&IdnCommand {
manufacturer: $manufacturer,
model: $model,
serial: $serial,
firmware: $firmware,
}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_cls {
() => {
Node {
name: b"*CLS",
optional: false,
handler: Some(&ClsCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_ese {
() => {
Node {
name: b"*ESE",
optional: false,
handler: Some(&EseCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_esr {
() => {
Node {
name: b"*ESR",
optional: false,
handler: Some(&EsrCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_opc {
() => {
Node {
name: b"*OPC",
optional: false,
handler: Some(&OpcCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_rst {
() => {
Node {
name: b"*RST",
optional: false,
handler: Some(&RstCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_sre {
() => {
Node {
name: b"*SRE",
optional: false,
handler: Some(&SreCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_stb {
() => {
Node {
name: b"*STB",
optional: false,
handler: Some(&StbCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_tst {
() => {
Node {
name: b"*TST",
optional: false,
handler: Some(&TstCommand {}),
sub: &[],
}
};
}
#[macro_export]
macro_rules! ieee488_wai {
() => {
Node {
name: b"*WAI",
optional: false,
handler: Some(&WaiCommand {}),
sub: &[],
}
};
}