Update the API in Readme.md

This commit is contained in:
Loic Guegan 2022-06-09 21:57:21 +02:00
parent 03eab9f6b3
commit 266292a66a

View file

@ -17,14 +17,16 @@ It is a short learning curve and coarse-grain network simulator. It contains the
**Current API:**
- `api.args`
- `api.send(interface, data,size, dst)`
- `api.sendt(interface, data,size, dst,timeout)`
- `api.receive(interface)`
- `api.receivet(interface,timeout)`
- `api.clock()`
- `api.log(msg)`
- `api.wait(duration)`
- `api.turn_off(duration)`
- `api.send(<int>,<data>,<size>,<dst>)`
- `api.sendt(<int>,<data>,<size>,<dst>,<t>)`
- `api.receive(<int>)`
- `api.receivet(<int>,<t>)`
- `api.wait(<t>)`
- `api.wait_end()`
- `api.log(<message>)`
- `api.read(<register>)`
- `api.turn_on()`
- `api.turn_off()`
- *More details in [example/sender.py](example/sender.py)*
**Documentation:** cf. `example/` and `tests/`