Add zmq server and json support #102

bkerler · 2024-10-12T13:06:18Z

This adds a zmq server, baudrate config and json output support, enabling external decoders

mdxs · 2024-10-17T10:30:33Z

I think there are some inconsistencies in this PR:

Changes to the README regarding the ZMQ server port --smqport and host/ip (?) --smqhost command line parameters are different from the zmqsetting handling in the main routines of some of the other changed files. It is also not
There is no documentation in the README regarding the proposed introduction of the --baudrate command line parameter; while it isn't fully clear to me what the default would be if not specified (probably the same as pre-PR, but not clear); nor does it explain what the benefits or choices would be to modify this setting/parameter.

Furthermore, the PR adds numpy and scipy to the requirements for no obvious or described reason; as far as I can tell these are never used in the rest of the PR.

Wouldn't it make sense to split this PR into separate PRs for the introduction of the --baudrate by itself and another PR for the ZeroMQ (ZMQ) server? Perhaps the JSON output format is a pre-requisite for the ZMQ server, or would it by itself be an interesting feature to have a PR for just JSON output?

Hope this helps to improve or assess the PR(s).

mdxs · 2024-10-17T10:31:27Z

python_cli/advertiser.py

    args = aparse.parse_args()

    global hw
-    hw = SniffleHW(args.serport)
+    hw = SniffleHW(args.serport,baudrate=args.baudrate)


