someipy

https://someipy.readthedocs.io/en/latest/
Admin
An open-source Python library that implements the SOME/IP protocol and SOME/IP Service Discovery,...
Tokens:16,029
Snippets:182
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start the someipy Daemon

Source: https://someipy.readthedocs.io/en/latest/someipy_daemon.html

Run this command in your terminal to start the someipy daemon. Ensure the library is installed via pip3 install someipy.

```bash
someipyd

```

--------------------------------

### Start the someipy Daemon with Configuration

Source: https://someipy.readthedocs.io/en/latest/someipy_daemon.html

Start the someipy daemon and specify a custom configuration file using the --config argument. This allows customization of daemon behavior.

```bash
someipyd --config /path/to/config.json

```

--------------------------------

### Install someipy

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Install the someipy library using pip. Ensure Python 3.8+ is used.

```bash
pip3 install someipy

```

--------------------------------

### Start the SOME/IP Daemon

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Ensure the someipy daemon is running before executing your application. It can be started with an optional configuration file.

```bash
someipyd --config someipyd.json

```

--------------------------------

### start_offer

Source: https://someipy.readthedocs.io/en/latest/api/server_service_instance.html

Starts offering the service instance via the service discovery offer entries. This method gathers the current service methods and event groups and invokes the daemon to advertise the service with the configured endpoint and version information.

```APIDOC
## start_offer

### Description
Start offering the service instance via the service discovery offer entries. This method gathers the current service methods and event groups and invokes the daemon to advertise the service with the configured endpoint and version information.

### Returns
None
```

--------------------------------

### Configure Network for SOME/IP Service Discovery (Linux)

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

On Linux, join the multicast group for your network interface before starting the application to enable clients to subscribe to your SOME/IP service.

```bash
sudo ip addr add 224.224.224.245 dev lo autojoin
python3 send_events_udp.py

```

--------------------------------

### someipy Daemon Configuration File Example

Source: https://someipy.readthedocs.io/en/latest/someipy_daemon.html

A JSON configuration file for the someipy daemon. All fields are optional and allow customization of service discovery, logging, and network interface settings.

```json
{
    "sd_address": "224.224.224.245",
    "sd_port": 30490,
    "log_level": "DEBUG",
    "interface": "127.0.0.2",
    "log_path": "/var/log/someipy.log",
    "use_tcp": false,
    "tcp_host": "127.0.0.1",
    "tcp_port": 30500

}

```

--------------------------------

### Define a SOME/IP Service with a Method

Source: https://someipy.readthedocs.io/en/latest/offering_methods.html

Use the ServiceBuilder to define a service and add methods to it. This example adds a single addition method to a service with a specific ID and major version.

```python
SAMPLE_SERVICE_ID = 0x1234

addition_method = Method(
     id=SAMPLE_METHOD_ID,
     protocol=TransportLayerProtocol.UDP,
     method_handler=add_method_handler,
 )

 addition_service = (
     ServiceBuilder()
     .with_service_id(SAMPLE_SERVICE_ID)
     .with_major_version(1)
     .with_method(addition_method)
     .build()
 )

```

--------------------------------

### someipy.serialization.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serializes an object into bytes by iterating over its attributes, excluding those starting with double underscores or underscores. For each attribute, it calls the serialize method of the attribute and appends the returned bytes to the output.

```APIDOC
## someipy.serialization.serialize(obj)

### Description
Serializes an object into bytes by iterating over its attributes, excluding those starting with double underscores or underscores. For each attribute, it calls the serialize method of the attribute and appends the returned bytes to the output.

### Parameters
#### Path Parameters
- **obj** (object) - The object to be serialized.

### Returns
- **bytes** - The serialized representation of the object as bytes.
```

--------------------------------

### Instantiate a Server Service Instance

Source: https://someipy.readthedocs.io/en/latest/offering_methods.html

Create a ServerServiceInstance to offer a defined SOME/IP service on a specific network interface and port. Configure parameters like TTL and cyclic offer delay.

```python
SAMPLE_INSTANCE_ID = 0x5678

service_instance_addition = ServerServiceInstance(
    daemon=someipy_daemon,
    service=addition_service,
    instance_id=SAMPLE_INSTANCE_ID,
    endpoint_ip=interface_ip,
    endpoint_port=3000,
    ttl=5,
    cyclic_offer_delay_ms=2000,
)

```

--------------------------------

### Instantiate a Client Service Instance

Source: https://someipy.readthedocs.io/en/latest/subscribing_events.html

Create a ClientServiceInstance to subscribe to events. This requires the connected daemon, the defined service, an instance ID, and the IP address and port for receiving events.

```python
from someipy.client_service_instance import ClientServiceInstance

service_instance_temperature = ClientServiceInstance(
    daemon=someipy_daemon,
    service=temperature_service,
    instance_id=SAMPLE_INSTANCE_ID,
    endpoint_ip=interface_ip,
    endpoint_port=3002,
)

```

--------------------------------

