ese774_frame
Guides
Tutorial
Create the device-control class
Start the server
Call the device from a client
Generate client
.pyi
files
Register DeviceProxy
Use a device-specific Router when necessary
Use ApiSpec/Pydantic when an explicit contract is required
Author
API Reference
API Reference
ese774_frame
ese774_frame package
Subpackages
Submodules
ese774_frame.adapter module
ese774_frame.api_server module
ese774_frame
Index
Index
A
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
A
api_spec (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
ApiSpec (class in ese774_frame.models.api_spec)
as_one_line_comment() (in module ese774_frame.routers.make_pyi_device_router)
async_client_cls (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
AsyncDeviceClient (class in ese774_frame.clients.async_device_client)
auto_extract_result() (ese774_frame.clients.async_device_client.AsyncDeviceClient static method)
(ese774_frame.clients.sync_device_client.SyncDeviceClient static method)
C
close() (ese774_frame.clients.async_device_client.AsyncDeviceClient method)
(ese774_frame.clients.sync_device_client.SyncDeviceClient method)
close_client() (ese774_frame.clients.sync_device_client.SyncDeviceClient method)
collect_type_hints_from_model() (in module ese774_frame.clients.make_pyi_device_client)
create_device_proxy() (in module ese774_frame.clients.device_proxy)
D
decode_response() (ese774_frame.models.api_spec.ApiSpec method)
default_async_mode (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
description (ese774_frame.models.api_spec.ApiSpec attribute)
device_class (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
DeviceProxy() (in module ese774_frame.clients.device_proxy)
DeviceProxyEntry (class in ese774_frame.clients.device_proxy)
DeviceRouter (class in ese774_frame.routers.device_router)
dispatch() (ese774_frame.clients.async_device_client.AsyncDeviceClient method)
(ese774_frame.clients.sync_device_client.SyncDeviceClient method)
E
ese774_frame
module
ese774_frame.adapter
module
ese774_frame.api_server
module
ese774_frame.clients
module
ese774_frame.clients.async_device_client
module
ese774_frame.clients.device_proxy
module
ese774_frame.clients.make_pyi_device_client
module
ese774_frame.clients.make_pyi_device_proxy
module
ese774_frame.clients.sync_device_client
module
ese774_frame.models
module
ese774_frame.models.api_spec
module
ese774_frame.routers
module
ese774_frame.routers.device_router
module
ese774_frame.routers.make_pyi_device_router
module
extract_all_types() (in module ese774_frame.clients.make_pyi_device_client)
F
FastApiServer (class in ese774_frame.api_server)
function_name (ese774_frame.models.api_spec.ApiSpec attribute)
G
gen_api_method_signatures() (in module ese774_frame.clients.make_pyi_device_client)
gen_api_property_signatures() (in module ese774_frame.clients.make_pyi_device_client)
gen_auto_method_signature() (in module ese774_frame.clients.make_pyi_device_client)
gen_auto_property_signature() (in module ese774_frame.clients.make_pyi_device_client)
get_device_proxy_entry() (in module ese774_frame.clients.device_proxy)
I
inspect_empty() (in module ese774_frame.adapter)
K
kind (ese774_frame.models.api_spec.ApiSpec attribute)
L
lifespan() (ese774_frame.api_server.FastApiServer method)
list_device_proxies() (in module ese774_frame.clients.device_proxy)
local_echo() (ese774_frame.clients.async_device_client.AsyncDeviceClient method)
(ese774_frame.clients.sync_device_client.SyncDeviceClient method)
M
make_pyi_device_client() (in module ese774_frame.clients.make_pyi_device_client)
make_pyi_device_proxy() (in module ese774_frame.clients.make_pyi_device_proxy)
make_pyi_device_router() (in module ese774_frame.routers.make_pyi_device_router)
method (ese774_frame.models.api_spec.ApiSpec attribute)
module
ese774_frame
ese774_frame.adapter
ese774_frame.api_server
ese774_frame.clients
ese774_frame.clients.async_device_client
ese774_frame.clients.device_proxy
ese774_frame.clients.make_pyi_device_client
ese774_frame.clients.make_pyi_device_proxy
ese774_frame.clients.sync_device_client
ese774_frame.models
ese774_frame.models.api_spec
ese774_frame.routers
ese774_frame.routers.device_router
ese774_frame.routers.make_pyi_device_router
N
name (ese774_frame.models.api_spec.ApiSpec attribute)
O
object_name (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
(ese774_frame.models.api_spec.ApiSpec attribute)
P
pack_args() (in module ese774_frame.adapter)
pack_kwargs() (in module ese774_frame.adapter)
pack_result() (in module ese774_frame.adapter)
path (ese774_frame.models.api_spec.ApiSpec attribute)
R
register_device_proxy() (in module ese774_frame.clients.device_proxy)
request_model (ese774_frame.models.api_spec.ApiSpec attribute)
response_model (ese774_frame.models.api_spec.ApiSpec attribute)
run() (ese774_frame.api_server.FastApiServer method)
S
set_timeout() (ese774_frame.clients.async_device_client.AsyncDeviceClient method)
(ese774_frame.clients.sync_device_client.SyncDeviceClient method)
summary (ese774_frame.models.api_spec.ApiSpec attribute)
sync_client_cls (ese774_frame.clients.device_proxy.DeviceProxyEntry attribute)
SyncDeviceClient (class in ese774_frame.clients.sync_device_client)
T
type_annotation_to_descriptor() (in module ese774_frame.adapter)
U
unpack_args() (in module ese774_frame.adapter)
unpack_kwargs() (in module ese774_frame.adapter)
unpack_result() (in module ese774_frame.adapter)
unregister_device_proxy() (in module ese774_frame.clients.device_proxy)
W
writable (ese774_frame.models.api_spec.ApiSpec attribute)