Missing a space after the comma, after: ...(args.serport,

mdxs · 2024-10-17T10:43:05Z

python_cli/scanner.py

@@ -60,7 +61,7 @@ def main():
    args = aparse.parse_args()

    global hw
-    hw = make_sniffle_hw(args.serport)
+    hw = make_sniffle_hw(serport=args.serport,baudrate=args.baudrate)


Missing a space after the comma, after: ...(args.serport,

mdxs · 2024-10-17T10:49:05Z

Next to the above highlighted whitespace issues in the code, the changes proposed to packet_decoder.py seem to have several whitespace issues. Not sure if that is not the case in Sniffle in other places, but there seem to be a lot in this PR in that specific file.

bkerler · 2024-10-17T13:07:04Z

@mdxs

Furthermore, the PR adds numpy and scipy to the requirements for no obvious or described reason; as far as I can tell these are never used in the rest of the PR.

python_cli/sniffle/resampler.py. Both numpy and scipy were already required.

bkerler · 2024-10-17T13:09:46Z

@mdxs

There is no documentation in the README regarding the proposed introduction of the --baudrate command line parameter; while it isn't fully clear to me what the default would be if not specified (probably the same as pre-PR, but not clear); nor does it explain what the benefits or choices would be to modify this setting/parameter.

In fact, the README already states that the firmware differs in its baudrate depending which firmware was flashed:

To install Sniffle on a SONOFF CC2652P dongle (equipped with a CP2102 USB/UART bridge), you need to use a special firmware build that uses a 921600 baud rate (labelled 1M) instead of the default 2 megabit baud rate.

mdxs · 2024-10-17T13:51:49Z

README.md

@@ -244,6 +245,8 @@ options:
  -d, --decode          Decode advertising data
  -o OUTPUT, --output OUTPUT
                        PCAP output file name
+  -z, --zmq             Enable ZMQ server
+  --zmqsetting          Set ZMQ server ip and port (default:127.0.0.1:4222)


Adding a space after default: should make this more readable (and as it would be rendered in fact?): ... and port (default: 127.0.0.1:4222)

Changed that accordingly.

mdxs · 2024-10-17T14:01:45Z

In fact, the README already states that the firmware differs in its baudrate depending which firmware was flashed:

As I'm not using/needing this, I might not have been aware of this and may never have needed it. I will leave it to you and others to decide if it is clear (from the other documentation) what value should be used by someone that does need it and in which situation(s). Could Sniffle figure it out from the device using some FW version details? Hmm, perhaps it cannot reliably if there is a mismatch from the start and the communication doesn't work. Oh well, outside my level of use/understanding.

mdxs · 2024-10-17T14:04:06Z

Next to the above highlighted whitespace issues in the code, the changes proposed to packet_decoder.py seem to have several whitespace issues. Not sure if that is not the case in Sniffle in other places, but there seem to be a lot in this PR in that specific file.

This appears to have been addressed as well, as I didn't spot whitespace issues in packet_decoder.py now.

mdxs · 2024-10-17T14:15:51Z

Note that I just looked at the PR and reported my observations, I didn't try to run it at all... so it is just an eyeball review.

I still wonder about the mixing of different topics into one PR, but will leave that to @sultanqasim to decide.

XenoKovah · 2024-10-17T20:38:32Z

python_cli/sniffle/sniffle_hw.py

                    baud = 921600
        elif is_cp2102(serport):
-            baud = 921600
+            if baudrate is None:
+                baud = 921600


I think this could be removed as part of a reversion to 2Mbaud everywhere as requested in #101 , and then just letting people use the new baudrate option this introduces if they want 921600.

Without that, it isn't working with the current code, as other hw doesn't support 2Mbaud.

sultanqasim · 2024-10-25T02:42:31Z

Thanks for your contributions. Sorry for my delayed response, as I just had my first kid born and she has been keeping me busy :)

I'll probably split these changes into a few commits for the different things in here (baud rate selection, mark and flush timeout, the ZeroMQ server, and cosmetic changes). I may skip the cosmetic changes and implement the mark and flush timeout a bit differently.

sultanqasim · 2024-10-25T02:46:11Z

@mdxs

Furthermore, the PR adds numpy and scipy to the requirements for no obvious or described reason; as far as I can tell these are never used in the rest of the PR.

python_cli/sniffle/resampler.py. Both numpy and scipy were already required.

Numpy and Scipy are not listed as dependencies in the README because they are only used for the experimental SDR-based sniffing functionality that I haven't yet documented and is very much an incomplete work-in-progress. You don't need Numpy or Scipy for the TI CC13xx/CC26xx based sniffer.

mdxs reviewed Oct 17, 2024

View reviewed changes

bkerler force-pushed the zmq branch from 795a70c to d481099 Compare October 17, 2024 13:23

mdxs reviewed Oct 17, 2024

View reviewed changes

mdxs mentioned this pull request Oct 17, 2024

Default to 2Mbaud for Sonoffs? #101

Open

XenoKovah reviewed Oct 17, 2024

View reviewed changes

bkerler force-pushed the zmq branch from d481099 to 65098d8 Compare October 20, 2024 16:04

Add zmq server and json support

5aa3972

bkerler force-pushed the zmq branch from 65098d8 to 5aa3972 Compare October 20, 2024 16:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add zmq server and json support #102

Add zmq server and json support #102

bkerler commented Oct 12, 2024

mdxs commented Oct 17, 2024

mdxs Oct 17, 2024

bkerler Oct 17, 2024

mdxs Oct 17, 2024

bkerler Oct 17, 2024

mdxs commented Oct 17, 2024

bkerler commented Oct 17, 2024

bkerler commented Oct 17, 2024

mdxs Oct 17, 2024

bkerler Oct 20, 2024

mdxs commented Oct 17, 2024

mdxs commented Oct 17, 2024

mdxs commented Oct 17, 2024

XenoKovah Oct 17, 2024

bkerler Oct 20, 2024

sultanqasim commented Oct 25, 2024

sultanqasim commented Oct 25, 2024

Add zmq server and json support #102

Are you sure you want to change the base?

Add zmq server and json support #102

Conversation

bkerler commented Oct 12, 2024

mdxs commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdxs commented Oct 17, 2024

bkerler commented Oct 17, 2024

bkerler commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdxs commented Oct 17, 2024

mdxs commented Oct 17, 2024

mdxs commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sultanqasim commented Oct 25, 2024

sultanqasim commented Oct 25, 2024