klv-data

https://paretech.github.io/klvdata
Admin
klv-data is a Python library for parsing and handling KLV (Key-Length-Value) structured data...
Tokens:7,545
Snippets:114
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### klvdata.common Module Functions

Source: https://paretech.github.io/klvdata/klvdata.html

Utility functions for BER encoding/decoding, byte/datetime/float/string conversions, and checksum calculation.

```APIDOC
## klvdata.common Module Functions

### Description
Provides utility functions for common data manipulation tasks related to KLV data.

### Functions
- **ber_decode(value)**: Decodes BER length from bytes to an integer.
- **ber_encode(value)**: Encodes an integer length into BER format bytes.
- **bytes_to_datetime(value)**: Converts microsecond bytes to a datetime object.
- **bytes_to_float(value, domain, range)**: Converts fixed-point bytes to a floating-point value within a specified domain and range.
- **bytes_to_hexstr(value, start='', sep=' ')**: Converts bytes to a hexadecimal string representation.
- **bytes_to_int(value, signed=False)**: Converts bytes to an integer.
- **bytes_to_str(value)**: Converts bytes to a UTF-8 formatted string.
- **datetime_to_bytes(value)**: Converts a datetime object to bytes representing UTC time in microseconds.
- **float_to_bytes(value, domain, range)**: Converts a floating-point value to fixed-point bytes within a specified domain and range.
- **hexstr_to_bytes(value)**: Converts a hexadecimal string to a bytes object, removing formatting.
- **int_to_bytes(value, length=1, signed=False)**: Converts an integer to bytes.
- **linear_map(src_value, src_domain, dst_range)**: Maps a source value from its domain to a destination range using linear interpolation.
- **packet_checksum(data)**: Calculates a two-byte checksum for SMPTE ST 336 KLV structured bytes.
- **str_to_bytes(value)**: Converts a UTF-8 formatted string to a bytes object.
```

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

### AlternatePlatformHeading

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Heading element. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## AlternatePlatformHeading

