ready()

let the sergeant get ready for communication

Params:

No params

Return:

This is a pipeline operation, return the sergeant instance

sergeant = Sergeant(client_addr=(loc, port),
                    sim=myhome).ready()

🚧

Call ready only if simulation already setup

Because the sergeant need to tell the programming side about the simulation environment information, when call ready, the sergeant immediately dumps all information for the other side to receive. If you call before simulation complete setting up, the other side will have information missing, or even worse: have inconsistent states.