### Instantiate a Client Service Instance

Source: https://someipy.readthedocs.io/en/latest/calling_methods.html

Create a ClientServiceInstance to call a SOME/IP method. This requires the connected daemon, the service definition, a unique instance ID, and the endpoint details.

```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,
)

```

--------------------------------

### Server-Side Service Instance Configuration

Source: https://someipy.readthedocs.io/en/latest/service_discovery.html

Instantiate a server-side service instance with parameters controlling the Service Discovery offer lifetime and frequency.

```python
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,
 )
```

--------------------------------

### Instantiate a SOME/IP Server Service

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Use ServerServiceInstance to offer a service. Configure parameters like daemon, service object, instance ID, IP, port, TTL, and cyclic offer delay.

```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()

```

--------------------------------

### Connect to someipy Daemon

Source: https://someipy.readthedocs.io/en/latest/whatsnew.html

Establishes a connection to the someipyd daemon. Ensure the daemon is running before executing.

```python
someipy_daemon = await connect_to_someipy_daemon()

```

--------------------------------

### Run the SOME/IP Application

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Execute your SOME/IP application using Python 3.

```bash
python3 send_events_udp.py

```

--------------------------------

### Construct ClientServiceInstance

Source: https://someipy.readthedocs.io/en/latest/whatsnew.html

Constructs a ClientServiceInstance for interacting with a specific service. Requires the connected daemon, service definition, instance ID, and endpoint details.

```python
client_instance_addition = ClientServiceInstance(
    daemon=someipy_daemon,
    service=addition_service,
    instance_id=SAMPLE_INSTANCE_ID,
    endpoint_ip=interface_ip,
    endpoint_port=3002,
)

```

--------------------------------

### connect_to_someipy_daemon

Source: https://someipy.readthedocs.io/en/latest/api/index.html

Establishes a connection to the someipy daemon.

```APIDOC
## connect_to_someipy_daemon

### Description
Establishes a connection to the someipy daemon.

### Method
(Function Signature - specific details not provided in source)

### Parameters
(Parameters not explicitly defined in source)

### Request Example
(Not applicable for a function call)

### Response
(Response details not explicitly defined in source)
```

--------------------------------

### Basic Asyncio Application Structure

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Set up the basic structure for an asyncio application. The main logic will be placed within the `main` coroutine function.

```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


```

--------------------------------

### Prepare and Send SOME/IP Events

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Prepare event data using message objects and send them periodically using the send_event method. Ensure the message is serialized into a bytes object.

```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)
    # ...


```

```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()

        # ...


```

--------------------------------

### ServiceBuilder build()

Source: https://someipy.readthedocs.io/en/latest/api/service_builder.html

Builds and returns the configured Service object.

```APIDOC
## build()

### Description
Builds and returns a Service.

### Returns
Service - The built Service.

### Return type
_Service_
```

--------------------------------

### Define a Service with Methods

Source: https://someipy.readthedocs.io/en/latest/whatsnew.html

Defines a service, including its methods, event groups, and events. This is a prerequisite for service interaction.

```python
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()
)

```

--------------------------------

### Connect to the someipy Daemon (TCP on Windows)

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Connect to the someipy daemon using TCP sockets on Windows. Specify the interface IP and optionally the TCP port.

```python
someipy_daemon = await connect_to_someipy_daemon(
    {"use_tcp": True, "tcp_host": interface_ip, "tcp_port": 30500}
)


```

--------------------------------

### ServerServiceInstance Constructor

Source: https://someipy.readthedocs.io/en/latest/api/server_service_instance.html

Initializes a ServerServiceInstance. This class manages the lifecycle of offering a service instance via the Some/IP-SD mechanism and enables sending events to subscribed clients.

```APIDOC
## ServerServiceInstance Constructor

### Description
Initializes a ServerServiceInstance. This class manages the lifecycle of offering a service instance via the Some/IP-SD mechanism and enables sending events to subscribed clients.

### Parameters

*   **daemon** (SomeIpDaemonClient) - Daemon client used to communicate with the someipy daemon.
*   **service** (Service) - Service configuration for this instance.
*   **instance_id** (int) - Instance ID for this service instance.
*   **endpoint_ip** (str) - IP address of the endpoint on which the service instance is reachable.
*   **endpoint_port** (int) - Port of the endpoint on which the service instance is reachable.
*   **ttl** (int, optional) - TTL used for Service Discovery offers. Default: 0.
*   **cyclic_offer_delay_ms** (int, optional) - Delay between cyclic offers in milliseconds. Default: 2000.
```

--------------------------------

### connect_to_someipy_daemon

Source: https://someipy.readthedocs.io/en/latest/api/connect_to_someipy_daemon.html

Connects to the someipy daemon. It can optionally accept a configuration dictionary to specify the socket path.

```APIDOC
## connect_to_someipy_daemon()

### Description
Connect to the someipy daemon.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **config** (dict, optional) - Configuration dictionary. Supported keys include `socket_path` for the Unix domain socket path. Defaults to `/tmp/someipyd.sock`.

### Returns
- **SomeIpDaemonClient** - An instance of the SomeIpDaemonClient class.
```

