CommandIssued#

class lsst.ts.attcpip.CommandIssued(name)#

Bases: object

Track the progress of a low-level controller command.

Parameters:
  • timestamp (float) – The TAI unix timestamp [sec] at which the command was issued.

  • name (str) – The name of the command.

ack_timestamp#

The TAI unix timestamp [sec] at which an ACK or NOACK was received.

Type:

float

done_timestamp#

The TAI unix timestamp [sec] at which a SUCCESS or FAIL was received.

Type:

float

done#

Future which ends as follows:

  • result = None when the command has ended successfully.

  • salobj.ExpectedError if the command has ended in an error.

Type:

asyncio.Future

Methods Summary

set_ack()

Report a command as acknowledged, meaning accepted to be executed.

set_fail(reason)

Report a command as failed during execution.

set_noack()

Report a command as not acknowledged.

set_success()

Report a command as successfully executed.

Methods Documentation

set_ack()#

Report a command as acknowledged, meaning accepted to be executed.

Return type:

None

set_fail(reason)#

Report a command as failed during execution.

Parameters:

reason (str) – The reason why the command failed.

Return type:

None

set_noack()#

Report a command as not acknowledged.

This means there was an issue with the command format (e.g. the command name or one of more of its parameters were wrong).

Return type:

None

set_success()#

Report a command as successfully executed.

Return type:

None