python-snap7 Documentation

Release 0.0rc0

Gijs Molenaar, Stephan Preeker

Mar 05, 2017

 Contents

1 Introduction 3

2 Installation 5
2.1 Snap7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 snap7-python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3 development 7
3.1 Github . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Test suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3 Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4 Client 9

5 Server 13

6 Partner 15

7 Util 17

8 Indices and tables 21

Python Module Index 23

i
ii
 python-snap7 Documentation, Release 0.0rc0

Contents:

Contents 1
python-snap7 Documentation, Release 0.0rc0

2 Contents
 CHAPTER 1

Introduction

python-snap7 is a Python wrapper for the Snap7 library. Snap7 i san open source, 32/64 bit, multi-platform Ethernet
communication suite for interfacing natively with Siemens S7 PLCs.
Python-snap7 is developer for snap7 1.1.0 and Python2.7. It is tested on Windows (8.1 64 bit) and Linux, but it may
work on other operating systems. Python 2.6 and Python 3+ may work, but are not fully tested yet.
The project development is centralized on github.

3
python-snap7 Documentation, Release 0.0rc0

4 Chapter 1. Introduction
 CHAPTER 2

Installation

here you can find out how to install python-snap7 on your system.

Snap7

To use python-snap7 you need to have the snap7 library installed.

Ubuntu

If you are using Ubuntu you can use the Ubuntu packages from our launchpad PPA. To install:
$ sudo add-apt-repository ppa:gijzelaar/snap7
$ sudo apt-get update
$ sudo apt-get install libsnap71 libsnap7-dev

Windows

Download the zip file from the sourceforce page. Unzip the zip file, and copy* releaseWin-
dows<Win64/Win32>snap7.dll* somewhere in you system PATH, for example C:WINDOWSsystem32. Alternatively
you can copy the file somewhere on your file system and adjust the system PATH.

Compile from source

If you are not using Ubuntu or if you want to have more control you can download the latest source from the sourceforce
page and do a manual compile. Download the file and run:
$ p7zip -d snap7-full-1.0.0.7z # requires the p7 program
$ cd build/<platform> # where platform is unix or windows
$ make -f <arch>.mk # where arch is your architecture, for example x86_64_
linux

5
python-snap7 Documentation, Release 0.0rc0

For more information about or help with compilation please check out the documentation on the snap7 website.

snap7-python

python-snap7 is available on PyPI. You can install it by using pip:

$ pip install python-snap7

You can also install it from the git repository or from a source tarball:

$ python ./setup.py install

6 Chapter 2. Installation
 CHAPTER 3

development

Github

We develop python-snap7 on github. If you have any problems with python-snap7 please raise an issue in the issue
tracker. Even better is if you have a solution to problem! In that case you can make our live easier by following these
steps:
fork our repository on github
Add a tests that will fail because of the problem
Fix the problem
Run the test suite again
Commit to your repository
Issue a github pullrequest.
Also we try to be as much pep8 compatible as possible, where possible and reasonable.

Test suite

python-snap7 comes with a test suite with 100% coverage. This test suite verifies that the code actually works and
makes development much easier. To run all tests please run from the source:

$ ./run_tests.sh

Note that some tests require to run as root, since snap7 needs to bind on a privileged TCP port.
If the test complain about missing Python modules make sure the source directory is in your PYTHONPATH environ-
ment variable, or the python-snap7 module is installed.

7
python-snap7 Documentation, Release 0.0rc0

Credits

python-snap7 is created by Gijs Molenaar and Stephan Preeker.

Special thanks to go to Davide Nardella for creating snap7, Thomas Hergenhahn for his libnodave and Thomas W for
his S7comm wireshark plugin.

8 Chapter 3. development
 CHAPTER 4

Client

Snap7 client used for connection to a siemens7 server.

class snap7.client.Client
A snap7 client
ab_read(start, size)
This is a lean function of Cli_ReadArea() to read PLC process outputs.
ab_write(start, data)
This is a lean function of Cli_WriteArea() to write PLC process outputs
as_ab_read(start, size)
This is the asynchronous counterpart of client.ab_read().
as_ab_write(start, data)
This is the asynchronous counterpart of Cli_ABWrite.
as_ct_read()
as_ct_write()
as_db_fill()
as_db_get(db_number)
This is the asynchronous counterpart of Cli_DBGet.
as_db_read(db_number, start, size)
This is the asynchronous counterpart of Cli_DBRead.
Returns user buffer.
as_db_write(db_number, start, data)
copy_ram_to_rom()
create()
create a SNAP7 client.
db_get(db_number)
Uploads a DB from AG.