--------------------------------

### Connect to the someipy Daemon (UDS)

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Connect to the someipy daemon using a Unix Domain Socket (UDS). The daemon handles network communication.

```python
someipy_daemon = await connect_to_someipy_daemon()


```

--------------------------------

### Define a Service with an Event

Source: https://someipy.readthedocs.io/en/latest/subscribing_events.html

Define a SOME/IP service that includes an event. This involves creating an Event object, grouping it into an EventGroup, and then building the Service object using ServiceBuilder. Ensure correct service, instance, eventgroup, and event IDs are used.

```python
from someipy import ServiceBuilder, EventGroup, Event, TransportLayerProtocol

SAMPLE_SERVICE_ID = 0x1234
SAMPLE_INSTANCE_ID = 0x5678
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()
)

```

--------------------------------

### Configure someipy Logging Level

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Configure the someipy logging level at the beginning of the application. Logging levels can be chosen from Python3 logging module levels.

```python
import logging

async def main():
    # .. our application will go here
    set_someipy_log_level(logging.DEBUG)


```

--------------------------------

### Define a SOME/IP Service

Source: https://someipy.readthedocs.io/en/latest/calling_methods.html

Define a SOME/IP service using the ServiceBuilder. Specify the service ID, major version, and the methods it contains. This is necessary for creating a client service instance.

```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()
)

```

--------------------------------

### Define SOME/IP Service with EventGroup

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Define a SOME/IP service with a specific service ID, major version, and an event group containing an event. This uses the ServiceBuilder.

```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()
     )
    # ...


```

--------------------------------

### Stop Offering Service and Disconnect

Source: https://someipy.readthedocs.io/en/latest/calling_methods.html

Cleanly shut down the application by stopping the service instance and disconnecting from the SOME/IP daemon.

```python
await service_instance_temperature.stop_offer()
await someipy_daemon.disconnect_from_daemon()

```

--------------------------------

### Call Method and Deserialize Result

Source: https://someipy.readthedocs.io/en/latest/whatsnew.html

Prepares method parameters, invokes a method on the service instance, and deserializes the response payload. Ensure the method ID and parameters are correctly formatted.

```python
method_parameter = Addends(addend1=1, addend2=2)
method_result = await client_instance_addition.call_method(
    SAMPLE_METHOD_ID, method_parameter.serialize()
)

sum = Sum().deserialize(method_result.payload)
print(f"Sum: {sum.value.value}")

```

--------------------------------

### someipy_logging

Source: https://someipy.readthedocs.io/en/latest/api/index.html

Configures or interacts with the someipy logging system.

```APIDOC
## someipy_logging

### Description
Configures or interacts with the someipy logging system.

### Method
(Function Signature - specific details not provided in source)

### Parameters
(Parameters not explicitly defined in source)

### Request Example
(Not applicable for a function call)

### Response
(Response details not explicitly defined in source)
```

--------------------------------

### stop_offer

Source: https://someipy.readthedocs.io/en/latest/api/server_service_instance.html

Stops offering the service instance and sends out a stop offer entry. This stops advertising the service instance to clients via the daemon.

```APIDOC
## stop_offer

### Description
Stop offering the service instance and send out a stop offer entry. This stops advertising the service instance to clients via the daemon.

### Returns
None
```

--------------------------------

### Method Class

Source: https://someipy.readthedocs.io/en/latest/api/method.html

Represents a SOME/IP method with an identifier and an optional handler for server-side invocations.

```APIDOC
## Method Class

### Description
Class representing a SOME/IP method with a method id and a method handler.

### Parameters
- **id** (int) - Required - Method identifier.
- **protocol** (TransportLayerProtocol) - Required - Transport protocol for the method.
- **method_handler** (MethodHandler, optional) - Optional method which is called on server side when an offered service is invoked. The handler shall return a MethodResult.

### Methods
#### `__eq__(self, __value__)`
Check equality with another Method based on id and protocol.

##### Parameters
- **__value** (object) - Another Method instance.

##### Returns
- bool - True if ids and protocols match, False otherwise.

#### `__hash__(self)`
Hashes object.

##### Returns
- int - Hash of object.

#### `from_json(cls, json_str)`
Create a Method from a JSON string.

##### Parameters
- **json_str** (str) - JSON representation of a Method.

##### Returns
- Method - The constructed Method instance.

#### `to_json(self)`
Serialize this Method to a JSON string.

##### Returns
- str - JSON representation of the method.

##### Parameters
- **id** (int) – Method identifier.
- **protocol** (TransportLayerProtocol) – Transport protocol for the method.
- **method_handler** (Callable[[bytes, Tuple[str, int]], MethodResult]) – Optional method handler.
```

--------------------------------

### Implement SOME/IP Method Handler

Source: https://someipy.readthedocs.io/en/latest/offering_methods.html

