pyterm: add /sleep function by benpicco · Pull Request #11095 · RIOT-OS/RIOT

benpicco · 2019-03-04T13:13:07Z

The init_cmd feature is quite handy for automated pyterm runs but there
is no delay between the commands, so they are all written to the target at once.

This adds a /sleep function that can be added between init_cmd commands
to prevent them from overflowing the RX buffer on the target.

MrKevinWeiss · 2019-03-05T07:57:04Z

Hey @benpicco,
is it possible to add (or point to) a test case that shows the issue and the correction?

benpicco · 2019-03-05T10:05:38Z

Sure. I just wanted a quick way to gauge the connection to several devices as a move along, so I wrote a little pyterm init script that allows me to save the output for logging:

When I do

[init_cmd]
init_cmd0 = ping6 fe80::d07:d5e9:7c9:572d
init_cmd1 = ping6 fe80::7b7a:342f:9d73:b482
init_cmd2 = ping6 fe80::8877:ae5b:82c9:561e
init_cmd3 = ping6 fe80::abcd:1

I get

2019-03-05 10:59:24,278 - INFO # ping6 fe80::d07:d5e9:7c9:572d
2019-03-05 10:59:27,283 - INFO # 
2019-03-05 10:59:27,287 - INFO # --- fe80::d07:d5e9:7c9:572d PING statistics ---
2019-03-05 10:59:27,292 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss
> 2019-03-05 10:59:27,295 - INFO #  ping6 fe80::7b7a:342f:9d73:b482
2019-03-05 10:59:30,301 - INFO # 
2019-03-05 10:59:30,305 - INFO # --- fe80::7b7a:342f:9d73:b482 PING statistics ---
2019-03-05 10:59:30,310 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss
> 2019-03-05 10:59:30,327 - INFO #  ping6 fe80::8877:ae5b:82c9:561e
2019-03-05 10:59:33,319 - INFO # 
2019-03-05 10:59:33,329 - INFO # --- fe80::8877:ae5b:82c9:561e PING statistics ---
2019-03-05 10:59:33,331 - INFO # 3 packets transmitted, 0 packets received, 100% packet lo

The last command is missing because the RX buffer was full.
When instead I do

[init_cmd]
init_cmd0 = ping6 fe80::d07:d5e9:7c9:572d
init_cmd1 = /sleep 3
init_cmd2 = ping6 fe80::7b7a:342f:9d73:b482
init_cmd3 = /sleep 3
init_cmd4 = ping6 fe80::8877:ae5b:82c9:561e
init_cmd5 = /sleep 3
init_cmd6 = ping6 fe80::abcd:1

all commands are executed

2019-03-05 10:59:51,439 - INFO # ping6 fe80::d07:d5e9:7c9:572d
2019-03-05 10:59:51,439 - INFO # 
2019-03-05 10:59:51,440 - INFO # --- fe80::d07:d5e9:7c9:572d PING statistics ---
2019-03-05 10:59:51,440 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss
> 2019-03-05 10:59:51,441 - INFO #  ping6 fe80::7b7a:342f:9d73:b482
2019-03-05 10:59:51,454 - INFO # 
2019-03-05 10:59:51,458 - INFO # --- fe80::7b7a:342f:9d73:b482 PING statistics ---
2019-03-05 10:59:51,469 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss
> 2019-03-05 10:59:51,469 - INFO #  ping6 fe80::8877:ae5b:82c9:561e
2019-03-05 10:59:54,473 - INFO # 
2019-03-05 10:59:54,476 - INFO # --- fe80::8877:ae5b:82c9:561e PING statistics ---
2019-03-05 10:59:54,482 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss
> 2019-03-05 10:59:54,484 - INFO #  ping6 fe80::abcd:1
2019-03-05 10:59:57,488 - INFO # 
2019-03-05 10:59:57,491 - INFO # --- fe80::abcd:1 PING statistics ---
2019-03-05 10:59:57,496 - INFO # 3 packets transmitted, 0 packets received, 100% packet loss

cladmi · 2019-03-05T11:23:23Z

I have a question on the usage, do you need the interactive shell after or do you just send automated commands ?

benpicco · 2019-03-05T12:09:58Z

I just send automated commands - I actually send /quit as the last command.

MrKevinWeiss

As it is just a wrapper for sleep, it doesn't matter about code size, and people don't have to use it, I think it is fine to add it. I will wait for others to give opinions though before moving forward.

dist/tools/pyterm/pyterm

cladmi · 2019-03-11T15:22:50Z

I am asking about the usage, because we are maybe moving away from having pyterm by default for some boards. And doing this is similar to what is currently done in shell tests.

I know it is not a test but more controlling a node through code on the host machine. So in in the vein of I am starting to do in #10949 over make term instead of inside make term.

However I think that for the moment it could be done in the same way as our tests are.
And if writing it as a test does not work, I would gladly have feedback to take it into account and make your usecase work.

benpicco · 2019-03-11T15:55:52Z

What I like about pyterm is that it simply writes to stdout. So when I kill pyterm, the output stays in the terminal. I can also just pipe it to a file or run grep on it.