9
python-snap7 Documentation, Release 0.0rc0

db_read(db_number, start, size)

This is a lean function of Cli_ReadArea() to read PLC DB.
Returns user buffer.
destroy()
destroy a client.
full_upload(_type, block_num)
Uploads a full block body from AG. The whole block (including header and footer) is copied into the user
buffer.
Parameters block_num Number of Block
get_block_info(blocktype, db_number)
Returns the block information for the specified block.
get_connected()
Returns the connection status
Returns a boolean that indicates if connected.
get_cpu_info()
Retrieves CPU info from client
get_cpu_state()
Retrieves CPU state from client
get_param(number)
Reads an internal Client object parameter.
get_pdu_length()
Returns info about the PDU length.
list_blocks()
Returns the AG blocks amount divided by type.
Returns a snap7.types.BlocksList object.
list_blocks_of_type(blocktype, size)
This function returns the AG list of a specified block type.
plc_cold_start()
cold starts a client
plc_hot_start()
hot starts a client
plc_stop()
stops a client
read_area(area, dbnumber, start, size)
This is the main function to read data from a PLC. With it you can read DB, Inputs, Outputs, Merkers,
Timers and Counters.
Parameters
dbnumber The DB number, only used when area= S7AreaDB
start offset to start writing
size number of units to read
read_multi_vars(items)
This function read multiple variables from the PLC.

10 Chapter 4. Client
 python-snap7 Documentation, Release 0.0rc0

Parameters items list of S7DataItem objects

Returns a tuple with the return code and a list of data items
set_connection_params(address, local_tsap, remote_tsap)
Sets internally (IP, LocalTSAP, RemoteTSAP) Coordinates. This function must be called just before
Cli_Connect().
Parameters
address PLC/Equipment IPV4 Address, for example 192.168.1.12
local_tsap Local TSAP (PC TSAP)
remote_tsap Remote TSAP (PLC TSAP)
set_connection_type(connection_type)
Sets the connection resource type, i.e the way in which the Clients connects to a PLC.
Parameters connection_type 1 for PG, 2 for OP, 3 to 10 for S7 Basic
upload(block_num)
Uploads a block body from AG
Parameters data bytearray
snap7.client.error_wrap(func)
Parses a s7 error code returned the decorated function.

11
python-snap7 Documentation, Release 0.0rc0

12 Chapter 4. Client
 CHAPTER 5

Server

Snap7 server used for mimicking a siemens 7 server.

class snap7.server.Server(log=True)
A fake S7 server.
create()
create the server.
destroy()
destroy the server.
event_text(event)
Returns a textual explanation of a given event object
Parameters event an PSrvEvent struct object
Returns the error string
get_mask(kind)
Reads the specified filter mask.
get_param(number)
Reads an internal Server object parameter.
get_status()
Reads the server status, the Virtual CPU status and the number of the clients connected.
Returns server status, cpu status, client count
pick_event()
Extracts an event (if available) from the Events queue.
snap7.server.error_wrap(func)
Parses a s7 error code returned the decorated function.

13
python-snap7 Documentation, Release 0.0rc0

14 Chapter 5. Server
 CHAPTER 6

Partner

Snap7 code for partnering with a siemens 7 server.

This allows you to create a S7 peer to peer communication. Unlike the client-server model, where the client makes a
request and the server replies to it, the peer to peer model sees two components with same rights, each of them can
send data asynchronously. The only difference between them is the one who is requesting the connection.
class snap7.partner.Partner(active=False)
A snap7 partner.
as_b_send()
Sends a data packet to the partner. This function is asynchronous, i.e. it terminates immediately, a com-
pletion method is needed to know when the transfer is complete.
b_recv()
Receives a data packet from the partner. This function is synchronous, it waits until a packet is received or
the timeout supplied expires.
b_send()
Sends a data packet to the partner. This function is synchronous, i.e. it terminates when the transfer job
(send+ack) is complete.
check_as_b_recv_completion()
Checks if a packed received was received.
check_as_b_send_completion()
Checks if the current asynchronous send job was completed and terminates immediately.
create(active=False)
Creates a Partner and returns its handle, which is the reference that you have to use every time you refer to
that Partner.
Parameters active 0
Returns a pointer to the partner object
destroy()
Destroy a Partner of given handle. Before destruction the Partner is stopped, all clients disconnected and
all shared memory blocks released.