This asynchronous function handles incoming SOME/IP method calls. It deserializes input data, performs a calculation, and serializes the result. Use this for I/O-bound operations within your method handlers.

```python
async def add_method_handler(input_data: bytes, addr: Tuple[str, int]) -> MethodResult:
    print(
        f"Received data: {' '.join(f'0x{b:02x}' for b in input_data)} from IP: {addr[0]} Port: {addr[1]}"
    )

    result = MethodResult()

    try:
        # Deserialize the input data
        addends = Addends()
        addends.deserialize(input_data)
    except Exception as e:
        print(f"Error during deserialization: {e}")

        # Set the return code to E_MALFORMED_MESSAGE and return
        result.message_type = MessageType.RESPONSE
        result.return_code = ReturnCode.E_MALFORMED_MESSAGE
        return result

    # Perform the addition
    sum = Sum()
    sum.value = Sint32(addends.addend1.value + addends.addend2.value)
    print(f"Send back: {' '.join(f'0x{b:02x}' for b in sum.serialize())}")

    result.message_type = MessageType.RESPONSE
    result.return_code = ReturnCode.E_OK
    result.payload = sum.serialize()
    return result

```

--------------------------------

### SomeIpDynamicSizeString

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a dynamically sized string for SOME/IP serialization. Supports equality comparison, length retrieval, serialization, and deserialization.

```APIDOC
## SomeIpDynamicSizeString

### Description
A datatype for a SOME/IP dynamically sized string.

### Methods
- `__eq__(other)`: Compares two SomeIpDynamicSizeString objects for equality.
- `__len__()`: Returns the length of the serialized string in bytes.
- `deserialize(payload: bytes)`: Deserializes a byte payload into the string object.
- `serialize()`: Serializes the string object into bytes.

### Properties
- `data` (str): The string value.
- `encoding` (str): The encoding of the string.
- `length_field_length`: The length of the field used to store the string's length.
```

--------------------------------

### Define a SOME/IP Service with Events

Source: https://someipy.readthedocs.io/en/latest/offering_events.html

Defines a SOME/IP service with a specific ID, major version, and an eventgroup containing a UDP event. The ServiceBuilder is used for this definition.

```python
SAMPLE_SERVICE_ID = 0x1234
SAMPLE_INSTANCE_ID = 0x5678
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()
)

```

--------------------------------

### ClientServiceInstance

Source: https://someipy.readthedocs.io/en/latest/api/client_service_instance.html

Represents a client-side SOME/IP service instance. Provides methods to call SOME/IP methods and subscribe to SOME/IP events.

```APIDOC
## ClientServiceInstance Class

### Description
Client-side representation of a SOME/IP service instance. This class provides methods to call SOME/IP methods and to subscribe to SOME/IP events.

### Parameters
* **daemon** (SomeIpDaemonClient) - 
* **service** (Service) - 
* **instance_id** (int) - 
* **endpoint_ip** (str) - 
* **endpoint_port** (int) - 
* **client_id** (int) - Optional, defaults to 0

### Methods
#### `call_method(method_id, payload)`

##### Description
Calls a SOME/IP method.

##### Parameters
* **method_id** (int) - The ID of the method to call.
* **payload** (bytes) - The payload of the method call.

##### Return Type
MethodResult

#### `is_available()`

##### Description
Checks if the service instance is available.

##### Return Type
bool

#### `register_callback(callback)`

##### Description
Registers a callback for received SOME/IP events. The registered callback will be invoked with (event_id, payload) when an event is received.

##### Parameters
* **callback** (Callable[[int, bytes], None]) - Callback function invoked when an event is received.

##### Return Type
None

#### `subscribe_eventgroup(eventgroup, ttl_subscription_seconds)`

##### Description
Subscribes to an event group.

##### Parameters
* **eventgroup** (EventGroup) - The event group to subscribe to.
* **ttl_subscription_seconds** (int) - The time-to-live for the subscription in seconds.

#### `unsubscribe_eventgroup(eventgroup)`

##### Description
Unsubscribes from an event group.

##### Parameters
* **eventgroup** (EventGroup) - The event group to unsubscribe from.

### Properties
#### `endpoint`

##### Description
Return the (IP, port) endpoint for this client instance.

##### Type
Tuple[str, int]

#### `instance_id`

##### Description
Return the instance ID for this client service instance.

##### Type
int

#### `service`

##### Description
Return the associated Service object for this client instance.

##### Type
Service

### Internal Methods (Not for direct user invocation)
#### `someip_message_received(someip_message, addr)`

##### Parameters
* **someip_message** (SomeIpMessage) - 
* **addr** (Tuple[str, int]) - 

##### Return Type
None
```

--------------------------------

### Define Data Types for SOME/IP Methods

Source: https://someipy.readthedocs.io/en/latest/calling_methods.html

Define data structures for method requests and responses using dataclasses. Ensure these types inherit from SomeIpPayload and use appropriate SOME/IP data types.

