Skip to content

Command line config, add TCP and pseudo TTY support #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sjlongland wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Command line config, add TCP and pseudo TTY support #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8494991
Rewrite to use variable data structure response
hno-wires Nov 18, 2022
a76977b
Add support for secondary addressing
hno-wires Nov 22, 2022
796fb78
Pass through `python3 -m black` for formatting consistency.
sjlongland Jun 5, 2023
5008e1c
Make configuration settable from the CLI.
sjlongland Jun 5, 2023
46ba619
Implement support for using `/dev/ptmx`
sjlongland Jun 5, 2023
6c71bde
Make `ID_NO` a string
sjlongland Jun 5, 2023
d1f4b44
README.md: document CLI arguments, virtual serial port
sjlongland Jun 5, 2023
062f43e
Add TCP socket, rename PTY option
sjlongland Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 118 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,131 @@ ADDR = 3 # M-Bus Slave address, 0=250 are valid
ID_NO = "12345678" # M-Bus Slave serial number, can be up to 8 characters, 0-9, A-F
```

Alternatively, you can override these values on the command line.

### Virtual serial port

On Linux and Unix systems, specify `pty` as the serial port to create a
virtual serial port. The script will report the name of the actual virtual
serial port you can connect to.

```
RC=0 stuartl@rikishi /tmp/pyMbusSlave $ python3 slave.py --device pty
INFO:pyMbusSlave:pyMbusSlave
INFO:pyMbusSlave: Serial device: pty
INFO:pyMbusSlave: Baudrate: 2400
INFO:pyMbusSlave: Slave address: 3
INFO:pyMbusSlave: Slave device ID: 12345678
INFO:pyMbusSlave:Point your M-Bus master at /dev/pts/4
```

Then point your M-Bus master at this device:

```
RC=0 stuartl@rikishi /tmp/libmbus/bin $ ./mbus-serial-scan /dev/pts/4
Found a M-Bus device at address 3
RC=0 stuartl@rikishi /tmp/libmbus/bin $ ./mbus-serial-request-data /dev/pts/4 3
<?xml version="1.0" encoding="ISO-8859-1"?>
<MBusData>

<SlaveInformation>
<Id>12345678</Id>
<Manufacturer>TST</Manufacturer>
<Version>1</Version>
<ProductName></ProductName>
<Medium>Other</Medium>
<AccessNumber>0</AccessNumber>
<Status>00</Status>
<Signature>0000</Signature>
</SlaveInformation>

<DataRecord id="0">
<Function>Instantaneous value</Function>
<StorageNumber>0</StorageNumber>
<Unit> V</Unit>
<Value>1234</Value>
<Timestamp>2023-06-05T01:14:26Z</Timestamp>
</DataRecord>

<DataRecord id="1">
<Function>Instantaneous value</Function>
<StorageNumber>0</StorageNumber>
<Unit>Volume ( m^3)</Unit>
<Value>456</Value>
<Timestamp>2023-06-05T01:14:26Z</Timestamp>
</DataRecord>

</MBusData>
```

### TCP Socket

Specify `tcp:${PORT}` or `tcp:${ADDRESS}:${PORT}` (IPv6 should work here too)
and it'll create a simulated M-Bus/TCP socket.

```
stuartl@LPA075:~/vrt/projects/widesky/edge/mbus/privdoc/pyMbusSlave$ python3 slave.py --device tcp:20000
INFO:pyMbusSlave:pyMbusSlave
INFO:pyMbusSlave: Serial device: tcp:20000
INFO:pyMbusSlave: Baudrate: 2400
INFO:pyMbusSlave: Slave address: 3
INFO:pyMbusSlave: Slave device ID: 12345678
DEBUG:pyMbusSlave:Will bind to any address port 20000
INFO:pyMbusSlave:Listening ...
```

```
stuartl@LPA075:~/vrt/projects/widesky/edge/mbus/privdoc/libmbus$ bin/mbus-tcp-request-data localhost 20000 3
<?xml version="1.0" encoding="ISO-8859-1"?>
<MBusData>

<SlaveInformation>
<Id>12345678</Id>
<Manufacturer>TST</Manufacturer>
<Version>1</Version>
<ProductName></ProductName>
<Medium>Other</Medium>
<AccessNumber>0</AccessNumber>
<Status>00</Status>
<Signature>0000</Signature>
</SlaveInformation>

<DataRecord id="0">
<Function>Instantaneous value</Function>
<StorageNumber>0</StorageNumber>
<Unit> V</Unit>
<Value>1234</Value>
<Timestamp>2023-06-06T21:27:49Z</Timestamp>
</DataRecord>

<DataRecord id="1">
<Function>Instantaneous value</Function>
<StorageNumber>0</StorageNumber>
<Unit>Volume ( m^3)</Unit>
<Value>456</Value>
<Timestamp>2023-06-06T21:27:49Z</Timestamp>
</DataRecord>

</MBusData>
```

## Running

```
python slave.py
```

The configuration can be overridden using command line arguments:

* `--device`: Serial port device for the slave.
* `--baud`: Baud rate of the serial interface.
* `--addr`: Primary address of the slave
* `--id`: Serial number of the slave
* `--manuf`: Manufacturer code

The slave sits and waits for commands from the M-Bus Master. The 2 commands supported today are:
* SND_NKE (used by the Master to scan for Slaves)
* REQ_UD2 (requests the slave's user data 2)
* `SND_NKE` (used by the Master to scan for Slaves)
* `REQ_UD2` (requests the slave's user data 2)

The slave responds with hard coded information.

Expand Down
Loading