pax_global_header 0000666 0000000 0000000 00000000064 15130432351 0014507 g ustar 00root root 0000000 0000000 52 comment=096257f7dbfd7c0326811f3556cfffe8057b2086
someipy-2.1.2/ 0000775 0000000 0000000 00000000000 15130432351 0013176 5 ustar 00root root 0000000 0000000 someipy-2.1.2/.coveragerc 0000664 0000000 0000000 00000000030 15130432351 0015310 0 ustar 00root root 0000000 0000000 [run]
omit =
tests/* someipy-2.1.2/.github/ 0000775 0000000 0000000 00000000000 15130432351 0014536 5 ustar 00root root 0000000 0000000 someipy-2.1.2/.github/workflows/ 0000775 0000000 0000000 00000000000 15130432351 0016573 5 ustar 00root root 0000000 0000000 someipy-2.1.2/.github/workflows/tests.yml 0000664 0000000 0000000 00000002403 15130432351 0020457 0 ustar 00root root 0000000 0000000 name: Run Tests
on:
push:
branches:
- '*'
pull_request:
branches:
- '*'
jobs:
test:
runs-on: ubuntu-latest # Use the latest version of Ubuntu as the operating system
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python 3.12
uses: actions/setup-python@v2
with:
python-version: 3.12
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .
pip install pytest
pip install pytest-asyncio
pip install coverage
- name: Run pytest
run: coverage run -m pytest tests/
- name: Generate coverage HTML report
run: coverage html
- name: Upload coverage report
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: './htmlcov'
- name: Generate coverage json
run: coverage json -o coverage.json
- name: Upload coverage json to gist
env:
GIST_ID: ${{ secrets.GIST_ID }}
GIST_TOKEN: ${{ secrets.GIST_TOKEN }}
run: |
# Create a GitHub CLI authentication token
echo "$GIST_TOKEN" | gh auth login --with-token
# Update existing gist
gh gist edit $GIST_ID coverage.json someipy-2.1.2/.gitignore 0000664 0000000 0000000 00000000226 15130432351 0015166 0 ustar 00root root 0000000 0000000 .vscode/
dist/
someipy.egg-info/
__pycache__
venv/
*.whl
integration_tests/build
integration_tests/install
build/
.coverage
htmlcov/
*.pdf
*.bash
someipy-2.1.2/.readthedocs.yaml 0000664 0000000 0000000 00000001115 15130432351 0016423 0 ustar 00root root 0000000 0000000 # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
someipy-2.1.2/LICENSE.md 0000664 0000000 0000000 00000104515 15130432351 0014610 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
someipy-2.1.2/README.md 0000664 0000000 0000000 00000006553 15130432351 0014466 0 ustar 00root root 0000000 0000000 # someipy - A Python Library implementing the SOME/IP Protocol

## Get in Contact :postbox:
If you want to connect, have a feature request, bug report or need support, send me an email or connect on LinkedIn:
> :email: [someipy.package@gmail.com](mailto:someipy.package@gmail.com)
:electric_plug: [LinkedIn](https://www.linkedin.com/in/ch-herzog/)
## Documentation :pencil2:
:link: [https://someipy.readthedocs.io/en/latest/](https://someipy.readthedocs.io/en/latest/)
## What is someipy?
someipy is a Python library implementing the SOME/IP protocol, including the SOME/IP SD (Service Discovery) in Python. It's perfectly suited for fast prototyping of applications that need to provide (server) or use (client) SOME/IP services from other ECUs.
someipy also supports serialization and deserialization of SOME/IP payloads, which is a unique feature compared to other libraries.
someipy is still under development; therefore, it does not yet support all features of the SOME/IP and SOME/IP Service Discovery protocol specification.
someipy is based on the specification version of R22-11:
- [SOME/IP Protocol Specification](https://www.autosar.org/fileadmin/standards/R22-11/FO/AUTOSAR_PRS_SOMEIPProtocol.pdf)
- [SOME/IP Service Discovery Protocol Specification](https://www.autosar.org/fileadmin/standards/R22-11/FO/AUTOSAR_PRS_SOMEIPServiceDiscoveryProtocol.pdf)
The library is currently developed and tested under Ubuntu 22.04 and Python 3.8. Windows is supported as well.
## Typical Use Cases
someipy excels in scenarios where a full-scale Autosar (Adaptive or Classic) integration would be excessive:
- :test_tube: **Develop Test Applications**: Easily create test applications to stimulate the SOME/IP interfaces of your system under test. Whether running on a PC in a SIL environment or on an ECU, someipy allows you to efficiently send and receive SOME/IP events or utilize/provide SOME/IP services. Test data can be seamlessly generated or imported in Python, from sources such as .csv files or ROS bag files. Explore the [example applications](#example-applications) for more details.
- :battery: **Prototype Sensor Integration**: Quickly integrate new sensors into your project using SOME/IP, ideal for evaluating the sensor's potential impact without significant effort. Define the message/parameter layout in Python and create a server service instance in minutes. Check out the [example application](#example-applications) *send_events_udp.py* for a practical demonstration.
- :microscope: **Data Recording**: Set up a SOME/IP recording application in just a few minutes and store data in your preferred format, such as ROS bags, .csv files, or databases. Simply dump the received data within your callback function. The [example application](#example-applications) *receive_events_udp.py* illustrates this process.
## Installation
The package can be installed from [PyPi](https://pypi.org/project/someipy/).
```bash
pip3 install someipy
```
## Example Applications
In the directory [example_apps](./example_apps/), examples including explanations, can be found for using the someipy library.
someipy-2.1.2/docs/ 0000775 0000000 0000000 00000000000 15130432351 0014126 5 ustar 00root root 0000000 0000000 someipy-2.1.2/docs/api/ 0000775 0000000 0000000 00000000000 15130432351 0014677 5 ustar 00root root 0000000 0000000 someipy-2.1.2/docs/api/client_service_instance.rst 0000664 0000000 0000000 00000000173 15130432351 0022314 0 ustar 00root root 0000000 0000000 ClientServiceInstance
=======================
.. autoclass:: someipy::ClientServiceInstance
:exclude-members: __init__ someipy-2.1.2/docs/api/connect_to_someipy_daemon.rst 0000664 0000000 0000000 00000000153 15130432351 0022653 0 ustar 00root root 0000000 0000000 connect_to_someipy_daemon
===========================
.. autofunction:: someipy::connect_to_someipy_daemon someipy-2.1.2/docs/api/event.rst 0000664 0000000 0000000 00000000137 15130432351 0016553 0 ustar 00root root 0000000 0000000 Event
===========================
.. autoclass:: someipy::Event
:exclude-members: __init__ someipy-2.1.2/docs/api/eventgroup.rst 0000664 0000000 0000000 00000000145 15130432351 0017627 0 ustar 00root root 0000000 0000000 EventGroup
=======================
.. autoclass:: someipy::EventGroup
:exclude-members: __init__ someipy-2.1.2/docs/api/index.rst 0000664 0000000 0000000 00000000656 15130432351 0016547 0 ustar 00root root 0000000 0000000 API Reference
=======================
Classes
-----------------------
.. toctree::
:maxdepth: 1
service
service_builder
method
method_result
eventgroup
event
server_service_instance
client_service_instance
serialization
transport_layer_protocol
message_type
return_code
Functions
-----------------------
.. toctree::
:maxdepth: 1
connect_to_someipy_daemon
someipy_logging someipy-2.1.2/docs/api/message_type.rst 0000664 0000000 0000000 00000000152 15130432351 0020114 0 ustar 00root root 0000000 0000000 MessageType
==========================
.. autoclass:: someipy::MessageType
:exclude-members: __init__ someipy-2.1.2/docs/api/method.rst 0000664 0000000 0000000 00000000125 15130432351 0016707 0 ustar 00root root 0000000 0000000 Method
===============
.. autoclass:: someipy::Method
:exclude-members: __init__ someipy-2.1.2/docs/api/method_result.rst 0000664 0000000 0000000 00000000154 15130432351 0020307 0 ustar 00root root 0000000 0000000 MethodResult
==========================
.. autoclass:: someipy::MethodResult
:exclude-members: __init__ someipy-2.1.2/docs/api/return_code.rst 0000664 0000000 0000000 00000000150 15130432351 0017736 0 ustar 00root root 0000000 0000000 ReturnCode
==========================
.. autoclass:: someipy::ReturnCode
:exclude-members: __init__ someipy-2.1.2/docs/api/serialization.rst 0000664 0000000 0000000 00000000151 15130432351 0020303 0 ustar 00root root 0000000 0000000 Serialization
=================
.. automodule:: someipy.serialization
:members:
:show-inheritance: someipy-2.1.2/docs/api/server_service_instance.rst 0000664 0000000 0000000 00000000173 15130432351 0022344 0 ustar 00root root 0000000 0000000 ServerServiceInstance
=======================
.. autoclass:: someipy::ServerServiceInstance
:exclude-members: __init__ someipy-2.1.2/docs/api/service.rst 0000664 0000000 0000000 00000000140 15130432351 0017064 0 ustar 00root root 0000000 0000000 Service
=======================
.. autoclass:: someipy::Service
:exclude-members: __init__
someipy-2.1.2/docs/api/service_builder.rst 0000664 0000000 0000000 00000000155 15130432351 0020600 0 ustar 00root root 0000000 0000000 ServiceBuilder
=======================
.. autoclass:: someipy::ServiceBuilder
:exclude-members: __init__ someipy-2.1.2/docs/api/someipy_logging.rst 0000664 0000000 0000000 00000000121 15130432351 0020616 0 ustar 00root root 0000000 0000000 someipy_logging
=======================
.. automodule:: someipy.someipy_logging
someipy-2.1.2/docs/api/transport_layer_protocol.rst 0000664 0000000 0000000 00000000201 15130432351 0022573 0 ustar 00root root 0000000 0000000 TransportLayerProtocol
===========================
.. autoclass:: someipy::TransportLayerProtocol
:exclude-members: __init__ someipy-2.1.2/docs/calling_methods.rst 0000664 0000000 0000000 00000016602 15130432351 0020021 0 ustar 00root root 0000000 0000000 Calling SOME/IP Methods
=======================
SOME/IP Methods
---------------
Methods implement a request-response communication in the SOME/IP protocol. A server offers a method. A client calls the method by sending a request message to the server. The server answers the request message with a response message. In contrast to SOME/IP events, no subscription of the offered service has to be set up in order to make a method request call.
Request and response messages can carry a serialized payload. Typically, the payload is either the argument to the method or the return value of the method. For defining the service interface data types which can be used in methods and serializing structured data into ``bytes`` follow the article :doc:`service_interface`.
In SOME/IP there is also the possibility of fire&forget communication. The client sends a request message and does not expect a response from the server. The fire&forget communication is not implemented in someipy yet.
Step 1: Define the Data Types for Request and Response
------------------------------------------------------
In this example, we will call a SOME/IP method that calculates the sum of two signed integers and returns the result back to the client. When we are calling the method, we will pass the two addends with the request message to the server. The server will send back a response message containing the sum. For request and response, we need to define two data types ``Addends`` and ``Sum``. The data types are the same types as defined in the article :doc:`offering_methods`.
.. code-block:: python
@dataclass
class Addends(SomeIpPayload):
addend1: Sint16
addend2: Sint16
def __init__(self, addend1: int = 0, addend2: int = 0):
self.addend1 = Sint16(addend1)
self.addend2 = Sint16(addend2)
@dataclass
class Sum(SomeIpPayload):
value: Sint32
def __init__(self):
self.value = Sint32()
Details on defining data types can be found :doc:`here `.
Step 2: Connect to the someipy Daemon
--------------------------------------
The first step is to connect to the someipy daemon. The daemon is a separate process communicating with the application using someipy via a Unix Domain Socket (UDS). The daemon is responsible for handling all communication with the SOME/IP network, including service discovery and message sending/receiving.
.. code-block:: python
someipy_daemon = await connect_to_someipy_daemon()
Step 3: Definition of the Service
----------------------------------
A SOME/IP method is part of a service and so we will define a ``Service`` as the next step using the method ID and the major version of the service. In the third step, this service will be used for creating a ``ClientServiceInstance`` on which we can call the SOME/IP method. The ``ServiceBuilder`` class offers a fluent API, which is used for creation of the ``Service`` object.
.. code-block:: python
SAMPLE_SERVICE_ID = 0x1234
addition_method = Method(
id=SAMPLE_METHOD_ID,
protocol=TransportLayerProtocol.UDP,
)
addition_service = (
ServiceBuilder()
.with_service_id(SAMPLE_SERVICE_ID)
.with_major_version(1)
.with_method(addition_method)
.build()
)
Step 4: Instantiate the Service
-------------------------------
The previously defined ``Service`` can be instantiated into one or multiple service instances. Since we want to call (and not offer) a method, we will instantiate a ``ClientServiceInstance``.
.. code-block:: python
SAMPLE_INSTANCE_ID = 0x5678
client_instance_addition = ClientServiceInstance(
daemon=someipy_daemon,
service=addition_service,
instance_id=SAMPLE_INSTANCE_ID,
endpoint_ip=interface_ip,
endpoint_port=3002,
)
Step 5: Calling the Method
---------------------------
Finally, we need to setup the method parameters for the request and call the SOME/IP method offered by the server. In this case, the parameter to the method is an ``Addends`` object. After creating the ``Addends`` object, we will call the method on the ``ClientServiceInstance`` using the ``call_method`` function. ``call_method`` is a coroutine which has to be awaited and will not block until the response from the server is received. This allows other tasks to be scheduled while waiting for a response. The ``call_method`` function expects a method ID identifying the method on the server to be called. A server could offer multiple methods inside the same service. The second parameter is the payload to be sent with the request: The ``Addends`` object is serialized into a ``bytes`` object and passed to the call.
The ``call_method`` function returns a ``MethodResult`` object with the following members:
- message_type (``MessageType``): The MessageType is an enum and can be either ``MessageType.RESPONSE`` or ``MessageType.ERROR``.
- return_code (``ReturnCode``): The ``ReturnCode`` enum reflects the return codes defined in the `SOME/IP protocol specification `_. For indicating a successful method call to the client, ``E_OK`` is returned by the server.
- payload (``bytes``): The payload is a ``bytes`` object which can be deserialized into the expected returned message structure. In this case it will be deserialized into a ``Sum`` object.
The ``call_method`` function can raise a ``RuntimeError`` or an ``asyncio.TimeoutError``. A ``RuntimeError`` is raised in case the service instance offered by the server was not found yet. In this case no method request can be sent since the destination IP address and port are not available yet. The ``asyncio.TimeoutError`` is raised if no response is received by the server after sending the request or in case of TCP, the TCP connection cannot be established.
To avoid the ``RuntimeError`` it is possible to test whether the service was already found by using the ``service_found`` method on the ``ClientServiceInstance``.
.. code-block:: python
method_parameter = Addends(addend1=1, addend2=2)
while True:
try:
method_result = await client_instance_addition.call_method(
SAMPLE_METHOD_ID, method_parameter.serialize()
)
if method_result.message_type == MessageType.RESPONSE:
print(
f"Received result for method: {' '.join(f'0x{b:02x}' for b in method_result.payload)}"
)
if method_result.return_code == ReturnCode.E_OK:
sum = Sum().deserialize(method_result.payload)
print(f"Sum: {sum.value.value}")
else:
print(
f"Method call returned an error: {method_result.return_code}"
)
elif method_result.message_type == MessageType.ERROR:
print("Server returned an error..")
# In case the server includes an error message in the payload, it can be deserialized and printed
except Exception as e:
print(f"Error during method call: {e}")
Step 6: Shutdown the Application
--------------------------------
At the end of your application, make sure to stop offering the service instance and disconnect from the someipy daemon to ensure a clean shutdown of the application.
.. code-block:: python
await service_instance_temperature.stop_offer()
await someipy_daemon.disconnect_from_daemon() someipy-2.1.2/docs/changelog.rst 0000664 0000000 0000000 00000004606 15130432351 0016615 0 ustar 00root root 0000000 0000000 CHANGELOG
=========
All notable user-facing changes to this project are documented in this file.
HEAD
----
Code changes to ``master`` that are *not* in the latest release:
Release v2.1.2
-----------------
- Fix SO_REUSEADDR socket option on Windows
Release v2.1.1
-----------------
- Fix Python import issue
Release v2.1.0
-----------------
- Support Windows: Use tcp socket for daemon communication on Windows systems.
- Add support for broadcasting SOME/IP SD messages over UDP.
- Implement stop subscribe functionality in the `someipyd` daemon.
Release v2.0.0
-----------------
- Introduced a new architecture with a `someipyd` daemon for centralized network handling.
- Refined application API for easier service definition and instantiation.
Release v1.0.0
--------------
- Support dynamically sized arrays
- Support fixed size strings
- Support dynamically sized strings
- Implement timeouts (ttl checks) for SD messages
Release v0.0.10
---------------
- Fix Python 3.8 issue from version 0.0.9 (Set of asyncio.Task typing)
- Properly handle major version (interface version) of services
- Handle session IDs and client IDs
- Allow multiple asynchronous method calls from a client and handle out of order method responses
Release v0.0.9
--------------
- Enable asynchronous method handlers
Release v0.0.8
--------------
- Improved method error handling
- Update of method handler function signature
Release v0.0.7
--------------
- Improved integration testing
- Bugfix: Handle subscribe acknowledge correctly
Release v0.0.6
--------------
- Pack together service offers in a single Service Discovery message (this requires the offers to be sent within max. 20ms)
- Send SD stop offer entries when a service instance is shut down
Release v0.0.5
--------------
- Fix issue in socket bind for Service Discovery via multicast to use the right network interface
- Add IPv4 SD Endpoint Option to avoid crashes in case it is received
- Implement proper SD option handling ("first and second option run")
Release v0.0.4
--------------
- Publish library under GPL-3.0 license
Release v0.0.3
--------------
- Support Windows
- Automatic multicast group join
- Support method calls via TCP
Release v0.0.2
--------------
- Support TCP as a transport layer
- Support offering and calling methods
- Add an example of how to replay ROS1 bagfiles into SOME/IP events
- Add docstrings for all public classes and functions
someipy-2.1.2/docs/conf.py 0000664 0000000 0000000 00000002733 15130432351 0015432 0 ustar 00root root 0000000 0000000 # Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import sys
from pathlib import Path
project = "someipy"
copyright = "2025, Christian H."
author = "Christian H."
release = "1.0.0"
sys.path.insert(0, str(Path("..", "src").resolve()))
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
# Autodoc settings
autodoc_default_options = {
"members": True,
"undoc-members": True,
"private-members": False,
}
autodoc_typehints = "description" # Show type hints in description
templates_path = ["_templates"]
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
# html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"
html_static_path = ["images"]
someipy-2.1.2/docs/cookbook.rst 0000664 0000000 0000000 00000000227 15130432351 0016467 0 ustar 00root root 0000000 0000000 Cookbook
==========================
.. toctree::
:maxdepth: 2
calling_methods
offering_methods
subscribing_events
offering_events someipy-2.1.2/docs/getting_started.rst 0000664 0000000 0000000 00000023712 15130432351 0020054 0 ustar 00root root 0000000 0000000 Getting Started
=================
This guide demonstrates how to create a SOME/IP service using someipy that broadcasts temperature measurements every second using SOME/IP events. The complete example is available in the `example applications on GitHub `_.
Prerequisites
----------------
- Linux (Ubuntu 22.04 or equivalent)
- Python 3.8+
- Network interface with multicast support
Installation
------------
Install someipy from PyPI:
.. code-block:: bash
pip3 install someipy
Service Data Type Definition
---------------------------
Define the temperature data structure using Python dataclasses. No IDL files required.
Create ``temperature_msg.py``:
.. code-block:: python
from dataclasses import dataclass
from someipy.serialization import (
SomeIpPayload,
SomeIpFixedSizeArray,
Uint8,
Uint64,
Float32,
)
@dataclass
class Version(SomeIpPayload):
major: Uint8
minor: Uint8
def __init__(self):
self.major = Uint8()
self.minor = Uint8()
@dataclass
class TemperatureMsg(SomeIpPayload):
version: Version
timestamp: Uint64
measurements: SomeIpFixedSizeArray
def __init__(self):
self.version = Version()
self.timestamp = Uint64()
self.measurements = SomeIpFixedSizeArray(Float32, 4)
Asyncio App Implementation
--------------------------
someipy is an `asyncio `_ based Python library, since multiple concurrent tasks are running in the SOME/IP implementation, e.g. for communicating with the someipy daemon.
First we will set up our application's structure. Typically in an asyncio application, a main coroutine-function is added which is executed using `asyncio.run `_. Our application's logic will be added inside the main coroutine-function *async def main*.
Create ``send_events_udp.py`` with the following structure:
.. code-block:: python
import asyncio
import ipaddress
import logging
async def main():
# .. our application will go here
except asyncio.CancelledError:
print("Application cancelled...")
finally:
print("Cleanup...")
print("End main task...")
if __name__ == "__main__":
try:
asyncio.run(main())
except KeyboardInterrupt:
pass
someipy Logging
---------------
At the beginning of the application the someipy logging level is configured. Logging levels can be chosen from the `Python3 logging module levels `_.
.. code-block:: python
import logging
async def main():
# .. our application will go here
set_someipy_log_level(logging.DEBUG)
Connect to the someipy Daemon
-----------------------------
The next step is to connect to the someipy daemon. The daemon is a separate process communicating with the application using someipy via a Unix Domain Socket (UDS). The daemon is responsible for handling all communication with the SOME/IP network, including service discovery and message sending/receiving.
.. code-block:: python
someipy_daemon = await connect_to_someipy_daemon()
In case, a non-default Unix Domain Socket path is used, a config dictionary can be passed to the *connect_to_someipy_daemon* function.
If Windows is used, TCP sockets have to be used for communication between the application and the someipy daemon. In this case, the *connect_to_someipy_daemon* function has to be called with a config dictionary containing the keys *use_tcp*, *tcp_host* and optionally *tcp_port*.
.. code-block:: python
someipy_daemon = await connect_to_someipy_daemon(
{"use_tcp": True, "tcp_host": interface_ip, "tcp_port": 30500}
)
Defining the SOME/IP Service
----------------------------
For offering a SOME/IP service, you first define a `Service `_ containing **EventGroups** or **Methods** using the `ServiceBuilder `_. Afterwards the Service can be instantiated as a Server- or Client-Instance.
In this example, a *temperature_service* with service ID 0x1234 containing a single event group with ID 0x0321 which in turn contains a single event with ID 0x0123. The service has a major version 1 and minor version 0:
.. code-block:: python
from someipy import ServiceBuilder, EventGroup
async def main():
# ...
SAMPLE_SERVICE_ID = 0x1234
SAMPLE_EVENTGROUP_ID = 0x0321
SAMPLE_EVENT_ID = 0x0123
temperature_event = Event(id=SAMPLE_EVENT_ID, protocol=TransportLayerProtocol.UDP)
temperature_eventgroup = EventGroup(
id=SAMPLE_EVENTGROUP_ID, events=[temperature_event]
)
temperature_service = (
ServiceBuilder()
.with_service_id(SAMPLE_SERVICE_ID)
.with_major_version(1)
.with_eventgroup(temperature_eventgroup)
.build()
)
# ...
Instantiating the SOME/IP Service
---------------------------------
Once the `Service `_ is defined it can be instantiated multiple times.
For offering a `Service `_ in someipy the `ServerServiceInstance `_ class is used. For using a service as client the `ClientServiceInstance `_ class is used.
The constructor of the *ServerServiceInstance* class requires several parameters:
- daemon: The *someipy_daemon* object (defined above)
- service: The *Service* object (defined above)
- instance_id: A service instance ID (0x5678 in this example)
- endpoint_ip: The IP address of the network interface on which the service is offered (127.0.0.1 in this example)
- endpoint_port: The port on which the service is offered (3000 in this example)
- ttl: The time-to-live for the service discovery entries (5 seconds in this example)
- cyclic_offer_delay_ms: The period of the cylic offer service SD messages (2000 ms in this example)
Afterwards, the the SOME/IP service can be offered using the *start_offer* method. When exiting your application make sure to use *stop_offer* method on the service instance.
.. code-block:: python
from someipy import TransportLayerProtocol, construct_server_service_instance
async def main():
# ...
SAMPLE_INSTANCE_ID = 0x5678
service_instance_temperature = ServerServiceInstance(
daemon=someipy_daemon,
service=temperature_service,
instance_id=SAMPLE_INSTANCE_ID,
endpoint_ip=interface_ip,
endpoint_port=3000,
ttl=5,
cyclic_offer_delay_ms=2000,
)
# After constructing a ServerServiceInstances the start_offer method has to be called. This will start an internal timer,
# which will periodically send Offer service entries with a period of "cyclic_offer_delay_ms" which has been passed above
print("Start offering service..")
await service_instance_temperature.start_offer()
# ...
# Before exiting the app: service_instance_temperature.stop_offer()
Sending Events
--------------
Now it is time to send events to subscribed clients. First some data has to be prepared: Import and instantiate the *TemperatureMsg* and fill it with some data:
.. code-block:: python
from someipy.serialization import Uint8, Uint64, Float32
from temperature_msg import TemperatureMsg
async def main():
# ...
tmp_msg = TemperatureMsg()
tmp_msg.version.major = Uint8(1)
tmp_msg.version.minor = Uint8(0)
tmp_msg.measurements.data[0] = Float32(20.0)
tmp_msg.measurements.data[1] = Float32(21.0)
tmp_msg.measurements.data[2] = Float32(22.0)
tmp_msg.measurements.data[3] = Float32(23.0)
# ...
Afterwards we will start an endless loop sending data every second using the *send_event* method on the service instance. The *send_event* method takes a bytes-object which can be retrieved serializing the *TemperatureMsg*.
.. code-block:: python
async def main():
# ...
try:
# Cyclically send events in an endless loop...
while True:
await asyncio.sleep(1)
tmp_msg.timestamp = Uint64(tmp_msg.timestamp.value + 1)
payload = tmp_msg.serialize()
service_instance_temperature.send_event(
SAMPLE_EVENTGROUP_ID, SAMPLE_EVENT_ID, payload
)
except asyncio.CancelledError:
print("Stop offering service...")
await service_instance_temperature.stop_offer()
finally:
print("Service Discovery close...")
service_discovery.close()
# ...
Network Configuration
---------------------
If you are using Linux, make sure to join the multicast group for your network interface used for the service discovery before starting the application. In our example we use 224.224.224.245 and the loopback interface. Make sure to adjust the command for your project. Otherwise, it will not be possible for clients to subscribe to your SOME/IP service.
.. code-block:: bash
sudo ip addr add 224.224.224.245 dev lo autojoin
python3 send_events_udp.py
Start the someipy Daemon
-----------------------------
Before running the application, ensure that the someipy daemon is running. The daemon can be started using the following command:
.. code-block:: bash
someipyd --config someipyd.json
The .json configuration file is optional and can be omitted.
Start the Application
----------------------
Run the application using Python 3:
.. code-block:: bash
python3 send_events_udp.py
someipy-2.1.2/docs/images/ 0000775 0000000 0000000 00000000000 15130432351 0015373 5 ustar 00root root 0000000 0000000 someipy-2.1.2/docs/images/pc_ip4_settings.png 0000664 0000000 0000000 00000100361 15130432351 0021200 0 ustar 00root root 0000000 0000000 ‰PNG
IHDR P ÙJ sBIT|dˆ tEXtSoftware gnome-screenshotï¿> IDATxœìÝwxÕÔÀñorïín)Ý›¶¬BÙC†ì
"(Š ‚{‹þT\¸PEQ�
¢EÜŠÊ,²¤P(ЖҖ®Ûq{oòû£´v·—ÕÞÏóôi›œ$oÒžä½çœ$ʪU«t]×Ñu€Š~.;MӴ⟫ú^™êæ×Ô¡C‡hÔ¨ÑyY—B!êEQj<äô¢ßKN/;ìô²?«J˜ªú*Y¾ì²e�¯„©,MÓŠ“9!„Bˆ"%“ž¢ïý¬ªj©i%QEó‹òEQ
( 8)ù½dRTÙ|(ŸH•ü^‘ó•PÙl6¬VëyY—B!꿲‰SÑÏ•µ4éº^a⤪*º®'XEËå0F¨8iª(�ª,‘ʵ>U•HI%„BˆsU]^eP%K•ußišVae,›(%I%¦’ßóóóÉÎÎ&''«ÕJAAA©d«¤šŽ‰:[IIIäçç_�u!„¢n+›@U7þIUUL&F£ÜÜÜptt,n…*™H•‡ÂÆ¢¢ùEë4Õ&N𦑗—GJJ
¡¡¡:”ÀÀ@CñÆ„B!ê²¢¼¦ €¤¤$6oÞL||<>>>8998/JœJ6)Ë–-ÓK&Je'MÓ8uê¾¾¾\wÝu¸¹¹QPP€Õj-U^!„¢.+J†TUÅh4b2™0›Í,_¾œS§NáããƒÁ`(U®¨¡¨ìweéÒ¥º®ëØl¶rÉ“Õj%!!�#Fкukòóó±X,µ½ÿB!„ç…ƒƒŽŽŽìܹ“5kÖˆÑh,•@•L¤Š’(cÙãe“§I“&@vv¶´4 !„â’b±X((( M›6x{{3þ|‚‚‚*,[”D麎Z²«®èËf³qêÔ)†
†ŸŸf³Y’'!„B\’t]Çl6Ȉ#HII)—•ê¤Vt÷]nn.~~~´iÓ†ÜÜÜÚÞ/!„Bˆ.77—Ö[ãëëKnnn¹G:•ü2–0®i)))Lž<¹ÒäI×u233ÉÊÊ"??_Z§ÎPGGGÜÜÜhÐ �Ü�(„¢VÈuºb5¹Nçææ2fÌf̘APPP©n–K Ê>® 44‡
ŒkšFbb"NNNDFFâææVêS—3MÓÈÎÎ&11‘ÄÄDäØ!„¸¨Š®ÓŽŽŽ„‡‡ãêê*×¢34MÃl6“””TéuZ×u
%''''§RÖ,ʛԒýyº®“��MïÞ½+Lžt]'11š7oއ‡‡üQJPUš7oŽ··7III’õ!„¸hŠ®Ó^^^4mÚwww¹N— ª*îîî4mÚ”†
Vz�¶X,ôéÓ§øºŠºòÔ²-P999øøøT¸áÌÌLœœœ¾ÐûXïãèèHFFFm‡"„â2‘™™‰££c¥w‘‰ÿáààPéuÚÇǧÜ8¨’?«egX,–JÇîdeex!÷ç’Hvvvm‡!„â2‘••E@@@m‡Qo=¦©"Š¢`±Xʽ¡¥8�‚Ò/¶Z•6÷Y,\]]/Üž\b\]]åÁ£B!.‹Å‚‹‹Km‡Qo¸¸¸Tz�6XÖ
“'࿨¢ïEO$¯ˆ¦i†¶#—ƒÁPé±B!Î7¹NÛ§ªëtÑs1+{”�
¥_&\ô»B!Äåªìs2Ë%Pe[ ¤ÅD!„‚
[žŠ»ðŠ
”,(„Bq¹«¨å (ÿ*Iž í$?ø¼�iÓPBFóÚŒñ4®ì& Û!–<2…UÇ ÑõoòÆ•ûÙu8“ÛvÊeh˜;òI!ê ÜClþòW½º0rPn—IE¨ë®è»±d�‹PöNæ>òK�ùÑcĉÄÙ’Ê‘=ÛÉÌ3Ê Tˆz&²YÆoÓ(8y„ø�Æî
úéïyí‘OÙ£5fÜôç¸*@…ÜãÄ'k ºÓ¸iÆàAÜv{.¿Ÿ§wIž„¨›tÒîå„êŒÃÉ}ìOiJ'ßËïQ eó$ãÅ@žÇîù¯³,>‚[ß}‹››;Ïé9`Ä™Ÿ4Žyާ>ÙJb¦cƒ0:¿›Gn튯
h§øé½WYøÇaNe�‡3¾M»3öþÉŒŽv+< kiìX>›�¾üƒƒ©Vœý¢¸î™·¸¥• ¬Iü±è~»�C)
›÷dÜý02ÊUNàBœ×ÆÍ 6l#ÎÏác6ú¶4’³g{2Íä°�»N34ÀíDÇ
tCÍ"Œ`ÛÏÆ…«ù1Ï¥]W&6=Åï‹–°ag,G“N“c3Ñ |(�¾<žj1_-bÙ·[9œfÃ50Šî×ÜÌø>á8Ÿ©¸º9–�Ÿ~Êš¿’jq#ÐGÃÒ¢-Ű&²ïß,Ú
$ôÈ·ìÜ{ŒÖ½Ãq,š¯ç¿õ7vK#Óœ�MqÄÃ7”æí;åçTx]I™Òåø¯+ٜň«ÛáY¸Òw®em¬?ƒFuÁÿ"Uì²ùQÑïÆŠ
^PyÛY÷m"
ûOfl‰ä©4¯V#¸{ê
ø¸é¤l_ÎÌO^惦˘ÚÛ
…,âvíâtäL}¬9yÇù}é‡Ì~î}B=A—|öúO~f¥÷¤'¸¹©¸€z‚ÿ}À¸^f²o[Ï`Ö3³ Xø]�.ìîq)R£ˆòT‰KIçpÜi´–ìÛ±—<ÀÊ�í1˜õÁvô():BZÕ@¡Ü�Úq¶~÷ÿä‚ÉÙÇ|ÌrÙ³ðE^Z�Í莯�™'vñõìI7½Í£=•�Á¯-^µP©+m�ªhæ… ¥å˜Y%"ªéÙk9
®‘WÐ#ò̯ÍÜ9üÃí|³ç(¶ÞÑg²>—°vté…�ö´÷Ibë½ß²å_+]šüβUqDÞ4Ÿ)ׇQòÏ¢gþÂgkOÑùáYLìÓ húpŽû”w?L×Îl×…¸t™"‰næÄ†”\âÿ=„e�3Ûb²Q#ÚÓ:c1{·“Óר#hºJè–ª”O Š(þ�:“‰Í
Ø0œþž¹�a36gü/2*Ì@Êw¯0yÎþúöÒº¥aÒ/lÜ‘�fb賯r{[wr~x•[gý]g¤
QïèY>�€sä`L 5#Òy#bÓiÖ®a©'&Ï@‚ƒ|P $(ØÖ~;='hÙ3“eŠ8† náXBQM�ÁšBrª‚o¿re/¤ŠÆ@A™Aäe¾@‘ C¥/,.T@¯øpé�üŸJ¾ƒ¦†èÊß+§ d�‘©c=ºŸƒy~ôhDÙœÖvì ‡rsIš>ŠÓ‹ƒÂfUpL5ˉVˆ³âDóVM0þCîÁÄîµ²ý´JØàq\}껿ßÍ_»|ÈŒ¦¸Ð¢uãž LÖ¸9dÑÑõ,ž|=‹K”PSN’¢AƒG9nÕQ¶¦KËÂñTF‡Ëoœ†ç“–~ˆƒ©
hÜÍ»0Y2øÒ¤±'ûÅ’Òº3~•U1ƒÁ�Îü“˜J–†WE—ü²eÊÎw!