```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()

```

--------------------------------

### Call SOME/IP Method and Handle Response

Source: https://someipy.readthedocs.io/en/latest/calling_methods.html

Call a SOME/IP method with serialized parameters and process the response, including success and error cases. This coroutine should be awaited and does not block other tasks.

```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}")

```

--------------------------------

### ServiceBuilder with_method(method)

Source: https://someipy.readthedocs.io/en/latest/api/service_builder.html

Adds a method to the service being built.

```APIDOC
## with_method(method)

### Description
Adds a method to the service to be built.

### Parameters
- **method** (_Method_) – The method to be added.

### Returns
ServiceBuilder - The ServiceBuilder instance for chaining.

### Return type
_ServiceBuilder_
```

--------------------------------

### serialize() Method

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

The `serialize()` method is used to serialize data according to the defined types.

```APIDOC
## serialize()

### Description

This method is used to serialize data according to the defined types.

### Method Signature

`serialize()`

### Usage

This method is called on a serialization object to perform the serialization process.
```

--------------------------------

### ServerServiceInstance Properties

Source: https://someipy.readthedocs.io/en/latest/api/server_service_instance.html

Provides access to properties of the ServerServiceInstance.

```APIDOC
## ServerServiceInstance Properties

### endpoint_ip

*   **Description**: IP address of the endpoint this instance offers services on.
*   **Returns**: str - Endpoint IP address.

### endpoint_port

*   **Description**: Port of the endpoint this instance offers services on.
*   **Returns**: int - Endpoint port number.

### instance_id

*   **Description**: Instance ID of this server service instance.
*   **Returns**: int - The unique identifier for this service instance.

### service

*   **Description**: Service associated with this server service instance.
*   **Returns**: Service - The service configuration that this instance exposes.
```

--------------------------------

### Sint64

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a signed 64-bit integer for SOME/IP serialization. Supports serialization and deserialization.

```APIDOC
## Sint64

### Description
Represents a signed 64-bit integer on the wire for SOME/IP.

### Methods
- `deserialize(payload: bytes)`: Deserializes a byte payload into a Sint64 object.
- `serialize()`: Serializes the Sint64 object into bytes.

### Parameters
- `value` (int): The integer value to be stored.
```

--------------------------------

### Serializing a Structured Datatype Instance

Source: https://someipy.readthedocs.io/en/latest/service_interface.html

Serialize an instance of a custom `SomeIpPayload` subclass into bytes for transmission. Ensure values are assigned using the typed constructors before serialization.

```python
# Create a new instance of TemperatureMsg and fill some dummy values
tmp_msg = TemperatureMsg()
tmp_msg.timestamp = Uint64(10)
tmp_msg.temperature = Float32(20.0)

payload = tmp_msg.serialize()
service_instance_temperature.send_event(
                SAMPLE_EVENTGROUP_ID,
                SAMPLE_EVENT_ID,
                payload
            )
```

--------------------------------

### SomeIpDynamicSizeArray

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a dynamically sized array for SOME/IP serialization. Supports equality comparison, length retrieval, serialization, and deserialization.

```APIDOC
## SomeIpDynamicSizeArray

### Description
A datatype for a SOME/IP dynamically sized array.

### Methods
- `__eq__(other)`: Compares two SomeIpDynamicSizeArray objects for equality.
- `__len__()`: Returns the length of the object in bytes.
- `deserialize(payload: bytes)`: Deserializes a byte payload into the object.
- `serialize()`: Serializes the object into bytes.

### Properties
- `data` (List[T]): The list of elements in the array.
- `length_field_length`: The length of the field used to store the array's length.
```

--------------------------------

### Service Class

Source: https://someipy.readthedocs.io/en/latest/api/service.html

Represents a SOME/IP service with an ID, major and minor versions, and associated methods and event groups.

```APIDOC
## Class: Service

### Description
Represents a SOME/IP service. A service has an id, major and minor version and 0 or more methods and/or eventgroups.

### Attributes
- **id** (int): Service identifier.
- **major_version** (int): Major version of the service.
- **minor_version** (int): Minor version of the service.
- **methods** (Dict[int, Method]): Mapping of method IDs to Method instances.
- **eventgroups** (Dict[int, EventGroup]): Mapping of event group IDs to EventGroup instances.

### Properties
- **eventgroupids** (List[int]): Returns a list of event group IDs associated with the service.
- **events** (List[Event]): Returns a list of events associated with the service.
- **id** (int): Service identifier.
- **major_version** (int): Major version of the service.
- **methodids** (List[int]): Returns a list of method IDs associated with the object.
- **methods** (Dict[int, Method]): Mapping of method IDs to Method instances.
- **minor_version** (int): Minor version of the service.
```

--------------------------------

### Define Temperature Message Structure

Source: https://someipy.readthedocs.io/en/latest/getting_started.html

Define the temperature data structure using Python dataclasses. No IDL files are required. This structure includes version, timestamp, and measurements.

```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)


```

--------------------------------

