slmp-connect-python 0.1.6

SLMP Connect Python: client library for Mitsubishi SLMP binary communication

SLMP Protocol for Python

High-level SLMP helpers for Mitsubishi PLC communication over Binary 3E and 4E frames.

This repository treats the high-level helper layer as the recommended user surface:

• SlmpConnectionOptions
• open_and_connect / open_and_connect_sync
• AsyncSlmpClient
• QueuedAsyncSlmpClient
• SlmpClient
• normalize_address
• read_typed / write_typed
• read_words_single_request / read_dwords_single_request
• read_words_chunked / read_dwords_chunked
• write_bit_in_word
• read_named / write_named
• poll

Installation

pip install slmp-connect-python

The latest release lives at https://pypi.org/project/slmp-connect-python/, where wheel and tarball downloads and metadata are available.

Quick Start

Recommended async path:

import asyncio

from slmp import SlmpConnectionOptions, open_and_connect, read_named, write_typed


async def main() -> None:
    options = SlmpConnectionOptions(
        host="192.168.250.100",
        port=1025,
        plc_series="iqr",
        frame_type="4e",
    )
    async with await open_and_connect(options) as client:
        before = await read_named(client, ["D100", "D200:F", "D50.3"])
        print("before:", before)

        await write_typed(client, "D100", "U", 42)

        after = await read_named(client, ["D100", "D200:F", "D50.3"])
        print("after:", after)


asyncio.run(main())

Choose the connection profile explicitly:

• plc_series="iqr", frame_type="4e" for iQ-R / iQ-F targets
• plc_series="ql", frame_type="3e" for Q / L targets

Supported PLC Registers

Start with these public high-level families first:

• word devices: D, SD, R, ZR, TN, CN
• bit devices: M, X, Y, SM, B
• typed forms: D200:F, D300:L, D100:S
• mixed snapshot forms: D50.3, D100, D200:F
• current-value long families: LTN, LSTN, LCN

See the full public table in Supported PLC Registers.

Public Documentation

• Getting Started
• Supported PLC Registers
• Latest Communication Verification
• User Guide
• Samples
• Error Codes

Maintainer-only notes and retained evidence live under internal_docs/.

High-Level API Guide

Address Normalization

from slmp import normalize_address

print(normalize_address("x20"))   # X20
print(normalize_address("d200"))  # D200

Single Typed Values

from slmp import read_typed, write_typed

temperature = await read_typed(client, "D200", "F")
counter = await read_typed(client, "D300", "L")
await write_typed(client, "D100", "U", 1234)

Use .bit notation only with word devices such as D50.3. Address bit devices directly as M1000, M1001, X20, or Y20.

Development

run_ci.bat
build_docs.bat
release_check.bat

License

Distributed under the MIT License.