### Description
Represents the Alternate Platform Heading element, indicating the heading of an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformHeading(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Heading'
- **TAG**: 71
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'G'
- **units**: 'degrees'
```

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

### AlternatePlatformName

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Name element. It inherits from StringElementParser and specifies TAG, LDSName, min_length, and max_length.

```APIDOC
## AlternatePlatformName

### Description
Represents the Alternate Platform Name element, a string field for the name of an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformName(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Name'
- **TAG**: 70
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'F'
- **min_length**: 0
- **max_length**: 127
```

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

### klvdata.element Module Classes

Source: https://paretech.github.io/klvdata/klvdata.html

Classes for representing KLV elements, including base Element and UnknownElement.

```APIDOC
## klvdata.element Module Classes

### Description
Defines classes for constructing and managing Key-Length-Value (KLV) elements according to SMPTE ST 336 standards.

### Classes
- **Element(key, value)**:
  - **Description**: Constructs a key, length, value tuple. The length is dynamically calculated based on the value.
  - **Attributes**: `key`, `value`
  - **Properties**: 
    - `name`: Returns the name if set, otherwise the class name.
    - `length`: Returns the BER encoded byte length of `self.value`.

- **UnknownElement(key, value)**:
  - **Description**: A subclass of `Element` representing an unknown element type.
```

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

### SetParser Class

Source: https://paretech.github.io/klvdata/klvdata.html

The SetParser class is a base class for parsing KLV data elements. It is not intended for direct use but as a superclass for specific KLV set parsers.

```APIDOC
## klvdata.setparser.SetParser

### Description
Parsable Element. Not intended to be used directly. Always as super class.

### Methods
- `__init__(self, value, key_length=1)`: Initializes the SetParser.
- `MetadataList(self)`: Returns the metadata dictionary.
- `parse(self)`: Parses the parent into items. Called on init and modification of parent value. If a known parser is not available for key, parse as generic KLV element.
- `structure(self)`: Returns the structure of the parsed element.

### Class Methods
- `@classmethod add_parser(obj)`: Decorator method used to register a parser to the class parsing repertoire. obj is required to implement key attribute supporting bytes as returned by KLVParser key.

### Abstract Properties
- `parsers`: classmethod(function) -> method
```

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

### AlternatePlatformAltitude

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Altitude element. It inherits from MappedElementParser and specifies TAG, LDSName, and units.

```APIDOC
## AlternatePlatformAltitude

### Description
Represents the Alternate Platform Altitude element, providing altitude information for an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformAltitude(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Altitude'
- **TAG**: 69
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'E'
- **units**: 'meters'
```

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

### str_dict Function

Source: https://paretech.github.io/klvdata/klvdata.html

A utility function for converting values to a dictionary string representation.

```APIDOC
## klvdata.setparser.str_dict

### Description
Converts a given set of values into a dictionary string representation.

### Parameters
- `values`: The input values to be converted.
```

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

### Checksum

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Checksum element. It inherits from BytesElementParser and is used for error detection within a UAV Local Set packet.

```APIDOC
## Checksum

### Description
Checksum used to detect errors within a UAV Local Set packet. The checksum is formed as the lower 16-bits of a summation performed on the entire LS packet, including the 16-byte US key and the 1-byte checksum length.

### Class Definition
`klvdata.misb0601.Checksum(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Checksum'
- **TAG**: 1
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'\x01'
```

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

### AlternatePlatformEllipsoidHeight

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Ellipsoid Height element. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## AlternatePlatformEllipsoidHeight

### Description
Represents the Alternate Platform Ellipsoid Height element, specifying the ellipsoid height for an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformEllipsoidHeight(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Ellipsoid Height'
- **TAG**: 76
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'L'
- **units**: 'meters'
```

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

### AlternatePlatformEllipsoidHeightExtended

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Ellipsoid Height Extended element. It inherits from MappedElementParser and contains TAG, LDSName, and units.

```APIDOC
## AlternatePlatformEllipsoidHeightExtended

### Description
Represents the Alternate Platform Ellipsoid Height Extended element, providing extended ellipsoid height information for an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformEllipsoidHeightExtended(value)`

### Properties
- **ESDName**: ''
- **LDSName**: ' Alternate Platform Ellipsoid Height Extended'
- **TAG**: 105
- **UDSKey**: '06 0E 2B 34 01 01 01 01 0E 01 02 01 82 48 00 00'
- **UDSName**: ''
- **key**: b'i'
- **units**: 'meters'
```

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

### AlternatePlatformLatitude

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Latitude element. It inherits from MappedElementParser and specifies TAG, LDSName, and units.

```APIDOC
## AlternatePlatformLatitude

### Description
Represents the Alternate Platform Latitude element, providing latitude information for an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformLatitude(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Latitude'
- **TAG**: 67
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'C'
- **units**: 'degrees'
```

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

### StreamParser Class

Source: https://paretech.github.io/klvdata/klvdata.html

The StreamParser class is used for parsing KLV data streams. It allows for registering custom parsers for different KLV types.

```APIDOC
## klvdata.streamparser.StreamParser

### Description
Parses KLV data streams.

### Class Methods
- `@classmethod add_parser(obj)`: Decorator method used to register a parser to the class parsing repertoire. obj is required to implement key attribute supporting bytes as returned by KLVParser key.

### Class Attributes
- `parsers`: Dictionary mapping KLV keys to their corresponding parser classes. Example: `{b'\x06\x0e+4\x02\x0b\x01\x01\x0e\x01\x03\x01\x01\x00\x00\x00': <class 'klvdata.misb0601.UASLocalMetadataSet'>}`
```

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

### AlternatePlatformLongitude

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Alternate Platform Longitude element. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## AlternatePlatformLongitude

### Description
Represents the Alternate Platform Longitude element, providing longitude information for an alternate platform.

### Class Definition
`klvdata.misb0601.AlternatePlatformLongitude(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Alternate Platform Longitude'
- **TAG**: 68
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'D'
- **units**: 'degrees'
```

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

### AirfieldBarometricPressure

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Airfield Barometric Pressure element. It inherits from MappedElementParser and has properties like TAG, LDSName, and units.

```APIDOC
## AirfieldBarometricPressure

### Description
Represents the Airfield Barometric Pressure element, used for barometric pressure readings at an airfield.

### Class Definition
`klvdata.misb0601.AirfieldBarometricPressure(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Airfield Barometric Pressure'
- **TAG**: 53
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'5'
- **units**: 'millibar'
```

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

### AirfieldElevation

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Airfield Elevation element. It inherits from MappedElementParser and includes details such as TAG, LDSName, and units.

```APIDOC
## AirfieldElevation

### Description
Represents the Airfield Elevation element, indicating the elevation of an airfield.

### Class Definition
`klvdata.misb0601.AirfieldElevation(value)`

### Properties
- **ESDName**: ''
- **LDSName**: 'Airfield Elevation'
- **TAG**: 54
- **UDSKey**: '-'
- **UDSName**: ''
- **key**: b'6'
- **units**: 'meters'
```

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

### CornerLatitudePoint2Full

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Corner Latitude Point 2 (Full) element for SAR data. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## CornerLatitudePoint2Full

### Description
Represents the Corner Latitude Point 2 (Full) element, used in SAR data to define a corner point's latitude.

### Class Definition
`klvdata.misb0601.CornerLatitudePoint2Full(value)`

### Properties
- **ESDName**: 'SAR Latitude 1'
- **LDSName**: 'Corner Latitude Point 2 (Full)'
- **TAG**: 84
- **UDSKey**: '06 0E 2B 34 01 01 01 03 07 01 02 01 03 08 01 00'
- **UDSName**: 'Corner Latitude Point 2 (Decimal Degrees)'
- **key**: b'T'
- **units**: 'degrees'
```

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

### CornerLatitudePoint3Full

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Corner Latitude Point 3 (Full) element for SAR data. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## CornerLatitudePoint3Full

### Description
Represents the Corner Latitude Point 3 (Full) element, used in SAR data to define a corner point's latitude.

### Class Definition
`klvdata.misb0601.CornerLatitudePoint3Full(value)`

### Properties
- **ESDName**: 'SAR Latitude 2'
- **LDSName**: 'Corner Latitude Point 3 (Full)'
- **TAG**: 86
- **UDSKey**: '06 0E 2B 34 01 01 01 03 07 01 02 01 03 09 01 00'
- **UDSName**: 'Corner Latitude Point 3 (Decimal Degrees)'
- **key**: b'V'
- **units**: 'degrees'
```

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

### CornerLatitudePoint4Full

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Corner Latitude Point 4 (Full) element for SAR data. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## CornerLatitudePoint4Full

### Description
Represents the Corner Latitude Point 4 (Full) element, used in SAR data to define a corner point's latitude.

### Class Definition
`klvdata.misb0601.CornerLatitudePoint4Full(value)`

### Properties
- **ESDName**: 'SAR Latitude 3'
- **LDSName**: 'Corner Latitude Point 4 (Full)'
- **TAG**: 88
```

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

### CornerLatitudePoint1Full

Source: https://paretech.github.io/klvdata/klvdata.html

Represents the Corner Latitude Point 1 (Full) element for SAR data. It inherits from MappedElementParser and includes TAG, LDSName, and units.

```APIDOC
## CornerLatitudePoint1Full

### Description
Represents the Corner Latitude Point 1 (Full) element, used in SAR data to define a corner point's latitude.

### Class Definition
`klvdata.misb0601.CornerLatitudePoint1Full(value)`

### Properties
- **ESDName**: 'SAR Latitude 4'
- **LDSName**: 'Corner Latitude Point 1 (Full)'
- **TAG**: 82
- **UDSKey**: '06 0E 2B 34 01 01 01 03 07 01 02 01 03 07 01 00'
- **UDSName**: 'Corner Latitude Point 1 (Decimal Degrees)'
- **key**: b'R'
- **units**: 'degrees'
```
Tokens:
Raw