### SomeIpFixedSizeString.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serializes the SomeIpFixedSizeString object into a byte representation. It iterates over attributes, serializes each, and appends the result.

```APIDOC
## SomeIpFixedSizeString.serialize

### Description
Serialize the object into bytes by iterating over its attributes, excluding those starting with double underscores or underscores. For each attribute, it calls the serialize method of the attribute and appends the returned bytes to the output.

### Returns
- bytes - The serialized representation of the object as bytes.

### Method Signature
serialize()

```

--------------------------------

### Nesting Structured SOME/IP Datatypes

Source: https://someipy.readthedocs.io/en/latest/service_interface.html

Nest custom `SomeIpPayload` types within other `SomeIpPayload` classes to create complex data structures. Ensure nested types are correctly initialized and their fields are accessible.

```python
@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
    temperature: Float32

    def __init__(self):
        self.version = Version()
        self.version.major.value = 1
        self.version.minor.value = 0
        self.timestamp = Uint64()
        self.temperature = Float32()
```

--------------------------------

### Uint32.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serialize the value of the object into bytes using the big-endian byte order.

```APIDOC
## Uint32.serialize()

### Description
Serialize the value of the object into bytes using the big-endian byte order.

### Returns
- **bytes** - The serialized value of the object.
```

--------------------------------

### Uint64.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serialize the value of the object into bytes using the big-endian byte order.

```APIDOC
## Uint64.serialize()

### Description
Serialize the value of the object into bytes using the big-endian byte order.

### Returns
- **bytes** - The serialized value of the object.
```

--------------------------------

### Uint16.__len__

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Return the length of the object.

```APIDOC
## Uint16.__len__()

### Description
Return the length of the object.

### Returns
- **int** - The length of the object, which is always 2.
```

--------------------------------

### Sint32

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a signed 32-bit integer for SOME/IP serialization. Supports serialization and deserialization.

```APIDOC
## Sint32

### Description
Represents a signed 32-bit integer on the wire for SOME/IP.

### Methods
- `deserialize(payload: bytes)`: Deserializes a byte payload into a Sint32 object.
- `serialize()`: Serializes the Sint32 object into bytes.

### Parameters
- `value` (int): The integer value to be stored.
```

--------------------------------

### Uint32.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserialize the payload into the value of the object.

```APIDOC
## Uint32.deserialize(payload)

### Description
Deserialize the payload into the value of the object.

### Parameters
#### Path Parameters
- **payload** (bytes) - The payload to be deserialized.

### Returns
- **self** - The deserialized object.
```

--------------------------------

### Uint64.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserialize the payload into the value of the object.

```APIDOC
## Uint64.deserialize(payload)

### Description
Deserialize the payload into the value of the object.

### Parameters
#### Path Parameters
- **payload** (bytes) - The payload to be deserialized.

### Returns
- **self** - The deserialized object.
```

--------------------------------

### Float64

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a 64-bit floating-point type. Supports deserialization from 8-byte payloads and serialization to bytes.

```APIDOC
## Float64

### Description
Represents a 64-bit floating-point type. It can be deserialized from an 8-byte payload in big-endian byte order and serialized into bytes.

### Class
`_someipy.serialization.Float64(_value =0.0_)`

### Methods
#### `__eq__(_other_)`
Compares two objects for equality based on their serialized representation.

- **other** (Any) - The object to compare with.

Returns:
    Bool

#### `__len__()`
Returns the length of the object, which is always 8.

#### `deserialize(_payload_)`
Deserializes an 8-byte payload (big-endian) into the float value of the object.

- **payload** (bytes) - The payload to be deserialized.

Returns:
    self

#### `serialize()`
Serializes the float value of the object into bytes using big-endian byte order.

Returns:
    bytes
```

--------------------------------

### ServiceBuilder with_minor_version(minor_version)

Source: https://someipy.readthedocs.io/en/latest/api/service_builder.html

Sets the minor version for the service being built.

```APIDOC
## with_minor_version(minor_version)

### Description
Sets the minor version for the service to be built.

### Parameters
- **minor_version** (_int_) – The minor version of the service.

### Returns
ServiceBuilder - The ServiceBuilder instance for chaining.

### Return type
_ServiceBuilder_
```

--------------------------------

### Event.from_json

Source: https://someipy.readthedocs.io/en/latest/api/event.html

Creates an Event object from a JSON string.

```APIDOC
## Class Method: Event.from_json

### Description
Create an Event from a JSON string.

### Parameters
* **json_str** (str) - JSON representation of an Event.

### Returns
* **Event** - An Event object created from the JSON string.
```

--------------------------------

### Serialization Types

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

The following data types are supported for serialization:

```APIDOC
## Serialization Types

### Description

The following data types are supported for serialization:

### Supported Types
- `Bool`
- `Float32`
- `Float64`
- `Sint16`
- `Sint32`
- `Sint64`
- `Sint8`
- `SomeIpDynamicSizeArray`
- `SomeIpDynamicSizeString`
- `SomeIpFixedSizeArray`
- `SomeIpFixedSizeString`
- `SomeIpPayload`
- `Uint16`
- `Uint32`
- `Uint64`
- `Uint8`
```