The init_cmd feature is quite handy for automated pyterm runs but there is no delay between the commands that are executed. This adds a /sleep function that can be added between init_cmd commands to prevent them from overflowing the RX buffer on the target.

benpicco · 2019-11-14T16:27:04Z

btw.: this is still useful.

E.g. I want to try some modulations but don't want to change the code of the example application or the driver defaults:

[init_cmd]
init_cmd0 = ifconfig 7 set phy_mode fsk
init_cmd1 = ifconfig 7 set fec NRNSC

Now if I want to to more complex things, the \sleep command, while a crutch, is still handy.

MrKevinWeiss · 2019-11-15T08:17:32Z

I can jump back on this. My concern here is that this is pyterm specific. I also think that the automated tests now try to select socat by default.

I don't mind having extra features on tools so I think the concept is still OK.
To clarify when you say automated script you are not talking about the /tests/*/tests/01-run.py type scripts that testrunner targets, you are just talking about simple scripts that you use when testing?

MrKevinWeiss · 2019-11-15T09:27:19Z

Tested and it works

MrKevinWeiss · 2019-11-15T09:31:20Z

used the tests/shell application with the nucleo-l433rc

Details

> /sleep 20
help
test
echo 123
help
help
test
echo 123
2019-11-15 10:30:06,784 - INFO #  help
help
2019-11-15 10:30:06,787 - INFO # Command              Description
2019-11-15 10:30:06,789 - INFO # ---------------------------------------
2019-11-15 10:30:06,792 - INFO # start_test           starts a test
2019-11-15 10:30:06,795 - INFO # end_test             ends a test
2019-11-15 10:30:06,799 - INFO # echo                 prints the input command
2019-11-15 10:30:06,803 - INFO # reboot               Reboot the node
2019-11-15 10:30:06,809 - INFO # ps                   Prints information about running threads.
> 2019-11-15 10:30:06,810 - INFO #  test
2019-11-15 10:30:06,813 - INFO # shell: command not found: test
> 2019-11-15 10:30:06,814 - INFO #  echo 123
2019-11-15 10:30:06,815 - INFO # "echo""123"
> 2019-11-15 10:30:06,816 - INFO #  help
2019-11-15 10:30:06,819 - INFO # Command              Description
2019-11-15 10:30:06,822 - INFO # ---------------------------------------
2019-11-15 10:30:06,824 - INFO # start_test           starts a test
2019-11-15 10:30:06,827 - INFO # end_test             ends a test
2019-11-15 10:30:06,831 - INFO # echo                 prints the input command
2019-11-15 10:30:06,834 - INFO # reboot               Reboot the node
2019-11-15 10:30:06,840 - INFO # ps                   Prints information about running threads.
>

I can also exit the shell during the sleep.

aabadie · 2020-01-15T08:49:40Z

This one seems ready and has been tested. @MrKevinWeiss what's your opinion ?

MrKevinWeiss

Maybe we rerun CI but it was fine for me. ACK.

PeterKietzmann added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: tools Area: Supplementary tools labels Mar 5, 2019

PeterKietzmann requested review from MrKevinWeiss and smlng March 5, 2019 07:29

MrKevinWeiss requested a review from cladmi March 5, 2019 07:54

MrKevinWeiss reviewed Mar 5, 2019

View reviewed changes

dist/tools/pyterm/pyterm Show resolved Hide resolved

dist/tools/pyterm/pyterm Show resolved Hide resolved

MrKevinWeiss added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Mar 12, 2019

pyterm: add /sleep function

e12f1f2

The init_cmd feature is quite handy for automated pyterm runs but there is no delay between the commands that are executed. This adds a /sleep function that can be added between init_cmd commands to prevent them from overflowing the RX buffer on the target.

benpicco force-pushed the pyterm_sleep branch from d767858 to e12f1f2 Compare April 10, 2019 22:10

benpicco added the Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer label Jul 29, 2019

smlng removed request for cladmi and smlng September 19, 2019 09:12

MrKevinWeiss added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Nov 15, 2019

MrKevinWeiss added the Reviewed: 3-testing The PR was tested according to the maintainer guidelines label Nov 15, 2019

MrKevinWeiss approved these changes Jan 15, 2020

View reviewed changes

MrKevinWeiss added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jan 15, 2020

benpicco merged commit 8a99824 into RIOT-OS:master Jan 15, 2020

benpicco deleted the pyterm_sleep branch January 15, 2020 17:25

Conversation

benpicco commented Mar 4, 2019

Uh oh!

MrKevinWeiss commented Mar 5, 2019

Uh oh!

benpicco commented Mar 5, 2019

Uh oh!

cladmi commented Mar 5, 2019

Uh oh!

benpicco commented Mar 5, 2019

Uh oh!

MrKevinWeiss left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cladmi commented Mar 11, 2019

Uh oh!

benpicco commented Mar 11, 2019

Uh oh!

benpicco commented Nov 14, 2019

Uh oh!

MrKevinWeiss commented Nov 15, 2019

Uh oh!

MrKevinWeiss commented Nov 15, 2019

Uh oh!

MrKevinWeiss commented Nov 15, 2019

Uh oh!

aabadie commented Jan 15, 2020

Uh oh!

MrKevinWeiss left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MrKevinWeiss left a comment •

edited

Loading