Welcome to Robot Raconteur Python’s documentation!
Tutorial:
- Introduction
- Service Definition
- Robot Raconteur Python
- iRobot Create Python Example
- Webcam Example
- Service Discovery
- Subscriptions
- Authentication
- Exclusive object locks
- Time-critical software with Wire member
- Forward compatibility with the “implements” statement
- Member Modifiers
- Asynchronous programming
- Gather/Scatter operations
- Standard Service Definitions and Companion
- Robot Raconteur Directory
Framework:
API:
- Constants
- DataTypes Enum
RobotRaconteur.DataTypes_void_tRobotRaconteur.DataTypes_double_tRobotRaconteur.DataTypes_single_tRobotRaconteur.DataTypes_int8_tRobotRaconteur.DataTypes_uint8_tRobotRaconteur.DataTypes_int16_tRobotRaconteur.DataTypes_uint16_tRobotRaconteur.DataTypes_int32_tRobotRaconteur.DataTypes_uint32_tRobotRaconteur.DataTypes_int64_tRobotRaconteur.DataTypes_uint64_tRobotRaconteur.DataTypes_string_tRobotRaconteur.DataTypes_cdouble_tRobotRaconteur.DataTypes_csingle_tRobotRaconteur.DataTypes_bool_tRobotRaconteur.DataTypes_structure_tRobotRaconteur.DataTypes_vector_tRobotRaconteur.DataTypes_dictionary_tRobotRaconteur.DataTypes_object_tRobotRaconteur.DataTypes_varvalue_tRobotRaconteur.DataTypes_varobject_tRobotRaconteur.DataTypes_list_tRobotRaconteur.DataTypes_pod_tRobotRaconteur.DataTypes_pod_array_tRobotRaconteur.DataTypes_pod_multidimarray_tRobotRaconteur.DataTypes_enum_tRobotRaconteur.DataTypes_namedtype_tRobotRaconteur.DataTypes_namedarray_tRobotRaconteur.DataTypes_namedarray_array_tRobotRaconteur.DataTypes_namedarray_multidimarray_tRobotRaconteur.DataTypes_multidimarray_tRobotRaconteur.DataTypes_ArrayTypes_noneRobotRaconteur.DataTypes_ArrayTypes_arrayRobotRaconteur.DataTypes_ArrayTypes_multidimarrayRobotRaconteur.DataTypes_ContainerTypes_noneRobotRaconteur.DataTypes_ContainerTypes_listRobotRaconteur.DataTypes_ContainerTypes_map_int32RobotRaconteur.DataTypes_ContainerTypes_map_stringRobotRaconteur.DataTypes_ContainerTypes_generator
- MessageEntryType Enum
RobotRaconteur.MessageEntryType_NullRobotRaconteur.MessageEntryType_StreamOpRobotRaconteur.MessageEntryType_StreamOpRetRobotRaconteur.MessageEntryType_StreamCheckCapabilityRobotRaconteur.MessageEntryType_StreamCheckCapabilityRetRobotRaconteur.MessageEntryType_GetServiceDescRobotRaconteur.MessageEntryType_GetServiceDescRetRobotRaconteur.MessageEntryType_ObjectTypeNameRobotRaconteur.MessageEntryType_ObjectTypeNameRetRobotRaconteur.MessageEntryType_ServiceClosedRobotRaconteur.MessageEntryType_ServiceClosedRetRobotRaconteur.MessageEntryType_ConnectClientRobotRaconteur.MessageEntryType_ConnectClientRetRobotRaconteur.MessageEntryType_DisconnectClientRobotRaconteur.MessageEntryType_DisconnectClientRetRobotRaconteur.MessageEntryType_ConnectionTestRobotRaconteur.MessageEntryType_ConnectionTestRetRobotRaconteur.MessageEntryType_GetNodeInfoRobotRaconteur.MessageEntryType_GetNodeInfoRetRobotRaconteur.MessageEntryType_ReconnectClientRobotRaconteur.MessageEntryType_ReconnectClientRetRobotRaconteur.MessageEntryType_NodeCheckCapabilityRobotRaconteur.MessageEntryType_NodeCheckCapabilityRetRobotRaconteur.MessageEntryType_GetServiceAttributesRobotRaconteur.MessageEntryType_GetServiceAttributesRetRobotRaconteur.MessageEntryType_ConnectClientCombinedRobotRaconteur.MessageEntryType_ConnectClientCombinedRetRobotRaconteur.MessageEntryType_EndpointCheckCapabilityRobotRaconteur.MessageEntryType_EndpointCheckCapabilityRetRobotRaconteur.MessageEntryType_ServiceCheckCapabilityReqRobotRaconteur.MessageEntryType_ServiceCheckCapabilityRetRobotRaconteur.MessageEntryType_ClientKeepAliveReqRobotRaconteur.MessageEntryType_ClientKeepAliveRetRobotRaconteur.MessageEntryType_ClientSessionOpReqRobotRaconteur.MessageEntryType_ClientSessionOpRetRobotRaconteur.MessageEntryType_ServicePathReleasedReqRobotRaconteur.MessageEntryType_ServicePathReleasedRetRobotRaconteur.MessageEntryType_PropertyGetReqRobotRaconteur.MessageEntryType_PropertyGetResRobotRaconteur.MessageEntryType_PropertySetReqRobotRaconteur.MessageEntryType_PropertySetResRobotRaconteur.MessageEntryType_FunctionCallReqRobotRaconteur.MessageEntryType_FunctionCallResRobotRaconteur.MessageEntryType_GeneratorNextReqRobotRaconteur.MessageEntryType_GeneratorNextResRobotRaconteur.MessageEntryType_EventReqRobotRaconteur.MessageEntryType_EventResRobotRaconteur.MessageEntryType_PipePacketRobotRaconteur.MessageEntryType_PipePacketRetRobotRaconteur.MessageEntryType_PipeConnectReqRobotRaconteur.MessageEntryType_PipeConnectRetRobotRaconteur.MessageEntryType_PipeDisconnectReqRobotRaconteur.MessageEntryType_PipeDisconnectRetRobotRaconteur.MessageEntryType_PipeClosedRobotRaconteur.MessageEntryType_PipeClosedRetRobotRaconteur.MessageEntryType_CallbackCallReqRobotRaconteur.MessageEntryType_CallbackCallRetRobotRaconteur.MessageEntryType_WirePacketRobotRaconteur.MessageEntryType_WirePacketRetRobotRaconteur.MessageEntryType_WireConnectReqRobotRaconteur.MessageEntryType_WireConnectRetRobotRaconteur.MessageEntryType_WireDisconnectReqRobotRaconteur.MessageEntryType_WireDisconnectRetRobotRaconteur.MessageEntryType_WireClosedRobotRaconteur.MessageEntryType_WireClosedRetRobotRaconteur.MessageEntryType_MemoryReadRobotRaconteur.MessageEntryType_MemoryReadRetRobotRaconteur.MessageEntryType_MemoryWriteRobotRaconteur.MessageEntryType_MemoryWriteRetRobotRaconteur.MessageEntryType_MemoryGetParamRobotRaconteur.MessageEntryType_MemoryGetParamRetRobotRaconteur.MessageEntryType_WirePeekInValueReqRobotRaconteur.MessageEntryType_WirePeekInValueRetRobotRaconteur.MessageEntryType_WirePeekOutValueReqRobotRaconteur.MessageEntryType_WirePeekOutValueRetRobotRaconteur.MessageEntryType_WirePokeOutValueReqRobotRaconteur.MessageEntryType_WirePokeOutValueRet
- MessageErrorType Enum
RobotRaconteur.MessageErrorType_NoneRobotRaconteur.MessageErrorType_ConnectionErrorRobotRaconteur.MessageErrorType_ProtocolErrorRobotRaconteur.MessageErrorType_ServiceNotFoundRobotRaconteur.MessageErrorType_ObjectNotFoundRobotRaconteur.MessageErrorType_InvalidEndpointRobotRaconteur.MessageErrorType_EndpointCommunicationFatalErrorRobotRaconteur.MessageErrorType_NodeNotFoundRobotRaconteur.MessageErrorType_ServiceErrorRobotRaconteur.MessageErrorType_MemberNotFoundRobotRaconteur.MessageErrorType_MemberFormatMismatchRobotRaconteur.MessageErrorType_DataTypeMismatchRobotRaconteur.MessageErrorType_DataTypeErrorRobotRaconteur.MessageErrorType_DataSerializationErrorRobotRaconteur.MessageErrorType_MessageEntryNotFoundRobotRaconteur.MessageErrorType_MessageElementNotFoundRobotRaconteur.MessageErrorType_UnknownErrorRobotRaconteur.MessageErrorType_InvalidOperationRobotRaconteur.MessageErrorType_InvalidArgumentRobotRaconteur.MessageErrorType_OperationFailedRobotRaconteur.MessageErrorType_NullValueRobotRaconteur.MessageErrorType_InternalErrorRobotRaconteur.MessageErrorType_SystemResourcePermissionDeniedRobotRaconteur.MessageErrorType_OutOfSystemResourceRobotRaconteur.MessageErrorType_SystemResourceErrorRobotRaconteur.MessageErrorType_ResourceNotFoundRobotRaconteur.MessageErrorType_IOErrorRobotRaconteur.MessageErrorType_BufferLimitViolationRobotRaconteur.MessageErrorType_ServiceDefinitionErrorRobotRaconteur.MessageErrorType_OutOfRangeRobotRaconteur.MessageErrorType_KeyNotFoundRobotRaconteur.MessageErrorType_InvalidConfigurationRobotRaconteur.MessageErrorType_InvalidStateRobotRaconteur.MessageErrorType_RemoteErrorRobotRaconteur.MessageErrorType_RequestTimeoutRobotRaconteur.MessageErrorType_ReadOnlyMemberRobotRaconteur.MessageErrorType_WriteOnlyMemberRobotRaconteur.MessageErrorType_NotImplementedErrorRobotRaconteur.MessageErrorType_MemberBusyRobotRaconteur.MessageErrorType_ValueNotSetRobotRaconteur.MessageErrorType_AbortOperationRobotRaconteur.MessageErrorType_OperationAbortedRobotRaconteur.MessageErrorType_StopIterationRobotRaconteur.MessageErrorType_OperationTimeoutRobotRaconteur.MessageErrorType_OperationCancelledRobotRaconteur.MessageErrorType_AuthenticationErrorRobotRaconteur.MessageErrorType_ObjectLockedErrorRobotRaconteur.MessageErrorType_PermissionDenied
- ClientServiceListenerEventType Enum
- ServerServiceListenerEventType Enum
- MemberDefinition Enum
- Misc Constants
- RobotRaconteurObjectLockFlags Enum
- DataTypes Enum
- RobotRaconteurNode
- Misc Data Types
- Pipe Member
- Wire Member
- Callback Member
- Subscription
- ServiceInfo2Subscription Class
- ServiceSubscription Class
- ServiceSubscriptionClientID Class
- ServiceSubscriptionFilter Class
- ServiceSubscriptionFilterNode Class
- WireSubscription Class
- PipeSubscription Class
- SubObjectSubscription Class
- ServiceSubscriptionManager Class
- ServiceSubscriptionManagerDetails Class
- Node Setup
- RobotRaconteurNodeSetup Class
- ClientNodeSetup Class
- ServerNodeSetup Class
- SecureServerNodeSetup Class
- CommandLineConfigParser Class
- Node Setup Flags
RobotRaconteur.RobotRaconteurNodeSetupFlags_NONERobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_NODE_DISCOVERY_LISTENINGRobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_NODE_ANNOUNCERobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_LOCAL_TRANSPORTRobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_TCP_TRANSPORTRobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_HARDWARE_TRANSPORTRobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_START_SERVERRobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_START_CLIENTRobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_TRANSPORT_START_SERVERRobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_TRANSPORT_START_SERVER_PORT_SHARERRobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_MESSAGE4RobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_STRINGTABLERobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_TIMEOUTSRobotRaconteur.RobotRaconteurNodeSetupFlags_LOAD_TLS_CERTRobotRaconteur.RobotRaconteurNodeSetupFlags_REQUIRE_TLSRobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_SERVER_PUBLICRobotRaconteur.RobotRaconteurNodeSetupFlags_NODENAME_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_NODEID_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_PORT_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_WEBSOCKET_ORIGIN_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_INTRA_TRANSPORTRobotRaconteur.RobotRaconteurNodeSetupFlags_INTRA_TRANSPORT_START_SERVERRobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TAP_ENABLERobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TAP_NAMERobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_ALL_TRANSPORTSRobotRaconteur.RobotRaconteurNodeSetupFlags_CLIENT_DEFAULTRobotRaconteur.RobotRaconteurNodeSetupFlags_CLIENT_DEFAULT_ALLOWED_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_SERVER_DEFAULTRobotRaconteur.RobotRaconteurNodeSetupFlags_SERVER_DEFAULT_ALLOWED_OVERRIDERobotRaconteur.RobotRaconteurNodeSetupFlags_SECURE_SERVER_DEFAULTRobotRaconteur.RobotRaconteurNodeSetupFlags_SECURE_SERVER_DEFAULT_ALLOWED_OVERRIDE
- Transports
- TcpTransport Class
- LocalTransport Class
- IntraTransport Class
- HardwareTransport Class
- BrowserWebSocketTransport Class
RobotRaconteur.BrowserWebSocketTransportRobotRaconteur.BrowserWebSocketTransport.DefaultReceiveTimeoutRobotRaconteur.BrowserWebSocketTransport.DefaultConnectTimeoutRobotRaconteur.BrowserWebSocketTransport.DefaultHeartbeatPeriodRobotRaconteur.BrowserWebSocketTransport.MaxMessageSizeRobotRaconteur.BrowserWebSocketTransport.DisableMessage4RobotRaconteur.BrowserWebSocketTransport.DisableStringTableRobotRaconteur.BrowserWebSocketTransport.DisableAsyncMessageIO
- Timers
- Generators
- Service
- Service Security
- Exceptions
- RobotRaconteurException
- Other Exceptions
RobotRaconteur.ConnectionExceptionRobotRaconteur.ProtocolExceptionRobotRaconteur.ServiceNotFoundExceptionRobotRaconteur.ObjectNotFoundExceptionRobotRaconteur.InvalidEndpointExceptionRobotRaconteur.EndpointCommunicationFatalExceptionRobotRaconteur.EndpointCommunicationFatalException.errorcodeRobotRaconteur.EndpointCommunicationFatalException.errornameRobotRaconteur.EndpointCommunicationFatalException.messageRobotRaconteur.EndpointCommunicationFatalException.errorsubnameRobotRaconteur.EndpointCommunicationFatalException.errorparam
RobotRaconteur.NodeNotFoundExceptionRobotRaconteur.ServiceExceptionRobotRaconteur.MemberNotFoundExceptionRobotRaconteur.MemberFormatMismatchExceptionRobotRaconteur.DataTypeMismatchExceptionRobotRaconteur.DataTypeExceptionRobotRaconteur.DataSerializationExceptionRobotRaconteur.MessageEntryNotFoundExceptionRobotRaconteur.MessageElementNotFoundExceptionRobotRaconteur.UnknownExceptionRobotRaconteur.InvalidOperationExceptionRobotRaconteur.InvalidArgumentExceptionRobotRaconteur.OperationFailedExceptionRobotRaconteur.NullValueExceptionRobotRaconteur.InternalErrorExceptionRobotRaconteur.PermissionDeniedExceptionRobotRaconteur.SystemResourcePermissionDeniedExceptionRobotRaconteur.SystemResourcePermissionDeniedException.errorcodeRobotRaconteur.SystemResourcePermissionDeniedException.errornameRobotRaconteur.SystemResourcePermissionDeniedException.messageRobotRaconteur.SystemResourcePermissionDeniedException.errorsubnameRobotRaconteur.SystemResourcePermissionDeniedException.errorparam
RobotRaconteur.OutOfSystemResourceExceptionRobotRaconteur.SystemResourceExceptionRobotRaconteur.ResourceNotFoundExceptionRobotRaconteur.IOExceptionRobotRaconteur.BufferLimitViolationExceptionRobotRaconteur.ServiceDefinitionExceptionRobotRaconteur.OutOfRangeExceptionRobotRaconteur.KeyNotFoundExceptionRobotRaconteur.InvalidConfigurationExceptionRobotRaconteur.InvalidStateExceptionRobotRaconteur.RobotRaconteurRemoteExceptionRobotRaconteur.RequestTimeoutExceptionRobotRaconteur.ReadOnlyMemberExceptionRobotRaconteur.WriteOnlyMemberExceptionRobotRaconteur.NotImplementedExceptionRobotRaconteur.MemberBusyExceptionRobotRaconteur.ValueNotSetExceptionRobotRaconteur.AuthenticationExceptionRobotRaconteur.ObjectLockedExceptionRobotRaconteur.AbortOperationExceptionRobotRaconteur.OperationAbortedExceptionRobotRaconteur.StopIterationExceptionRobotRaconteur.OperationTimeoutExceptionRobotRaconteur.OperationCancelledException
- Logging and Taps
- RRLogRecord Class
- LogRecordHandler Class
- FileLogRecordHandler Class
- LogLevel Enum
- LogComponent Enum
RobotRaconteur.LogComponent_DefaultRobotRaconteur.LogComponent_NodeRobotRaconteur.LogComponent_TransportRobotRaconteur.LogComponent_MessageRobotRaconteur.LogComponent_ClientRobotRaconteur.LogComponent_ServiceRobotRaconteur.LogComponent_MemberRobotRaconteur.LogComponent_PackRobotRaconteur.LogComponent_UnpackRobotRaconteur.LogComponent_ServiceDefinitionRobotRaconteur.LogComponent_DiscoveryRobotRaconteur.LogComponent_SubscriptionRobotRaconteur.LogComponent_NodeSetupRobotRaconteur.LogComponent_UtilityRobotRaconteur.LogComponent_RobDefLibRobotRaconteur.LogComponent_UserRobotRaconteur.LogComponent_UserClientRobotRaconteur.LogComponent_UserServiceRobotRaconteur.LogComponent_ThirdParty
- Broadcast Dowsampler