--------------------------------

### Event Class

Source: https://someipy.readthedocs.io/en/latest/api/event.html

Represents a SOME/IP event with an event id and a transport layer protocol.

```APIDOC
## Class: Event

### Description
Class representing a SOME/IP event with an event id and a transport layer protocol.

### Parameters
* **id** (int) - The event ID.
* **protocol** (TransportLayerProtocol) - The transport layer protocol used for the event.
```

--------------------------------

### SomeIpFixedSizeArray.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serializes the SomeIpFixedSizeArray object into a byte representation. It iterates over attributes, serializes each, and appends the result.

```APIDOC
## SomeIpFixedSizeArray.serialize

### Description
Serialize the object into bytes by iterating over its attributes, excluding those starting with double underscores or underscores. For each attribute, it calls the serialize method of the attribute and appends the returned bytes to the output.

### Returns
- bytes - The serialized representation of the object as bytes.

### Method Signature
serialize()

```

--------------------------------

### Uint8.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserialize the payload into the value of the object.

```APIDOC
## Uint8.deserialize(payload)

### Description
Deserialize the payload into the value of the object.

### Parameters
#### Path Parameters
- **payload** (bytes) - The payload to be deserialized.

### Returns
- **None**
```

--------------------------------

### Register Event Notification Callback

Source: https://someipy.readthedocs.io/en/latest/subscribing_events.html

Register a callback function to handle incoming event notifications. The callback receives the event ID and payload bytes, and should include error handling for deserialization.

```python
def temperature_callback(event_id: int, event_payload: bytes) -> None:
    try:
        print(f"Received {len(event_payload)} bytes for event 0x{event_id:04x}")
        temperature_msg = TemperatureMsg().deserialize(event_payload)
        print(temperature_msg)
    except Exception as e:
        print(f"Error in deserialization: {e}")

service_instance_temperature.register_callback(temperature_callback)

```

--------------------------------

### Uint8.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serialize the value of the object into bytes using the big-endian byte order.

```APIDOC
## Uint8.serialize()

### Description
Serialize the value of the object into bytes using the big-endian byte order.

### Returns
- **bytes** - The serialized value of the object.
```

--------------------------------

### get_someipy_log_level

Source: https://someipy.readthedocs.io/en/latest/api/someipy_logging.html

Retrieves the current log level configured for the someipy library.

```APIDOC
## get_someipy_log_level()

### Description
Get the current log level for the someipy library.

### Returns
- int: The current log level.
```

--------------------------------

### Uint16.serialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Serialize the value of the object into bytes using the big-endian byte order.

```APIDOC
## Uint16.serialize()

### Description
Serialize the value of the object into bytes using the big-endian byte order.

### Returns
- **bytes** - The serialized value of the object.
```

--------------------------------

### ServiceBuilder with_eventgroup(eventgroup)

Source: https://someipy.readthedocs.io/en/latest/api/service_builder.html

Adds an event group to the service being built.

```APIDOC
## with_eventgroup(eventgroup)

### Description
Adds an event group to the service to be built.

### Parameters
- **eventgroup** (_EventGroup_) – The event group to be added.

### Returns
ServiceBuilder - The ServiceBuilder instance for chaining.

### Return type
_ServiceBuilder_
```

--------------------------------

### ServiceBuilder with_major_version(major_version)

Source: https://someipy.readthedocs.io/en/latest/api/service_builder.html

Sets the major version for the service being built.

```APIDOC
## with_major_version(major_version)

### Description
Sets the major version for the service to be built.

### Parameters
- **major_version** (_int_) – The major version of the service.

### Returns
ServiceBuilder - The ServiceBuilder instance for chaining.

### Return type
_ServiceBuilder_
```

--------------------------------

### Uint16.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserialize the payload into the value of the object.

```APIDOC
## Uint16.deserialize(payload)

### Description
Deserialize the payload into the value of the object.

### Parameters
#### Path Parameters
- **payload** (bytes) - The payload to be deserialized.

### Returns
- **self** - The deserialized object.
```

--------------------------------

### Float32

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a 32-bit floating-point type. Supports deserialization from 4-byte payloads and serialization to bytes.

```APIDOC
## Float32

### Description
Represents a 32-bit floating-point type. It can be deserialized from a 4-byte payload in big-endian byte order and serialized into bytes.

### Class
`_someipy.serialization.Float32(_value =0.0_)`

### Methods
#### `__eq__(_other_)`
Compares two objects for equality based on their serialized representation.

- **other** (Any) - The object to compare with.

Returns:
    Bool

#### `__len__()`
Returns the length of the object, which is always 4.

#### `deserialize(_payload_)`
Deserializes a 4-byte payload (big-endian) into the float value of the object.

- **payload** (bytes) - The payload to be deserialized.

Returns:
    self

#### `serialize()`
Serializes the float value of the object into bytes using big-endian byte order.

Returns:
    bytes
```