15
python-snap7 Documentation, Release 0.0rc0

get_last_error()
Returns the last job result.
get_param(number)
Reads an internal Partner object parameter.
get_stats()
Returns some statistics.
Returns a tuple containing bytes send, received, send errors, recv errors
get_status()
Returns the Partner status.
get_times()
Returns the last send and recv jobs execution time in milliseconds.
set_recv_callback()
Sets the user callback that the Partner object has to call when a data packet is incoming.
set_send_callback()
Sets the user callback that the Partner object has to call when the asynchronous data sent is complete.
stop()
Stops the Partner, disconnects gracefully the remote partner.
snap7.partner.error_wrap(func)
Parses a s7 error code returned the decorated function.

16 Chapter 6. Partner
 CHAPTER 7

Util

This module contains utility functions for working with PLC DB objects. There are functions to work with the raw
bytearray data snap7 functions return In order to work with this data you need to make python able to work with the
PLC bytearray data.
For example code see test_util.py and example.py in the example folder.
example:

spec/DB layout

# Byte index Variable name Datatype

layout="""
4 ID INT
6 NAME STRING[6]

12.0 testbool1 BOOL

12.1 testbool2 BOOL
12.2 testbool3 BOOL
12.3 testbool4 BOOL
12.4 testbool5 BOOL
12.5 testbool6 BOOL
12.6 testbool7 BOOL
12.7 testbool8 BOOL
13 testReal REAL
17 testDword DWORD
"""

client = snap7.client.Client()
client.connect('192.168.200.24', 0, 3)

# this looks confusing but this means uploading from the PLC to YOU
# so downloading in the PC world :)

all_data = client.upload(db_number)

17
python-snap7 Documentation, Release 0.0rc0

simple:

db1 = snap7.util.DB(
db_number, # the db we use
all_data, # bytearray from the plc
layout, # layout specification DB variable data
# A DB specification is the specification of a
# DB object in the PLC you can find it using
# the dataview option on a DB object in PCS7

17+2, # size of the specification 17 is start

# of last value
# which is a DWORD which is 2 bytes,

1, # number of row's / specifications

id_field='ID', # field we can use to identify a row.

# default index is used
layout_offset=4, # sometimes specification does not start a 0
# like in our example
db_offset=0 # At which point in 'all_data' should we start
# reading. if could be that the specification
# does not start at 0
)

Now we can use db1 in python as a dict. if 'ID' contains

the 'test' we can identify the 'test' row in the all_data bytearray

To test of you layout matches the data from the plc you can
just print db1[0] or db['test'] in the example

db1['test']['testbool1'] = 0

If we do not specify a id_field this should work to read out the

same data.

db1[0]['testbool1']

to read and write a single Row from the plc. takes like 5ms!

db1['test'].write()

db1['test'].read()

class snap7.util.DB(db_number, _bytearray, specification, row_size, size, id_field=None, db_offset=0,

layout_offset=0, row_offset=0)
Manage a DB bytearray block given a specification of the Layout.
It is possible to have many repetitive instances of a specification this is called a row.
probably most usecases there is just one row
db1[0][testbool1] = test db1.write() # puts data in plc
class snap7.util.DB_Row(_bytearray, _specification, row_size=0, db_offset=0, layout_offset=0,
row_offset=0)
Provide ROW API for DB bytearray
export()
export dictionary with values

18 Chapter 7. Util
 python-snap7 Documentation, Release 0.0rc0

get_bytearray()
return bytearray from self or DB parent
get_offset(byte_index)
Calculate correct beginning position for a row the db_offset = row_size * index
read(client)
read current data of db row from plc
write(client)
Write current data to db in plc
snap7.util.get_bool(_bytearray, byte_index, bool_index)
Get the boolean value from location in bytearray
snap7.util.get_int(_bytearray, byte_index)
Get int value from bytearray.
int are represented in two bytes
snap7.util.get_real(_bytearray, byte_index)
Get real value. create float from 4 bytes
snap7.util.get_string(_bytearray, byte_index, max_size)
parse string from bytearray
snap7.util.parse_specification(db_specification)
Create a db specification derived from a dataview of a db in which the byte layout is specified
snap7.util.set_bool(_bytearray, byte_index, bool_index, value)
Set boolean value on location in bytearray
snap7.util.set_int(_bytearray, byte_index, _int)
Set value in bytearray to int
snap7.util.set_real(_bytearray, byte_index, real)
Set Real value
make 4 byte data from real
snap7.util.set_string(_bytearray, byte_index, value, max_size)
Set string value
Params value string data
Params max_size max possible string size

