EndScan
Dish Leaf Node provides API for end-scan workflow. The EndScan command is a long-running command that officially terminates an active scan observation.
The Dish Leaf Node accepts the command if :—
The dish is in one of the following operating modes:
OPERATE
STANDBY_FP
STOW
MAINTENANCE
The Dish Master is online and responsive.
The following state requirements are applied for command execution :-
The dish must be in OPERATE, STANDBY_FP, STOW, or MAINTENANCE mode.
The Dish Master must remain reachable during execution.
No input JSON is required
The EndScan command takes no arguments.
No JSON parsing or schema validation is performed.
The command execution involves the following key operations :-
Connect to Dish Master A connection to the Dish Master device is established.
Invoke EndScan on Dish Master The command is sent directly to clear the scanID attribute on the Dish Master, marking the scan as complete.
Result Handling
If accepted, Dish Master returns ResultCode.QUEUED.
A unique command ID is stored in
command_unique_id_dict["EndScan"].Final result is delivered asynchronously via the long-running command result attribute.
The TMC Dish Leaf Node monitors progress via long-running command results :-
Command is successful when:
The Dish Master reports ResultCode.OK on its longRunningCommandResult attribute.
The scanID is successfully cleared.
Final status: ResultCode.OK on the TMC Dish Leaf Node.
Command fails if any of the following occur:
Dish Master reports FAILED, REJECTED, or NOT_ALLOWED.
The command times out (exceeds command_timeout from Helm configuration).
Final status: ResultCode.FAILED with error details.
No input JSON schema
The EndScan command requires no input.
Schema URL: Not applicable