--------------------------------

### SomeIpFixedSizeString.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserializes a byte payload into a SomeIpFixedSizeString object. It automatically detects the encoding from the BOM.

```APIDOC
## SomeIpFixedSizeString.deserialize

### Description
Deserialize the payload into the object.

### Parameters
#### Payload
- **payload** (bytes) - The payload to be deserialized.

### Returns
- self - The deserialized object.

### Method Signature
deserialize(_payload_)

### Detailed Description
This method deserializes the payload into the string. It automatically detects the encoding from the BOM at the beginning of the payload.
```

--------------------------------

### SomeIpFixedSizeArray.deserialize

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Deserializes a byte payload into a SomeIpFixedSizeArray object. It iterates through the elements, deserializing each from the appropriate slice of the payload.

```APIDOC
## SomeIpFixedSizeArray.deserialize

### Description
Deserialize the payload into the object.

### Parameters
#### Payload
- **payload** (bytes) - The payload to be deserialized.

### Returns
- self - The deserialized object.

### Method Signature
deserialize(_payload_)

### Detailed Description
This method deserializes the payload into the object. It iterates over the data list and for each element, it calls the deserialize method of that element, passing a slice of the payload corresponding to the element’s length. The deserialized values are assigned back to the corresponding elements of the data list. If the data list is empty, the method returns immediately. Finally, the deserialized object is returned.
```

--------------------------------

### TransportLayerProtocol Class

Source: https://someipy.readthedocs.io/en/latest/api/transport_layer_protocol.html

The TransportLayerProtocol class defines constants for network transport protocols.

```APIDOC
## Class: TransportLayerProtocol

### Description
Represents the transport layer protocol used for communication. It defines constants for common protocols.

### Constants
- **TCP** (int): Represents the Transmission Control Protocol, with a value of 6.
- **UDP** (int): Represents the User Datagram Protocol, with a value of 17.
```

--------------------------------

### Bool

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a boolean type serialized as a single byte. Supports deserialization from bytes and serialization to bytes.

```APIDOC
## Bool

### Description
Represents a boolean type that is transported as a single byte on the wire. It can be deserialized from a byte payload and serialized back into bytes.

### Class
`_someipy.serialization.Bool(_value =False_)`

### Methods
#### `__len__()`
Returns the length of the object, which is always 1.

#### `deserialize(_payload_)`
Deserializes a single byte payload into the boolean value of the object. Expects 0 for False and 1 for True.

- **payload** (bytes) - The payload to be deserialized.

Returns:
    self

#### `serialize()`
Serializes the boolean value of the object into bytes using big-endian byte order.

Returns:
    bytes
```

--------------------------------

### send_event

Source: https://someipy.readthedocs.io/en/latest/api/server_service_instance.html

Sends an event to clients subscribed to the event. This method validates the specified event group and event within the service definition, encodes the payload in Base64, constructs a UDS message and dispatches it through the daemon.

```APIDOC
## send_event

### Description
Send an event to clients subscribed to the event. This method validates the specified event group and event within the service definition, encodes the payload in Base64, constructs a UDS message and dispatches it through the daemon.

### Parameters

*   **eventgroup_id** (int) - ID of the event group the event belongs to.
*   **event_id** (int) - ID of the event to send.
*   **payload** (bytes) - Payload of the event to transmit to clients.

### Returns
None

### Raises
ValueError - If event group ID or event ID is not found within the service.
```

--------------------------------

### Sint8

Source: https://someipy.readthedocs.io/en/latest/api/serialization.html

Represents a signed 8-bit integer for SOME/IP serialization. Supports serialization, deserialization, and length retrieval.

```APIDOC
## Sint8

### Description
Represents a signed 8-bit integer on the wire for SOME/IP.

### Methods
- `__len__()`: Returns the length of the object in bytes.
- `deserialize(payload: bytes)`: Deserializes a byte payload into a Sint8 object.
- `serialize()`: Serializes the Sint8 object into bytes.

### Parameters
- `value` (int): The integer value to be stored.
```

--------------------------------

### Updating Datatype Field Values

Source: https://someipy.readthedocs.io/en/latest/service_interface.html

Update values of fields within a `SomeIpPayload` instance. Use the typed constructors for initial assignment and direct assignment to the `.value` attribute for subsequent modifications.

```python
tmp_msg = TemperatureMsg()
tmp_msg.timestamp = Uint64(10)
tmp_msg.temperature = Float32(20.0)
payload = tmp_msg.serialize()
```

```python
tmp_msg.timestamp.value = 10
```

--------------------------------

### Disconnect from Daemon

Source: https://someipy.readthedocs.io/en/latest/whatsnew.html

Gracefully disconnects from the someipyd daemon. This should be called when service interaction is complete.

```python
await someipy_daemon.disconnect_from_daemon()

```
Tokens:
Raw