Cygnus Reach Project Documentation¶
Overview¶
This documentation covers the Cygnus Reach Embedded Stack, including a programmer’s guide, a porting guide and an API reference. You can find more documentation about other parts of Reach at Cygnus Reach Portal.
- Getting Started
- Programmer’s Guide
- Porting Guide
- API Reference
- File: crcb_weak.h
crcb_get_coded_prompt()crcb_send_coded_response()crcb_device_get_info()crcb_challenge_key_is_valid()crcb_invalidate_challenge_key()crcb_access_granted()crcb_configure_access_control()crcb_ping_get_signal_strength()crcb_parameter_get_count()crcb_parameter_discover_reset()crcb_parameter_discover_next()crcb_parameter_ex_get_count()crcb_parameter_ex_discover_reset()crcb_parameter_ex_discover_next()crcb_parameter_read()crcb_parameter_write()crcb_compute_parameter_hash()crcb_parameter_notification_init()crcb_get_command_count()crcb_command_discover_reset()crcb_command_discover_next()crcb_command_execute()crcb_file_get_file_count()crcb_file_discover_reset()crcb_file_discover_next()crcb_file_get_description()crcb_file_get_preferred_ack_rate()crcb_read_file()crcb_write_file()crcb_erase_file()crcb_file_transfer_complete()crcb_file_prepare_to_write()crcb_time_get()crcb_time_set()
- File: cr_stack.h
cr_init()cr_set_advertised_name()cr_get_advertised_name()cr_process()cr_store_coded_prompt()cr_get_coded_response_buffer()cr_report_error()cr_notify_stream()cr_set_comm_link_connected()cr_get_comm_link_connected()cr_clear_param_notifications()cr_init_param_notifications()cr_get_notification_statistics()cr_get_current_ticks()cr_test_sizes()cr_get_reach_version()cr_get_proto_version()reach_sizes_treach_sizes_t::max_message_sizereach_sizes_t::big_data_buffer_sizereach_sizes_t::parameter_buffer_countreach_sizes_t::num_params_in_responsereach_sizes_t::description_lenreach_sizes_t::max_param_bytesreach_sizes_t::param_info_description_lenreach_sizes_t::medium_string_lenreach_sizes_t::short_string_lenreach_sizes_t::param_notify_config_countreach_sizes_t::num_descriptors_in_responsereach_sizes_t::num_param_notificationsreach_sizes_t::num_commands_in_responsereach_sizes_t::num_param_desc_in_response
- File: i3_log.h
- File: reach.pb.h
cr_ReachProto_MAJOR_Versioncr_ReachProto_MINOR_Versioncr_ReachProto_PATCH_Versioncr_ReachMessageTypescr_ServiceIdscr_EndpointIdscr_ParameterDataTypecr_AccessLevelcr_StorageLocationcr_WiFiSecuritycr_WiFiBandcr_ErrorCodescr_FileTransferStatecr_SizesOffsetscr_ReachMessageHeadercr_ReachMessagecr_AhsokaMessageHeadercr_ErrorReportcr_PingRequestcr_PingResponsecr_DeviceInfoRequestcr_DeviceInfoResponsecr_ParameterInfoRequestcr_Uint32ParameterInfocr_Int32ParameterInfocr_Float32ParameterInfocr_Uint64ParameterInfocr_Int64ParameterInfocr_Float64ParameterInfocr_BoolParameterInfocr_StringParameterInfocr_EnumParameterInfocr_BitfieldParameterInfocr_ByteArrayParameterInfocr_ParameterInfocr_ParameterInfoResponsecr_ParamExKeycr_ParamExInfoResponsecr_ParameterReadcr_ParameterWriteResponsecr_ParameterNotifyConfigcr_ParameterEnableNotificationscr_ParameterDisableNotificationscr_ParameterNotifyConfigResponsecr_DiscoverParameterNotificationscr_DiscoverParameterNotificationsResponsecr_ParameterValuecr_ParameterReadResponsecr_ParameterWritecr_ParameterNotificationcr_DiscoverFilescr_FileInfocr_DiscoverFilesResponsecr_FileTransferRequestcr_FileTransferResponsecr_FileTransferDatacr_FileTransferDataNotificationcr_FileEraseRequestcr_FileEraseResponsecr_DiscoverStreamscr_StreamInfocr_DiscoverStreamsResponsecr_StreamOpencr_StreamResponsecr_StreamClosecr_StreamDatacr_DiscoverCommandscr_CommandInfocr_DiscoverCommandsResponsecr_SendCommandcr_SendCommandResponsecr_CLIDatacr_TimeSetRequestcr_TimeSetResponsecr_TimeGetRequestcr_TimeGetResponsecr_ConnectionDescriptioncr_DiscoverWiFicr_DiscoverWiFiResponsecr_WiFiConnectionRequestcr_WiFiConnectionResponsecr_BufferSizes_cr_ReachProto_MAJOR_Version_cr_ReachProto_MINOR_Version_cr_ReachProto_PATCH_Version_cr_ReachMessageTypes_cr_ReachMessageTypes::cr_ReachMessageTypes_INVALID_cr_ReachMessageTypes::cr_ReachMessageTypes_ERROR_REPORT_cr_ReachMessageTypes::cr_ReachMessageTypes_PING_cr_ReachMessageTypes::cr_ReachMessageTypes_GET_DEVICE_INFO_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_PARAMETERS_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_PARAM_EX_cr_ReachMessageTypes::cr_ReachMessageTypes_READ_PARAMETERS_cr_ReachMessageTypes::cr_ReachMessageTypes_WRITE_PARAMETERS_cr_ReachMessageTypes::cr_ReachMessageTypes_PARAMETER_NOTIFICATION_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_NOTIFICATIONS_cr_ReachMessageTypes::cr_ReachMessageTypes_PARAM_ENABLE_NOTIFY_cr_ReachMessageTypes::cr_ReachMessageTypes_PARAM_DISABLE_NOTIFY_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_FILES_cr_ReachMessageTypes::cr_ReachMessageTypes_TRANSFER_INIT_cr_ReachMessageTypes::cr_ReachMessageTypes_TRANSFER_DATA_cr_ReachMessageTypes::cr_ReachMessageTypes_TRANSFER_DATA_NOTIFICATION_cr_ReachMessageTypes::cr_ReachMessageTypes_ERASE_FILE_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_COMMANDS_cr_ReachMessageTypes::cr_ReachMessageTypes_SEND_COMMAND_cr_ReachMessageTypes::cr_ReachMessageTypes_CLI_NOTIFICATION_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_STREAMS_cr_ReachMessageTypes::cr_ReachMessageTypes_OPEN_STREAM_cr_ReachMessageTypes::cr_ReachMessageTypes_CLOSE_STREAM_cr_ReachMessageTypes::cr_ReachMessageTypes_STREAM_DATA_NOTIFICATION_cr_ReachMessageTypes::cr_ReachMessageTypes_SET_TIME_cr_ReachMessageTypes::cr_ReachMessageTypes_GET_TIME_cr_ReachMessageTypes::cr_ReachMessageTypes_DISCOVER_WIFI_cr_ReachMessageTypes::cr_ReachMessageTypes_WIFI_CONNECT
_cr_ServiceIds_cr_ServiceIds::cr_ServiceIds_NO_SVC_ID_cr_ServiceIds::cr_ServiceIds_PARAMETER_REPO_cr_ServiceIds::cr_ServiceIds_FILES_cr_ServiceIds::cr_ServiceIds_STREAMS_cr_ServiceIds::cr_ServiceIds_COMMANDS_cr_ServiceIds::cr_ServiceIds_CLI_cr_ServiceIds::cr_ServiceIds_TIME_cr_ServiceIds::cr_ServiceIds_WIFI
_cr_EndpointIds_cr_ParameterDataType_cr_ParameterDataType::cr_ParameterDataType_UINT32_cr_ParameterDataType::cr_ParameterDataType_INT32_cr_ParameterDataType::cr_ParameterDataType_FLOAT32_cr_ParameterDataType::cr_ParameterDataType_UINT64_cr_ParameterDataType::cr_ParameterDataType_INT64_cr_ParameterDataType::cr_ParameterDataType_FLOAT64_cr_ParameterDataType::cr_ParameterDataType_BOOL_cr_ParameterDataType::cr_ParameterDataType_STRING_cr_ParameterDataType::cr_ParameterDataType_ENUMERATION_cr_ParameterDataType::cr_ParameterDataType_BIT_FIELD_cr_ParameterDataType::cr_ParameterDataType_BYTE_ARRAY
_cr_AccessLevel_cr_StorageLocation_cr_WiFiSecurity_cr_WiFiBand_cr_ErrorCodes_cr_ErrorCodes::cr_ErrorCodes_NO_ERROR_cr_ErrorCodes::cr_ErrorCodes_NO_DATA_cr_ErrorCodes::cr_ErrorCodes_READ_FAILED_cr_ErrorCodes::cr_ErrorCodes_WRITE_FAILED_cr_ErrorCodes::cr_ErrorCodes_NOT_IMPLEMENTED_cr_ErrorCodes::cr_ErrorCodes_RESERVED_1_cr_ErrorCodes::cr_ErrorCodes_RESERVED_2_cr_ErrorCodes::cr_ErrorCodes_PERMISSION_DENIED_cr_ErrorCodes::cr_ErrorCodes_BUFFER_TOO_SMALL_cr_ErrorCodes::cr_ErrorCodes_INVALID_PARAMETER_cr_ErrorCodes::cr_ErrorCodes_CHECKSUM_MISMATCH_cr_ErrorCodes::cr_ErrorCodes_DECODING_FAILED_cr_ErrorCodes::cr_ErrorCodes_ENCODING_FAILED_cr_ErrorCodes::cr_ErrorCodes_INVALID_STATE_cr_ErrorCodes::cr_ErrorCodes_NO_RESPONSE_cr_ErrorCodes::cr_ErrorCodes_BAD_FILE_cr_ErrorCodes::cr_ErrorCodes_PACKET_COUNT_ERR_cr_ErrorCodes::cr_ErrorCodes_CHALLENGE_FAILED_cr_ErrorCodes::cr_ErrorCodes_RESERVED_3_cr_ErrorCodes::cr_ErrorCodes_NO_RESOURCE_cr_ErrorCodes::cr_ErrorCodes_INVALID_ID_cr_ErrorCodes::cr_ErrorCodes_INCOMPLETE_cr_ErrorCodes::cr_ErrorCodes_ABORT
_cr_FileTransferState_cr_SizesOffsets_cr_SizesOffsets::cr_SizesOffsets_MAX_MESSAGE_SIZE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_BIG_DATA_BUFFER_SIZE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_PARAMETER_BUFFER_COUNT_OFFSET_cr_SizesOffsets::cr_SizesOffsets_NUM_PARAMS_IN_RESPONSE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_DESCRIPTION_LEN_OFFSET_cr_SizesOffsets::cr_SizesOffsets_MAX_PARAM_BYTES_OFFSET_cr_SizesOffsets::cr_SizesOffsets_PARAM_INFO_DESCRIPTION_LEN_OFFSET_cr_SizesOffsets::cr_SizesOffsets_MEDIUM_STRING_LEN_OFFSET_cr_SizesOffsets::cr_SizesOffsets_SHORT_STRING_LEN_OFFSET_cr_SizesOffsets::cr_SizesOffsets_PARAM_NOTIFY_CONFIG_COUNT_OFFSET_cr_SizesOffsets::cr_SizesOffsets_NUM_DESCRIPTORS_IN_RESPONSE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_NUM_PARAM_NOTIFICATIONS_OFFSET_cr_SizesOffsets::cr_SizesOffsets_NUM_COMMANDS_IN_RESPONSE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_COUNT_PARAM_DESC_IN_RESPONSE_OFFSET_cr_SizesOffsets::cr_SizesOffsets_STRUCTURE_SIZE
_cr_ReachMessageHeader_cr_ReachMessage_cr_AhsokaMessageHeader_cr_ErrorReport_cr_PingRequest_cr_PingResponse_cr_DeviceInfoRequest_cr_DeviceInfoResponse_cr_DeviceInfoResponse::device_name_cr_DeviceInfoResponse::manufacturer_cr_DeviceInfoResponse::device_description_cr_DeviceInfoResponse::firmware_version_cr_DeviceInfoResponse::protocol_version_string_cr_DeviceInfoResponse::services_cr_DeviceInfoResponse::parameter_metadata_hash_cr_DeviceInfoResponse::has_application_identifier_cr_DeviceInfoResponse::application_identifier_cr_DeviceInfoResponse::endpoints_cr_DeviceInfoResponse::sizes_struct
_cr_ParameterInfoRequest_cr_Uint32ParameterInfo_cr_Int32ParameterInfo_cr_Float32ParameterInfo_cr_Float32ParameterInfo::has_range_min_cr_Float32ParameterInfo::range_min_cr_Float32ParameterInfo::has_range_max_cr_Float32ParameterInfo::range_max_cr_Float32ParameterInfo::has_default_value_cr_Float32ParameterInfo::default_value_cr_Float32ParameterInfo::has_precision_cr_Float32ParameterInfo::precision_cr_Float32ParameterInfo::has_units_cr_Float32ParameterInfo::units
_cr_Uint64ParameterInfo_cr_Int64ParameterInfo_cr_Float64ParameterInfo_cr_Float64ParameterInfo::has_range_min_cr_Float64ParameterInfo::range_min_cr_Float64ParameterInfo::has_range_max_cr_Float64ParameterInfo::range_max_cr_Float64ParameterInfo::has_default_value_cr_Float64ParameterInfo::default_value_cr_Float64ParameterInfo::has_precision_cr_Float64ParameterInfo::precision_cr_Float64ParameterInfo::has_units_cr_Float64ParameterInfo::units
_cr_BoolParameterInfo_cr_StringParameterInfo_cr_EnumParameterInfo_cr_EnumParameterInfo::has_range_min_cr_EnumParameterInfo::range_min_cr_EnumParameterInfo::has_range_max_cr_EnumParameterInfo::range_max_cr_EnumParameterInfo::has_default_value_cr_EnumParameterInfo::default_value_cr_EnumParameterInfo::has_pei_id_cr_EnumParameterInfo::pei_id_cr_EnumParameterInfo::has_units_cr_EnumParameterInfo::units
_cr_BitfieldParameterInfo_cr_ByteArrayParameterInfo_cr_ParameterInfo_cr_ParameterInfo::id_cr_ParameterInfo::name_cr_ParameterInfo::has_description_cr_ParameterInfo::description_cr_ParameterInfo::access_cr_ParameterInfo::storage_location_cr_ParameterInfo::which_desc_cr_ParameterInfo::uint32_desc_cr_ParameterInfo::int32_desc_cr_ParameterInfo::float32_desc_cr_ParameterInfo::uint64_desc_cr_ParameterInfo::int64_desc_cr_ParameterInfo::float64_desc_cr_ParameterInfo::bool_desc_cr_ParameterInfo::string_desc_cr_ParameterInfo::enum_desc_cr_ParameterInfo::bitfield_desc_cr_ParameterInfo::bytearray_desc_cr_ParameterInfo::desc
_cr_ParameterInfoResponse_cr_ParamExKey_cr_ParamExInfoResponse_cr_ParameterRead_cr_ParameterWriteResponse_cr_ParameterNotifyConfig_cr_ParameterEnableNotifications_cr_ParameterDisableNotifications_cr_ParameterNotifyConfigResponse_cr_DiscoverParameterNotifications_cr_DiscoverParameterNotificationsResponse_cr_ParameterValue_cr_ParameterValue::parameter_id_cr_ParameterValue::timestamp_cr_ParameterValue::which_value_cr_ParameterValue::uint32_value_cr_ParameterValue::int32_value_cr_ParameterValue::float32_value_cr_ParameterValue::uint64_value_cr_ParameterValue::int64_value_cr_ParameterValue::float64_value_cr_ParameterValue::bool_value_cr_ParameterValue::string_value_cr_ParameterValue::enum_value_cr_ParameterValue::bitfield_value_cr_ParameterValue::bytes_value_cr_ParameterValue::value
_cr_ParameterReadResponse_cr_ParameterWrite_cr_ParameterNotification_cr_DiscoverFiles_cr_FileInfo_cr_DiscoverFilesResponse_cr_FileTransferRequest_cr_FileTransferRequest::file_id_cr_FileTransferRequest::read_write_cr_FileTransferRequest::request_offset_cr_FileTransferRequest::transfer_length_cr_FileTransferRequest::transfer_id_cr_FileTransferRequest::timeout_in_ms_cr_FileTransferRequest::has_requested_ack_rate_cr_FileTransferRequest::requested_ack_rate_cr_FileTransferRequest::require_checksum
_cr_FileTransferResponse_cr_FileTransferData_cr_FileTransferDataNotification_cr_FileEraseRequest_cr_FileEraseResponse_cr_DiscoverStreams_cr_StreamInfo_cr_DiscoverStreamsResponse_cr_StreamOpen_cr_StreamResponse_cr_StreamClose_cr_StreamData_cr_DiscoverCommands_cr_CommandInfo_cr_DiscoverCommandsResponse_cr_SendCommand_cr_SendCommandResponse_cr_CLIData_cr_TimeSetRequest_cr_TimeSetResponse_cr_TimeGetRequest_cr_TimeGetResponse_cr_ConnectionDescription_cr_DiscoverWiFi_cr_DiscoverWiFiResponse_cr_WiFiConnectionRequest_cr_WiFiConnectionResponse_cr_BufferSizes_cr_BufferSizes::max_message_size_cr_BufferSizes::big_data_buffer_size_cr_BufferSizes::parameter_buffer_count_cr_BufferSizes::num_params_in_response_cr_BufferSizes::num_descriptors_in_response_cr_BufferSizes::description_len_cr_BufferSizes::max_param_bytes_cr_BufferSizes::medium_string_len_cr_BufferSizes::short_string_len_cr_BufferSizes::param_info_description_len_cr_BufferSizes::num_param_notifications_cr_BufferSizes::num_commands_in_response_cr_BufferSizes::count_param_desc_in_response_cr_BufferSizes::param_notify_config_count
- File: crcb_weak.h