Skip to content

s7commplus.rst

Latest commit

 

History

History
108 lines (74 loc) · 2.49 KB

s7commplus.rst

File metadata and controls

108 lines (74 loc) · 2.49 KB

S7CommPlus (S7-1200/1500)

Warning

S7CommPlus support is experimental. The API may change in future releases. If you encounter problems, please open an issue.

The s7 package provides a unified client for Siemens S7-1200 and S7-1500 PLCs. It automatically tries the S7CommPlus protocol first and falls back to the legacy S7 protocol when needed.

Synchronous client

from s7 import Client

client = Client()
client.connect("192.168.1.10", 0, 1)
data = client.db_read(1, 0, 4)
print(client.protocol)   # Protocol.S7COMMPLUS or Protocol.LEGACY
client.disconnect()

Asynchronous client

import asyncio
from s7 import AsyncClient

async def main():
    client = AsyncClient()
    await client.connect("192.168.1.10", 0, 1)
    data = await client.db_read(1, 0, 4)
    await client.disconnect()

asyncio.run(main())

V2 connection with TLS

S7-1500 PLCs with firmware 2.x use S7CommPlus V2, which requires TLS. Pass use_tls=True to the connect() method:

from s7 import Client

client = Client()
client.connect("192.168.1.10", 0, 1, use_tls=True)
data = client.db_read(1, 0, 4)
client.disconnect()

For PLCs with custom certificates, provide the certificate paths:

client.connect(
    "192.168.1.10", 0, 1,
    use_tls=True,
    tls_cert="/path/to/client.pem",
    tls_key="/path/to/client.key",
    tls_ca="/path/to/ca.pem",
)

Password authentication

Password-protected PLCs require the password keyword argument:

from s7 import Client

client = Client()
client.connect("192.168.1.10", 0, 1, use_tls=True, password="my_plc_password")
data = client.db_read(1, 0, 4)
client.disconnect()

Protocol selection

By default the client uses Protocol.AUTO which tries S7CommPlus first. You can force a specific protocol:

from s7 import Client, Protocol

# Force legacy S7 only
client = Client()
client.connect("192.168.1.10", 0, 1, protocol=Protocol.LEGACY)

# Force S7CommPlus (raises on failure)
client.connect("192.168.1.10", 0, 1, protocol=Protocol.S7COMMPLUS)

API reference

.. automodule:: s7.client
   :members:


.. automodule:: s7.async_client
   :members: