Skip to content

Handle non-OK ConfigResponseMessages gracefully in Python. #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamshapiro0 merged 3 commits into from
Apr 17, 2025
Merged

Handle non-OK ConfigResponseMessages gracefully in Python. #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae90104
Handle bad ConfigResponse messages gracefully in Python.
adamshapiro0 Apr 15, 2025
c266998
Check for non-OK config responses before trying to decode the parameter.
adamshapiro0 Apr 17, 2025
cb927a2
Pass InterfaceID to operator<< by reference.
adamshapiro0 Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions python/fusion_engine_client/messages/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
from construct import (Struct, Padding, this, Flag, Bytes, Array,
Float32l, Float64l, Int64ul, Int32ul, Int16ul, Int8ul, Int64sl, Int32sl, Int16sl, Int8sl, PaddedString)

from ..utils import trace as logging
from ..utils.construct_utils import NamedTupleAdapter, AutoEnum, construct_message_to_string
from ..utils.enum_utils import IntEnum
from .defs import *

_logger = logging.getLogger('point_one.fusion_engine.messages.configuration')

################################################################################
# Device Configuration Support
Expand Down Expand Up @@ -1390,17 +1392,35 @@ def unpack(self, buffer: bytes, offset: int = 0, message_version: int = MessageP
header_data = config_data[:_InterfaceConfigSubmessageConstruct.sizeof()]
config_data = config_data[_InterfaceConfigSubmessageConstruct.sizeof():]
interface_header = _InterfaceConfigSubmessageConstruct.parse(header_data)
subtype = interface_header.subtype
interface_config_subtype = interface_header.subtype
self.interface = interface_header.interface
construct_obj = _conf_gen.INTERFACE_CONFIG_MAP[subtype]
construct_obj = _conf_gen.INTERFACE_CONFIG_MAP.get(interface_config_subtype, None)
if construct_obj is None:
_logger.warning(f'Unsupported interface config subtype. [interface={repr(self.interface)}, '
f'subtype={interface_config_subtype}]')
else:
self.interface = None
construct_obj = _conf_gen.CONFIG_MAP[parsed.config_type]
interface_config_subtype = None
construct_obj = _conf_gen.CONFIG_MAP.get(parsed.config_type, None)
if construct_obj is None:
_logger.warning(f'Unsupported interface config type. [type={parsed.config_type}]')

if parsed.config_length_bytes > 0:
self.config_object = construct_obj.parse(config_data)
else:
if construct_obj is None:
self.config_object = None
elif len(config_data) < construct_obj.sizeof():
if self.response != Response.OK and len(config_data) == 0:
# For a non-OK response, they device may omit the parameter altogether. This is normal.
pass
elif self.interface is None:
_logger.error(f'Config response payload too small for expected contents. [type={parsed.config_type}, '
f'size={len(config_data)} B (expected={construct_obj.sizeof()} B)]')
else:
_logger.error(f'Config response payload too small for expected contents. '
f'[interface={repr(self.interface)}, subtype={interface_config_subtype}, '
f'size={len(config_data)} B (expected={construct_obj.sizeof()} B)]')
self.config_object = None
else:
self.config_object = construct_obj.parse(config_data)

return parsed._io.tell()

Expand Down
6 changes: 5 additions & 1 deletion src/point_one/fusion_engine/messages/configuration.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,10 @@ struct P1_ALIGNAS(4) SaveConfigMessage : public MessagePayload {
* {MessageHeader, ConfigResponseMessage, uint32_t}
* ```
*
* The @ref response field will indicate the status of the requested value. If
* the response is not @ref Response::OK, the parameter value may be omitted and
* @ref config_length_bytes will be set to 0.
*
* In response to a @ref GetConfigMessage with an invalid or unsupported @ref
* ConfigType, @ref config_type in the resulting @ref ConfigResponseMessage will
* be set to @ref ConfigType::INVALID, and @ref response will indicate the
Expand Down Expand Up @@ -1988,7 +1992,7 @@ struct P1_ALIGNAS(4) InterfaceID {
* @brief @ref InterfaceID stream operator.
* @ingroup io_interfaces
*/
inline p1_ostream& operator<<(p1_ostream& stream, InterfaceID val) {
inline p1_ostream& operator<<(p1_ostream& stream, const InterfaceID& val) {
stream << "[type=" << val.type << ", index=" << (int)val.index << "]";
return stream;
}
Expand Down
Loading