19
python-snap7 Documentation, Release 0.0rc0

20 Chapter 7. Util
 CHAPTER 8

Indices and tables

genindex
modindex
search

21
python-snap7 Documentation, Release 0.0rc0

22 Chapter 8. Indices and tables

 Python Module Index

s
snap7.client, 9
snap7.partner, 15
snap7.server, 13
snap7.util, 17

23
python-snap7 Documentation, Release 0.0rc0

24 Python Module Index

 Index

A error_wrap() (in module snap7.partner), 16

ab_read() (snap7.client.Client method), 9 error_wrap() (in module snap7.server), 13
ab_write() (snap7.client.Client method), 9 event_text() (snap7.server.Server method), 13
as_ab_read() (snap7.client.Client method), 9 export() (snap7.util.DB_Row method), 18
as_ab_write() (snap7.client.Client method), 9
as_b_send() (snap7.partner.Partner method), 15 F
as_ct_read() (snap7.client.Client method), 9 full_upload() (snap7.client.Client method), 10
as_ct_write() (snap7.client.Client method), 9
as_db_fill() (snap7.client.Client method), 9 G
as_db_get() (snap7.client.Client method), 9 get_block_info() (snap7.client.Client method), 10
as_db_read() (snap7.client.Client method), 9 get_bool() (in module snap7.util), 19
as_db_write() (snap7.client.Client method), 9 get_bytearray() (snap7.util.DB_Row method), 18
get_connected() (snap7.client.Client method), 10
B get_cpu_info() (snap7.client.Client method), 10
b_recv() (snap7.partner.Partner method), 15 get_cpu_state() (snap7.client.Client method), 10
b_send() (snap7.partner.Partner method), 15 get_int() (in module snap7.util), 19
get_last_error() (snap7.partner.Partner method), 16
C get_mask() (snap7.server.Server method), 13
check_as_b_recv_completion() (snap7.partner.Partner get_offset() (snap7.util.DB_Row method), 19
method), 15 get_param() (snap7.client.Client method), 10
check_as_b_send_completion() (snap7.partner.Partner get_param() (snap7.partner.Partner method), 16
method), 15 get_param() (snap7.server.Server method), 13
Client (class in snap7.client), 9 get_pdu_length() (snap7.client.Client method), 10
copy_ram_to_rom() (snap7.client.Client method), 9 get_real() (in module snap7.util), 19
create() (snap7.client.Client method), 9 get_stats() (snap7.partner.Partner method), 16
create() (snap7.partner.Partner method), 15 get_status() (snap7.partner.Partner method), 16
create() (snap7.server.Server method), 13 get_status() (snap7.server.Server method), 13
get_string() (in module snap7.util), 19
D get_times() (snap7.partner.Partner method), 16
DB (class in snap7.util), 18
db_get() (snap7.client.Client method), 9
L
db_read() (snap7.client.Client method), 10 list_blocks() (snap7.client.Client method), 10
DB_Row (class in snap7.util), 18 list_blocks_of_type() (snap7.client.Client method), 10
destroy() (snap7.client.Client method), 10
destroy() (snap7.partner.Partner method), 15 P
destroy() (snap7.server.Server method), 13 parse_specification() (in module snap7.util), 19
Partner (class in snap7.partner), 15
E pick_event() (snap7.server.Server method), 13
error_wrap() (in module snap7.client), 11 plc_cold_start() (snap7.client.Client method), 10

25
python-snap7 Documentation, Release 0.0rc0

plc_hot_start() (snap7.client.Client method), 10

plc_stop() (snap7.client.Client method), 10

R
read() (snap7.util.DB_Row method), 19
read_area() (snap7.client.Client method), 10
read_multi_vars() (snap7.client.Client method), 10

S
Server (class in snap7.server), 13
set_bool() (in module snap7.util), 19
set_connection_params() (snap7.client.Client method),
11
set_connection_type() (snap7.client.Client method), 11
set_int() (in module snap7.util), 19
set_real() (in module snap7.util), 19
set_recv_callback() (snap7.partner.Partner method), 16
set_send_callback() (snap7.partner.Partner method), 16
set_string() (in module snap7.util), 19
snap7.client (module), 9
snap7.partner (module), 15
snap7.server (module), 13
snap7.util (module), 17
stop() (snap7.partner.Partner method), 16

U
upload() (snap7.client.Client method), 11

W
write() (snap7.util.DB_Row method), 19

26 Index