TYPE
Intelligent System
BARKLY LABS · AUTOMATED DOCUMENTATION
CYN-X
A human-centered intelligent system connecting local AI, interfaces, tools, software, vision, hardware, and future systems.
01
BARKLY DOCS
Project
The smallest useful picture of what this project is.
PROJECT DOCUMENTATION
CYN-X
A human-centered intelligent system connecting local AI, interfaces, tools, software, vision, hardware, and future systems.
STATUS
Active Development
PYTHON FILES
100
GENERATION
#1
02
BARKLY DOCS
Principles
The rules and design principles the project is built around.
01
Human First
02
Understandable
03
Private Where Practical
04
Experimental
03
BARKLY DOCS
Components
The major systems and pieces that make up the project.
01
Local AI
02
Memory
03
Multimodal Interaction
04
Computer Vision
05
AI Interfaces
06
Human-AI Collaboration
04
BARKLY DOCS
API Endpoints
Every discovered route is compact by default and expandable when you need its technical details.
hardware/web/app.py
3 endpoints
GET
/
home
— No description documented yet.
/
WHAT IT DOES
No description documented yet.
PARAMETERS
request
Request
ROUTE DECORATORS
GET
/dashboard
dashboard
— No description documented yet.
/dashboard
WHAT IT DOES
No description documented yet.
PARAMETERS
request
Request
ROUTE DECORATORS
POST
/chat
chat
— No description documented yet.
/chat
WHAT IT DOES
No description documented yet.
PARAMETERS
data
dict
ROUTE DECORATORS
interfaces/web/app.py
3 endpoints
GET
/
home
— No description documented yet.
/
WHAT IT DOES
No description documented yet.
PARAMETERS
request
Request
ROUTE DECORATORS
GET
/dashboard
dashboard
— No description documented yet.
/dashboard
WHAT IT DOES
No description documented yet.
PARAMETERS
request
Request
ROUTE DECORATORS
POST
/chat
chat
— No description documented yet.
/chat
WHAT IT DOES
No description documented yet.
PARAMETERS
data
dict
ROUTE DECORATORS
05
BARKLY DOCS
Functions & Methods
Searchable, grouped symbols with details hidden until requested.
ai/personality.py
11 symbols
get_manager
Get or initialize the PromptManager singleton.
ai/personality.py:173
WHAT IT DOES
Get or initialize the PromptManager singleton.
SIGNATURE
get_manager() -> PromptManagerPARAMETERS
No parameters documented.
get_personality
Load a legacy personality fragment.
ai/personality.py:191
WHAT IT DOES
Load a legacy personality fragment.
SIGNATURE
get_personality(name: str) -> strPARAMETERS
name
str
get_personality_matrix
Return a copy of the active personality matrix.
ai/personality.py:241
WHAT IT DOES
Return a copy of the active personality matrix.
SIGNATURE
get_personality_matrix() -> Dict[str, int]PARAMETERS
No parameters documented.
set_personality_matrix
Update the active personality matrix. Values are clamped between 0 and 100. Unknown traits are ignored. Invalid values are ignore…
ai/personality.py:249
WHAT IT DOES
Update the active personality matrix. Values are clamped between 0 and 100. Unknown traits are ignored. Invalid values are ignored.
SIGNATURE
set_personality_matrix(values: Dict[str, int]) -> Dict[str, int]PARAMETERS
values
Dict[str, int]
reset_personality_matrix
Reset the personality matrix to defaults.
ai/personality.py:294
WHAT IT DOES
Reset the personality matrix to defaults.
SIGNATURE
reset_personality_matrix() -> Dict[str, int]PARAMETERS
No parameters documented.
get_personality_preset
Return a personality preset. Unknown presets fall back to the default personality.
ai/personality.py:308
WHAT IT DOES
Return a personality preset. Unknown presets fall back to the default personality.
SIGNATURE
get_personality_preset(name: str) -> Dict[str, int]PARAMETERS
name
str
apply_personality_preset
Apply a personality preset to the active matrix.
ai/personality.py:330
WHAT IT DOES
Apply a personality preset to the active matrix.
SIGNATURE
apply_personality_preset(name: str) -> Dict[str, int]PARAMETERS
name
str
build_personality_prompt
Convert the active personality matrix into instructions that the language model can use.
ai/personality.py:351
WHAT IT DOES
Convert the active personality matrix into instructions that the language model can use.
SIGNATURE
build_personality_prompt() -> strPARAMETERS
No parameters documented.
get_mode
No description documented yet.
ai/personality.py:459
WHAT IT DOES
No description documented yet.
SIGNATURE
get_mode(name: str) -> strPARAMETERS
name
str
get_available_modes
No description documented yet.
ai/personality.py:470
WHAT IT DOES
No description documented yet.
SIGNATURE
get_available_modes() -> List[str]PARAMETERS
No parameters documented.
build_system_prompt
No description documented yet.
ai/personality.py:481
WHAT IT DOES
No description documented yet.
SIGNATURE
build_system_prompt(core: bool = True, modes: List[str] = None, memory: str = '', context: str = '') -> strPARAMETERS
core
bool
= True
modes
List[str]
= None
memory
str
= ''
context
str
= ''
barkly_docs.py
50 symbols
esc
No description documented yet.
barkly_docs.py:218
WHAT IT DOES
No description documented yet.
SIGNATURE
esc(value: object) -> strPARAMETERS
value
object
compact_doc
No description documented yet.
barkly_docs.py:222
WHAT IT DOES
No description documented yet.
SIGNATURE
compact_doc(doc: str, limit: int = 180) -> strPARAMETERS
doc
str
limit
int
= 180
full_doc
No description documented yet.
barkly_docs.py:234
WHAT IT DOES
No description documented yet.
SIGNATURE
full_doc(doc: str) -> strPARAMETERS
doc
str
expression_text
No description documented yet.
barkly_docs.py:241
WHAT IT DOES
No description documented yet.
SIGNATURE
expression_text(node: Optional[ast.AST]) -> strPARAMETERS
node
Optional[ast.AST]
annotation_text
No description documented yet.
barkly_docs.py:251
WHAT IT DOES
No description documented yet.
SIGNATURE
annotation_text(node: Optional[ast.AST]) -> strPARAMETERS
node
Optional[ast.AST]
relative_file
No description documented yet.
barkly_docs.py:255
WHAT IT DOES
No description documented yet.
SIGNATURE
relative_file(path: Path, root: Path) -> strPARAMETERS
path
Path
root
Path
code_line
No description documented yet.
barkly_docs.py:262
WHAT IT DOES
No description documented yet.
SIGNATURE
code_line(file: str, line: int) -> strPARAMETERS
file
str
line
int
short_hash
No description documented yet.
barkly_docs.py:266
WHAT IT DOES
No description documented yet.
SIGNATURE
short_hash(value: str) -> strPARAMETERS
value
str
safe_call
No description documented yet.
barkly_docs.py:270
WHAT IT DOES
No description documented yet.
SIGNATURE
safe_call(command: list[str], cwd: Path) -> strPARAMETERS
command
list[str]
cwd
Path
git_branch
No description documented yet.
barkly_docs.py:289
WHAT IT DOES
No description documented yet.
SIGNATURE
git_branch(root: Path) -> strPARAMETERS
root
Path
git_commit
No description documented yet.
barkly_docs.py:296
WHAT IT DOES
No description documented yet.
SIGNATURE
git_commit(root: Path) -> strPARAMETERS
root
Path
git_log
No description documented yet.
barkly_docs.py:303
WHAT IT DOES
No description documented yet.
SIGNATURE
git_log(root: Path, limit: int = 8) -> list[str]PARAMETERS
root
Path
limit
int
= 8
node_doc
No description documented yet.
barkly_docs.py:325
WHAT IT DOES
No description documented yet.
SIGNATURE
node_doc(node: ast.AST) -> strPARAMETERS
node
ast.AST
decorator_name
No description documented yet.
barkly_docs.py:329
WHAT IT DOES
No description documented yet.
SIGNATURE
decorator_name(node: ast.AST) -> strPARAMETERS
node
ast.AST
decorator_text
No description documented yet.
barkly_docs.py:343
WHAT IT DOES
No description documented yet.
SIGNATURE
decorator_text(node: ast.AST) -> strPARAMETERS
node
ast.AST
decorators_for
No description documented yet.
barkly_docs.py:347
WHAT IT DOES
No description documented yet.
SIGNATURE
decorators_for(node: ast.AST) -> list[str]PARAMETERS
node
ast.AST
parameter_kind
No description documented yet.
barkly_docs.py:354
WHAT IT DOES
No description documented yet.
SIGNATURE
parameter_kind(name: str, default_node: Optional[ast.AST]) -> strPARAMETERS
name
str
default_node
Optional[ast.AST]
collect_parameters
No description documented yet.
barkly_docs.py:379
WHAT IT DOES
No description documented yet.
SIGNATURE
collect_parameters(node: ast.FunctionDef | ast.AsyncFunctionDef) -> list[Parameter]PARAMETERS
node
ast.FunctionDef | ast.AsyncFunctionDef
call_root_name
No description documented yet.
barkly_docs.py:447
WHAT IT DOES
No description documented yet.
SIGNATURE
call_root_name(node: ast.Call) -> strPARAMETERS
node
ast.Call
extract_string_argument
No description documented yet.
barkly_docs.py:457
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_string_argument(call: ast.Call, index: int = 0) -> strPARAMETERS
call
ast.Call
index
int
= 0
extract_methods_keyword
No description documented yet.
barkly_docs.py:472
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_methods_keyword(call: ast.Call) -> list[str]PARAMETERS
call
ast.Call
endpoint_from_decorator
No description documented yet.
barkly_docs.py:491
WHAT IT DOES
No description documented yet.
SIGNATURE
endpoint_from_decorator(decorator: ast.AST, function: ast.FunctionDef | ast.AsyncFunctionDef, file: str) -> Optional[EndpointInfo]PARAMETERS
decorator
ast.AST
function
ast.FunctionDef | ast.AsyncFunctionDef
file
str
scan_python
No description documented yet.
barkly_docs.py:752
WHAT IT DOES
No description documented yet.
SIGNATURE
scan_python(root: Path) -> PythonScannerPARAMETERS
root
Path
symbol_key
No description documented yet.
barkly_docs.py:762
WHAT IT DOES
No description documented yet.
SIGNATURE
symbol_key(function: FunctionInfo) -> strPARAMETERS
function
FunctionInfo
class_key
No description documented yet.
barkly_docs.py:766
WHAT IT DOES
No description documented yet.
SIGNATURE
class_key(item: ClassInfo) -> strPARAMETERS
item
ClassInfo
endpoint_key
No description documented yet.
barkly_docs.py:770
WHAT IT DOES
No description documented yet.
SIGNATURE
endpoint_key(item: EndpointInfo) -> strPARAMETERS
item
EndpointInfo
function_fingerprint
No description documented yet.
barkly_docs.py:779
WHAT IT DOES
No description documented yet.
SIGNATURE
function_fingerprint(item: FunctionInfo) -> strPARAMETERS
item
FunctionInfo
class_fingerprint
No description documented yet.
barkly_docs.py:793
WHAT IT DOES
No description documented yet.
SIGNATURE
class_fingerprint(item: ClassInfo) -> strPARAMETERS
item
ClassInfo
endpoint_fingerprint
No description documented yet.
barkly_docs.py:810
WHAT IT DOES
No description documented yet.
SIGNATURE
endpoint_fingerprint(item: EndpointInfo) -> strPARAMETERS
item
EndpointInfo
load_state
No description documented yet.
barkly_docs.py:835
WHAT IT DOES
No description documented yet.
SIGNATURE
load_state(path: Path) -> dictPARAMETERS
path
Path
apply_state
No description documented yet.
barkly_docs.py:861
WHAT IT DOES
No description documented yet.
SIGNATURE
apply_state(scanner: PythonScanner, previous: dict) -> dictPARAMETERS
scanner
PythonScanner
previous
dict
load_project_config
No description documented yet.
barkly_docs.py:919
WHAT IT DOES
No description documented yet.
SIGNATURE
load_project_config(root: Path) -> dictPARAMETERS
root
Path
init_project
No description documented yet.
barkly_docs.py:941
WHAT IT DOES
No description documented yet.
SIGNATURE
init_project(root: Path) -> NonePARAMETERS
root
Path
badge
No description documented yet.
barkly_docs.py:963
WHAT IT DOES
No description documented yet.
SIGNATURE
badge(text: str, kind: str = '') -> strPARAMETERS
text
str
kind
str
= ''
status_badges
No description documented yet.
barkly_docs.py:977
WHAT IT DOES
No description documented yet.
SIGNATURE
status_badges(is_new: bool, is_changed: bool) -> strPARAMETERS
is_new
bool
is_changed
bool
parameter_summary
No description documented yet.
barkly_docs.py:997
WHAT IT DOES
No description documented yet.
SIGNATURE
parameter_summary(params: list[Parameter]) -> strPARAMETERS
params
list[Parameter]
parameter_details
No description documented yet.
barkly_docs.py:1010
WHAT IT DOES
No description documented yet.
SIGNATURE
parameter_details(params: list[Parameter]) -> strPARAMETERS
params
list[Parameter]
function_row
No description documented yet.
barkly_docs.py:1070
WHAT IT DOES
No description documented yet.
SIGNATURE
function_row(item: FunctionInfo, show_class: bool = False) -> strPARAMETERS
item
FunctionInfo
show_class
bool
= False
method_group
No description documented yet.
barkly_docs.py:1179
WHAT IT DOES
No description documented yet.
SIGNATURE
method_group(title: str, functions: list[FunctionInfo]) -> strPARAMETERS
title
str
functions
list[FunctionInfo]
class_group
No description documented yet.
barkly_docs.py:1244
WHAT IT DOES
No description documented yet.
SIGNATURE
class_group(item: ClassInfo) -> strPARAMETERS
item
ClassInfo
endpoint_row
No description documented yet.
barkly_docs.py:1332
WHAT IT DOES
No description documented yet.
SIGNATURE
endpoint_row(item: EndpointInfo) -> strPARAMETERS
item
EndpointInfo
module_row
No description documented yet.
barkly_docs.py:1447
WHAT IT DOES
No description documented yet.
SIGNATURE
module_row(module: ModuleInfo) -> strPARAMETERS
module
ModuleInfo
section
No description documented yet.
barkly_docs.py:1526
WHAT IT DOES
No description documented yet.
SIGNATURE
section(number: str, title: str, description: str, body: str) -> strPARAMETERS
number
str
title
str
description
str
body
str
info_card
No description documented yet.
barkly_docs.py:1566
WHAT IT DOES
No description documented yet.
SIGNATURE
info_card(title: str, value: str, description: str = '') -> strPARAMETERS
title
str
value
str
description
str
= ''
simple_card_grid
No description documented yet.
barkly_docs.py:1593
WHAT IT DOES
No description documented yet.
SIGNATURE
simple_card_grid(values: list[str]) -> strPARAMETERS
values
list[str]
search_toolbar
No description documented yet.
barkly_docs.py:1610
WHAT IT DOES
No description documented yet.
SIGNATURE
search_toolbar(input_id: str, count_id: str, new_id: str, placeholder: str) -> strPARAMETERS
input_id
str
count_id
str
new_id
str
placeholder
str
build_html
No description documented yet.
barkly_docs.py:1656
WHAT IT DOES
No description documented yet.
SIGNATURE
build_html(project: dict, scanner: PythonScanner, state: dict, root: Path) -> strPARAMETERS
project
dict
scanner
PythonScanner
state
dict
root
Path
generate
No description documented yet.
barkly_docs.py:3391
WHAT IT DOES
No description documented yet.
SIGNATURE
generate(source: Path, output: Path, name: Optional[str] = None, project_type: Optional[str] = None, status: Optional[str] = None) -> NonePARAMETERS
source
Path
output
Path
name
Optional[str]
= None
project_type
Optional[str]
= None
status
Optional[str]
= None
build_parser
No description documented yet.
barkly_docs.py:3483
WHAT IT DOES
No description documented yet.
SIGNATURE
build_parser() -> argparse.ArgumentParserPARAMETERS
No parameters documented.
main
No description documented yet.
barkly_docs.py:3547
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
benchmark/analyzer.py
5 symbols
analyze_response
No description documented yet.
benchmark/analyzer.py:19
WHAT IT DOES
No description documented yet.
SIGNATURE
analyze_response(response: str) -> dictPARAMETERS
response
str
analyze_tool_test
Analyze tool execution recorded by the benchmark runner. IMPORTANT: This function does NOT run a tool. The runner is responsible…
benchmark/analyzer.py:109
WHAT IT DOES
Analyze tool execution recorded by the benchmark runner. IMPORTANT: This function does NOT run a tool. The runner is responsible for actually running CYN-X and recording what happened. This analyzer only determines whether the recorded tool execution matches the expected behavior. Supported locations: result["tool_test"] or: result["analysis"]["tool_test"] Expected fields: expected_tool tool_called tool_name tool_arguments tool_result result_passed_to_llm failure
SIGNATURE
analyze_tool_test(result: dict) -> dict | NonePARAMETERS
result
dict
analyze_file
No description documented yet.
benchmark/analyzer.py:331
WHAT IT DOES
No description documented yet.
SIGNATURE
analyze_file(path: Path) -> dict | NonePARAMETERS
path
Path
find_result_files
Find all individual benchmark result files. Results are stored by runner.py under: benchmark/results/sections/
benchmark/analyzer.py:529
WHAT IT DOES
Find all individual benchmark result files. Results are stored by runner.py under: benchmark/results/sections/
SIGNATURE
find_result_files()PARAMETERS
No parameters documented.
analyze_results
No description documented yet.
benchmark/analyzer.py:554
WHAT IT DOES
No description documented yet.
SIGNATURE
analyze_results()PARAMETERS
No parameters documented.
benchmark/cleaner.py
1 symbols
main
No description documented yet.
benchmark/cleaner.py:448
WHAT IT DOES
No description documented yet.
SIGNATURE
main()PARAMETERS
No parameters documented.
benchmark/cli.py
1 symbols
get_benchmark_command
Parse benchmark command-line arguments. Supported: python -m benchmark.runner python -m benchmark.runner quick python -m benchmar…
benchmark/cli.py:4
WHAT IT DOES
Parse benchmark command-line arguments. Supported: python -m benchmark.runner python -m benchmark.runner quick python -m benchmark.runner normal python -m benchmark.runner full python -m benchmark.runner --all python -m benchmark.runner --suite personality python -m benchmark.runner --suite personality safety memory python -m benchmark.runner --suite personality --limit 5 python -m benchmark.runner --suite personality safety --limit 10 python -m benchmark.runner --all --limit 10
SIGNATURE
get_benchmark_command()PARAMETERS
No parameters documented.
benchmark/formatter.py
1 symbols
format_benchmark_result
No description documented yet.
benchmark/formatter.py:10
WHAT IT DOES
No description documented yet.
SIGNATURE
format_benchmark_result(test_id: str, category: str, question: str, response: str, response_time_seconds: float, observed_topics: list[str], behavior_tags: list[str], response_words: int = 0, response_characters: int = 0, response_lines: int = 0, response_sentences: int = 0, estimated_tokens: int = 0, scores: dict | None = None) -> dictPARAMETERS
test_id
str
category
str
question
str
response
str
response_time_seconds
float
observed_topics
list[str]
behavior_tags
list[str]
response_words
int
= 0
response_characters
int
= 0
response_lines
int
= 0
response_sentences
int
= 0
estimated_tokens
int
= 0
scores
dict | None
= None
benchmark/modes.py
2 symbols
apply_benchmark_filters
Filters benchmark tests before execution. Args: tests: Loaded benchmark test list. limit: Maximum number of tests to run. categor…
benchmark/modes.py:6
WHAT IT DOES
Filters benchmark tests before execution. Args: tests: Loaded benchmark test list. limit: Maximum number of tests to run. categories: Only run tests matching these categories. suites: Only run tests from these benchmark suites. Returns: Filtered list of benchmark tests.
SIGNATURE
apply_benchmark_filters(tests: list[dict], limit: Optional[int] = None, categories: Optional[list[str]] = None, suites: Optional[list[str]] = None) -> list[dict]PARAMETERS
tests
list[dict]
limit
Optional[int]
= None
categories
Optional[list[str]]
= None
suites
Optional[list[str]]
= None
get_benchmark_mode
Returns preset benchmark configurations. Modes: quick normal full
benchmark/modes.py:93
WHAT IT DOES
Returns preset benchmark configurations. Modes: quick normal full
SIGNATURE
get_benchmark_mode(mode: str) -> dictPARAMETERS
mode
str
benchmark/runner.py
20 symbols
get_result_section
No description documented yet.
benchmark/runner.py:140
WHAT IT DOES
No description documented yet.
SIGNATURE
get_result_section(category)PARAMETERS
category
_colorized_message
No description documented yet.
benchmark/runner.py:162
WHAT IT DOES
No description documented yet.
SIGNATURE
_colorized_message(message, style)PARAMETERS
message
style
bench_info
No description documented yet.
benchmark/runner.py:166
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_info(message)PARAMETERS
message
bench_warning
No description documented yet.
benchmark/runner.py:175
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_warning(message)PARAMETERS
message
bench_error
No description documented yet.
benchmark/runner.py:184
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_error(message)PARAMETERS
message
bench_pass
No description documented yet.
benchmark/runner.py:193
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_pass(message)PARAMETERS
message
bench_fail
No description documented yet.
benchmark/runner.py:199
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_fail(message)PARAMETERS
message
bench_header
No description documented yet.
benchmark/runner.py:205
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_header(message)PARAMETERS
message
bench_suite
No description documented yet.
benchmark/runner.py:211
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_suite(name)PARAMETERS
name
bench_test_id
No description documented yet.
benchmark/runner.py:215
WHAT IT DOES
No description documented yet.
SIGNATURE
bench_test_id(test_id)PARAMETERS
test_id
setup_logging
No description documented yet.
benchmark/runner.py:219
WHAT IT DOES
No description documented yet.
SIGNATURE
setup_logging()PARAMETERS
No parameters documented.
load_questions
No description documented yet.
benchmark/runner.py:324
WHAT IT DOES
No description documented yet.
SIGNATURE
load_questions(suites = None)PARAMETERS
suites
= None
configure_benchmark_prompt
Configure the existing PromptBuilder using the benchmark test's prompt preset/layers. Uses the existing PromptBuilder layer syste…
benchmark/runner.py:547
WHAT IT DOES
Configure the existing PromptBuilder using the benchmark test's prompt preset/layers. Uses the existing PromptBuilder layer system. Does not require apply_preset() or set_preset().
SIGNATURE
configure_benchmark_prompt(chat_engine, test)PARAMETERS
chat_engine
test
format_prompt_layers
No description documented yet.
benchmark/runner.py:728
WHAT IT DOES
No description documented yet.
SIGNATURE
format_prompt_layers(layers)PARAMETERS
layers
score_response
No description documented yet.
benchmark/runner.py:1205
WHAT IT DOES
No description documented yet.
SIGNATURE
score_response(response, category)PARAMETERS
response
category
run_single_test
No description documented yet.
benchmark/runner.py:1354
WHAT IT DOES
No description documented yet.
SIGNATURE
run_single_test(chat_engine, test)PARAMETERS
chat_engine
test
run_benchmark
No description documented yet.
benchmark/runner.py:1724
WHAT IT DOES
No description documented yet.
SIGNATURE
run_benchmark(chat_engine, limit = None, categories = None, suites = None)PARAMETERS
chat_engine
limit
= None
categories
= None
suites
= None
create_cynx_engine
No description documented yet.
benchmark/runner.py:2078
WHAT IT DOES
No description documented yet.
SIGNATURE
create_cynx_engine()PARAMETERS
No parameters documented.
run_command
No description documented yet.
benchmark/runner.py:2220
WHAT IT DOES
No description documented yet.
SIGNATURE
run_command(engine)PARAMETERS
engine
main
No description documented yet.
benchmark/runner.py:2395
WHAT IT DOES
No description documented yet.
SIGNATURE
main()PARAMETERS
No parameters documented.
benchmark/visualize.py
4 symbols
load_results
No description documented yet.
benchmark/visualize.py:45
WHAT IT DOES
No description documented yet.
SIGNATURE
load_results()PARAMETERS
No parameters documented.
score_rating
No description documented yet.
benchmark/visualize.py:244
WHAT IT DOES
No description documented yet.
SIGNATURE
score_rating(score)PARAMETERS
score
human_category_name
No description documented yet.
benchmark/visualize.py:279
WHAT IT DOES
No description documented yet.
SIGNATURE
human_category_name(name)PARAMETERS
name
graph
No description documented yet.
benchmark/visualize.py:362
WHAT IT DOES
No description documented yet.
SIGNATURE
graph(name, values, title, label)PARAMETERS
name
values
title
label
clean_cyn.py
2 symbols
clean_file
No description documented yet.
clean_cyn.py:22
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_file(path: Path)PARAMETERS
path
Path
main
No description documented yet.
clean_cyn.py:49
WHAT IT DOES
No description documented yet.
SIGNATURE
main()PARAMETERS
No parameters documented.
config.py
2 symbols
get_config
No description documented yet.
config.py:25
WHAT IT DOES
No description documented yet.
SIGNATURE
get_config() -> ConfigPARAMETERS
No parameters documented.
logging_level_from_env
No description documented yet.
config.py:43
WHAT IT DOES
No description documented yet.
SIGNATURE
logging_level_from_env() -> intPARAMETERS
No parameters documented.
cyndiscord.py
2 symbols
on_ready
No description documented yet.
cyndiscord.py:69
WHAT IT DOES
No description documented yet.
SIGNATURE
on_ready()PARAMETERS
No parameters documented.
DECORATORS
on_message
No description documented yet.
cyndiscord.py:73
WHAT IT DOES
No description documented yet.
SIGNATURE
on_message(message)PARAMETERS
message
DECORATORS
hardware/lepro/discovery.py
1 symbols
discover_devices
No description documented yet.
hardware/lepro/discovery.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
discover_devices(timeout: float = 15.0) -> list[dict[str, Any]]PARAMETERS
timeout
float
= 15.0
hardware/lepro/lib/lepro/bond.py
15 symbols
tokens_from_bond_frames
Bond keys from post-bond 0x2100 notify (64 B: hs + auth_16 + auth_32). Ghidra: libiot requestBond only sends encrypted magic; no…
hardware/lepro/lib/lepro/bond.py:108
WHAT IT DOES
Bond keys from post-bond 0x2100 notify (64 B: hs + auth_16 + auth_32). Ghidra: libiot requestBond only sends encrypted magic; no tokens in .so. Firmware pushes per-bond keys on 0x2100 (FUN_4200e078 / FUN_4201d274 result 7). ctrl_c/ctrl_d stay device-static (protocol.py captures).
SIGNATURE
tokens_from_bond_frames(frames: list[DecryptedFrame], after_index: int = 0) -> BondTokensPARAMETERS
frames
list[DecryptedFrame]
after_index
int
= 0
is_bond_success
True for bond result 0/7 or 16-byte LIGHT_ACK on 0x1003.
hardware/lepro/lib/lepro/bond.py:145
WHAT IT DOES
True for bond result 0/7 or 16-byte LIGHT_ACK on 0x1003.
SIGNATURE
is_bond_success(frame: DecryptedFrame) -> boolPARAMETERS
frame
DecryptedFrame
normalize_mac
No description documented yet.
hardware/lepro/lib/lepro/bond.py:156
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_mac(mac: str) -> strPARAMETERS
mac
str
creds_path
No description documented yet.
hardware/lepro/lib/lepro/bond.py:163
WHAT IT DOES
No description documented yet.
SIGNATURE
creds_path(mac: str) -> PathPARAMETERS
mac
str
load_creds
No description documented yet.
hardware/lepro/lib/lepro/bond.py:168
WHAT IT DOES
No description documented yet.
SIGNATURE
load_creds(mac: str) -> BondCredentials | NonePARAMETERS
mac
str
save_creds
No description documented yet.
hardware/lepro/lib/lepro/bond.py:176
WHAT IT DOES
No description documented yet.
SIGNATURE
save_creds(creds: BondCredentials) -> PathPARAMETERS
creds
BondCredentials
harvest_tokens
Heuristic token harvest from bond-session RX. Scans decrypted cert/device-info payloads and raw notify bytes for unique 16B and 3…
hardware/lepro/lib/lepro/bond.py:183
WHAT IT DOES
Heuristic token harvest from bond-session RX. Scans decrypted cert/device-info payloads and raw notify bytes for unique 16B and 32B candidates. Prefer blobs appearing in cert (0x2000).
SIGNATURE
harvest_tokens(frames: list[DecryptedFrame], raw_rx: list[bytes]) -> BondTokensPARAMETERS
frames
list[DecryptedFrame]
raw_rx
list[bytes]
check_bond_result
No description documented yet.
hardware/lepro/lib/lepro/bond.py:232
WHAT IT DOES
No description documented yet.
SIGNATURE
check_bond_result(frames: list[DecryptedFrame]) -> intPARAMETERS
frames
list[DecryptedFrame]
_scan_blob
No description documented yet.
hardware/lepro/lib/lepro/bond.py:240
WHAT IT DOES
No description documented yet.
SIGNATURE
_scan_blob(data: bytes, out_16: list[bytes], out_32: list[bytes]) -> NonePARAMETERS
data
bytes
out_16
list[bytes]
out_32
list[bytes]
_unique
No description documented yet.
hardware/lepro/lib/lepro/bond.py:249
WHAT IT DOES
No description documented yet.
SIGNATURE
_unique(items: list[bytes]) -> list[bytes]PARAMETERS
items
list[bytes]
export_provision_header
C header for ESP32 NVS / compile-time flash.
hardware/lepro/lib/lepro/bond.py:259
WHAT IT DOES
C header for ESP32 NVS / compile-time flash.
SIGNATURE
export_provision_header(creds: BondCredentials) -> strPARAMETERS
creds
BondCredentials
export_provision_nvs
ESP-IDF NVS CSV format.
hardware/lepro/lib/lepro/bond.py:285
WHAT IT DOES
ESP-IDF NVS CSV format.
SIGNATURE
export_provision_nvs(creds: BondCredentials) -> strPARAMETERS
creds
BondCredentials
_connect_transport
No description documented yet.
hardware/lepro/lib/lepro/bond.py:303
WHAT IT DOES
No description documented yet.
SIGNATURE
_connect_transport(mac: str, debug_rx: bool = False, scan_timeout: float = 15.0)PARAMETERS
mac
str
debug_rx
bool
= False
scan_timeout
float
= 15.0
_cmd_bond
No description documented yet.
hardware/lepro/lib/lepro/bond.py:328
WHAT IT DOES
No description documented yet.
SIGNATURE
_cmd_bond(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
main
No description documented yet.
hardware/lepro/lib/lepro/bond.py:342
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/_common.py
5 symbols
connect_transport
No description documented yet.
hardware/lepro/lib/lepro/cli/_common.py:16
WHAT IT DOES
No description documented yet.
SIGNATURE
connect_transport(mac: str, debug_rx: bool = False, scan_timeout: float = 15.0) -> tuple[BleakTransport, BleakClient]PARAMETERS
mac
str
debug_rx
bool
= False
scan_timeout
float
= 15.0
run_dry_control
No description documented yet.
hardware/lepro/lib/lepro/cli/_common.py:38
WHAT IT DOES
No description documented yet.
SIGNATURE
run_dry_control(mac: str, payload: DpPayload) -> list[tuple[str, bytes]]PARAMETERS
mac
str
payload
DpPayload
print_dry_run
No description documented yet.
hardware/lepro/lib/lepro/cli/_common.py:53
WHAT IT DOES
No description documented yet.
SIGNATURE
print_dry_run(sent: list[tuple[str, bytes]]) -> NonePARAMETERS
sent
list[tuple[str, bytes]]
run_control
No description documented yet.
hardware/lepro/lib/lepro/cli/_common.py:64
WHAT IT DOES
No description documented yet.
SIGNATURE
run_control(mac: str, payload: DpPayload, dry_run: bool = False, debug_rx: bool = False) -> NonePARAMETERS
mac
str
payload
DpPayload
dry_run
bool
= False
debug_rx
bool
= False
run_status
No description documented yet.
hardware/lepro/lib/lepro/cli/_common.py:88
WHAT IT DOES
No description documented yet.
SIGNATURE
run_status(mac: str, dry_run: bool = False, debug_rx: bool = False) -> NonePARAMETERS
mac
str
dry_run
bool
= False
debug_rx
bool
= False
hardware/lepro/lib/lepro/cli/bond.py
3 symbols
_cmd_bond
No description documented yet.
hardware/lepro/lib/lepro/cli/bond.py:25
WHAT IT DOES
No description documented yet.
SIGNATURE
_cmd_bond(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
_cmd_export
No description documented yet.
hardware/lepro/lib/lepro/cli/bond.py:64
WHAT IT DOES
No description documented yet.
SIGNATURE
_cmd_export(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
main
No description documented yet.
hardware/lepro/lib/lepro/cli/bond.py:85
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/ctl.py
2 symbols
_cmd_mode_play
No description documented yet.
hardware/lepro/lib/lepro/cli/ctl.py:17
WHAT IT DOES
No description documented yet.
SIGNATURE
_cmd_mode_play(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
main
No description documented yet.
hardware/lepro/lib/lepro/cli/ctl.py:57
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/firmware.py
5 symbols
_resolve
No description documented yet.
hardware/lepro/lib/lepro/cli/firmware.py:18
WHAT IT DOES
No description documented yet.
SIGNATURE
_resolve(profiles_path: Path | None, profile_id: str | None, firmware_path: Path | None)PARAMETERS
profiles_path
Path | None
profile_id
str | None
firmware_path
Path | None
cmd_fetch
No description documented yet.
hardware/lepro/lib/lepro/cli/firmware.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
cmd_fetch(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
cmd_patch
No description documented yet.
hardware/lepro/lib/lepro/cli/firmware.py:47
WHAT IT DOES
No description documented yet.
SIGNATURE
cmd_patch(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
cmd_verify
No description documented yet.
hardware/lepro/lib/lepro/cli/firmware.py:72
WHAT IT DOES
No description documented yet.
SIGNATURE
cmd_verify(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
main
No description documented yet.
hardware/lepro/lib/lepro/cli/firmware.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/ota.py
1 symbols
main
No description documented yet.
hardware/lepro/lib/lepro/cli/ota.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/provision.py
2 symbols
_apply_config
No description documented yet.
hardware/lepro/lib/lepro/cli/provision.py:14
WHAT IT DOES
No description documented yet.
SIGNATURE
_apply_config(args: argparse.Namespace, cfg_path: Path | None) -> NonePARAMETERS
args
argparse.Namespace
cfg_path
Path | None
main
No description documented yet.
hardware/lepro/lib/lepro/cli/provision.py:37
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/cli/status.py
1 symbols
main
No description documented yet.
hardware/lepro/lib/lepro/cli/status.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/commands.py
11 symbols
power_on
Turn lamp on. APK test harness uses {"d1":1} only.
hardware/lepro/lib/lepro/commands.py:18
WHAT IT DOES
Turn lamp on. APK test harness uses {"d1":1} only.
SIGNATURE
power_on(brightness: int = 1000) -> dict[str, Any]PARAMETERS
brightness
int
= 1000
power_off
No description documented yet.
hardware/lepro/lib/lepro/commands.py:27
WHAT IT DOES
No description documented yet.
SIGNATURE
power_off() -> dict[str, Any]PARAMETERS
No parameters documented.
color_hsv
No description documented yet.
hardware/lepro/lib/lepro/commands.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
color_hsv(hue: float, sat: int = 1000, val: int = 1000, brightness: int = 1000) -> dict[str, Any]PARAMETERS
hue
float
sat
int
= 1000
val
int
= 1000
brightness
int
= 1000
color_rgb
No description documented yet.
hardware/lepro/lib/lepro/commands.py:40
WHAT IT DOES
No description documented yet.
SIGNATURE
color_rgb(r: int, g: int, b: int, brightness: int = 1000) -> dict[str, Any]PARAMETERS
r
int
g
int
b
int
brightness
int
= 1000
status_query
getDpState query — APK passes a JSON array string to bleGetDpState().
hardware/lepro/lib/lepro/commands.py:46
WHAT IT DOES
getDpState query — APK passes a JSON array string to bleGetDpState().
SIGNATURE
status_query(fields: tuple[str, ...] | None = None) -> list[str]PARAMETERS
fields
tuple[str, ...] | None
= None
segment_solid
No description documented yet.
hardware/lepro/lib/lepro/commands.py:54
WHAT IT DOES
No description documented yet.
SIGNATURE
segment_solid(rgb: tuple[int, int, int] = (255, 255, 255), brightness: int = 1000, bulb_count: int | None = None) -> dict[str, Any]PARAMETERS
rgb
tuple[int, int, int]
= (255, 255, 255)
brightness
int
= 1000
bulb_count
int | None
= None
dp_json_text
No description documented yet.
hardware/lepro/lib/lepro/commands.py:69
WHAT IT DOES
No description documented yet.
SIGNATURE
dp_json_text(payload: DpPayload) -> strPARAMETERS
payload
DpPayload
build_dp_value_packets
Encrypt DP JSON and return (packets, next_seq).
hardware/lepro/lib/lepro/commands.py:73
WHAT IT DOES
Encrypt DP JSON and return (packets, next_seq).
SIGNATURE
build_dp_value_packets(mac: str, seq: int, payload: DpPayload, session_rand: int, max_payload: int = 128) -> tuple[list[bytes], int]PARAMETERS
mac
str
seq
int
payload
DpPayload
session_rand
int
max_payload
int
= 128
build_get_dp_state_packet
Encrypted getDpState query on 0x1102.
hardware/lepro/lib/lepro/commands.py:87
WHAT IT DOES
Encrypted getDpState query on 0x1102.
SIGNATURE
build_get_dp_state_packet(mac: str, seq: int, payload: DpPayload, session_rand: int) -> bytesPARAMETERS
mac
str
seq
int
payload
DpPayload
session_rand
int
build_dp_ciphertext_packets
No description documented yet.
hardware/lepro/lib/lepro/commands.py:99
WHAT IT DOES
No description documented yet.
SIGNATURE
build_dp_ciphertext_packets(seq: int, ciphertext: bytes, max_payload: int = 128) -> tuple[list[bytes], int]PARAMETERS
seq
int
ciphertext
bytes
max_payload
int
= 128
build_raw_cmd_packet
Opaque auth token on 0x1102 (no encryption).
hardware/lepro/lib/lepro/commands.py:109
WHAT IT DOES
Opaque auth token on 0x1102 (no encryption).
SIGNATURE
build_raw_cmd_packet(seq: int, token: bytes) -> bytesPARAMETERS
seq
int
token
bytes
hardware/lepro/lib/lepro/config.py
2 symbols
config_path
No description documented yet.
hardware/lepro/lib/lepro/config.py:51
WHAT IT DOES
No description documented yet.
SIGNATURE
config_path(explicit: Path | None = None) -> PathPARAMETERS
explicit
Path | None
= None
load_config
No description documented yet.
hardware/lepro/lib/lepro/config.py:60
WHAT IT DOES
No description documented yet.
SIGNATURE
load_config(path: Path | None = None) -> LeproLabConfigPARAMETERS
path
Path | None
= None
hardware/lepro/lib/lepro/crypto.py
13 symbols
mac_string_to_bytes
'10:20:BA:31:B2:BA' -> 6 bytes.
hardware/lepro/lib/lepro/crypto.py:42
WHAT IT DOES
'10:20:BA:31:B2:BA' -> 6 bytes.
SIGNATURE
mac_string_to_bytes(mac: str) -> bytesPARAMETERS
mac
str
derive_session_key
Session AES key at le_msg_ctx+0x19 (dpValue, sendWifiMqttInfo, RX decrypt). init_msg() patches bytes [3:7] of the MAC template ke…
hardware/lepro/lib/lepro/crypto.py:50
WHAT IT DOES
Session AES key at le_msg_ctx+0x19 (dpValue, sendWifiMqttInfo, RX decrypt). init_msg() patches bytes [3:7] of the MAC template key with bleInit's rand(). The rand value is also stored in search-hello plaintext field ctx1.
SIGNATURE
derive_session_key(mac: str | bytes, session_rand: int) -> bytesPARAMETERS
mac
str | bytes
session_rand
int
derive_aes_key
Replicate init_msg() key setup for a light MAC. For 10:20:BA:31:B2:BA the key is: 31b2ba3522130ecff4d2525e6c290bf9
hardware/lepro/lib/lepro/crypto.py:62
WHAT IT DOES
Replicate init_msg() key setup for a light MAC. For 10:20:BA:31:B2:BA the key is: 31b2ba3522130ecff4d2525e6c290bf9
SIGNATURE
derive_aes_key(mac: str | bytes) -> bytesPARAMETERS
mac
str | bytes
_lepro_pad
Padding used inside FUN_0x18d244 (le_aes_128_encrypt_cbc core). pad_len = ((len & ~0xF) - len) + 16 Append pad_len bytes each equ…
hardware/lepro/lib/lepro/crypto.py:81
WHAT IT DOES
Padding used inside FUN_0x18d244 (le_aes_128_encrypt_cbc core). pad_len = ((len & ~0xF) - len) + 16 Append pad_len bytes each equal to pad_len.
SIGNATURE
_lepro_pad(data: bytes) -> bytesPARAMETERS
data
bytes
_lepro_unpad
No description documented yet.
hardware/lepro/lib/lepro/crypto.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
_lepro_unpad(data: bytes) -> bytesPARAMETERS
data
bytes
encrypt_cbc
Encrypt with Lepro's CBC + custom padding.
hardware/lepro/lib/lepro/crypto.py:104
WHAT IT DOES
Encrypt with Lepro's CBC + custom padding.
SIGNATURE
encrypt_cbc(plaintext: bytes, key: bytes, iv: bytes = MAIN_IV) -> bytesPARAMETERS
plaintext
bytes
key
bytes
iv
bytes
= MAIN_IV
decrypt_cbc
Decrypt and strip Lepro padding.
hardware/lepro/lib/lepro/crypto.py:112
WHAT IT DOES
Decrypt and strip Lepro padding.
SIGNATURE
decrypt_cbc(ciphertext: bytes, key: bytes, iv: bytes = MAIN_IV) -> bytesPARAMETERS
ciphertext
bytes
key
bytes
iv
bytes
= MAIN_IV
build_search_hello_plaintext
Plaintext for searchDeviceInfo (0x1000) before encryption.
hardware/lepro/lib/lepro/crypto.py:120
WHAT IT DOES
Plaintext for searchDeviceInfo (0x1000) before encryption.
SIGNATURE
build_search_hello_plaintext(ctx0: int = 0, ctx1: int = 0, timestamp: int | None = None) -> bytesPARAMETERS
ctx0
int
= 0
ctx1
int
= 0
timestamp
int | None
= None
encrypt_search_hello
Encrypt a 0x10/0x00 searchDeviceInfo hello (32-byte ciphertext).
hardware/lepro/lib/lepro/crypto.py:132
WHAT IT DOES
Encrypt a 0x10/0x00 searchDeviceInfo hello (32-byte ciphertext).
SIGNATURE
encrypt_search_hello(mac: str | bytes, ctx0: int = 0, ctx1: int = 0, timestamp: int | None = None) -> bytesPARAMETERS
mac
str | bytes
ctx0
int
= 0
ctx1
int
= 0
timestamp
int | None
= None
decrypt_search_hello
Decrypt a 0x10/0x00 hello payload. Returns (magic, ctx0, ctx1, timestamp).
hardware/lepro/lib/lepro/crypto.py:144
WHAT IT DOES
Decrypt a 0x10/0x00 hello payload. Returns (magic, ctx0, ctx1, timestamp).
SIGNATURE
decrypt_search_hello(ciphertext: bytes, mac: str | bytes) -> tuple[bytes, int, int, int]PARAMETERS
ciphertext
bytes
mac
str | bytes
encrypt_bond_request
Encrypt requestBond() plaintext (16-byte ciphertext). After bleInit/search, native code uses the session key (ctx+0x19), not the…
hardware/lepro/lib/lepro/crypto.py:159
WHAT IT DOES
Encrypt requestBond() plaintext (16-byte ciphertext). After bleInit/search, native code uses the session key (ctx+0x19), not the MAC key.
SIGNATURE
encrypt_bond_request(mac: str | bytes, session_rand: int | None = None) -> bytesPARAMETERS
mac
str | bytes
session_rand
int | None
= None
encrypt_dp_json
Encrypt a DP JSON body the same way dpValue()/getDpState() do. Native code passes strlen(json)+1 bytes (includes the NUL). Use se…
hardware/lepro/lib/lepro/crypto.py:172
WHAT IT DOES
Encrypt a DP JSON body the same way dpValue()/getDpState() do. Native code passes strlen(json)+1 bytes (includes the NUL). Use session_rand from search-hello ctx1; MAC-only key is not sufficient.
SIGNATURE
encrypt_dp_json(mac: str | bytes, json_text: str, session_rand: int | None = None, null_terminated: bool = True) -> bytesPARAMETERS
mac
str | bytes
json_text
str
session_rand
int | None
= None
null_terminated
bool
= True
decrypt_dp_json
Decrypt a dpValue/getDpState payload and return UTF-8 JSON text.
hardware/lepro/lib/lepro/crypto.py:196
WHAT IT DOES
Decrypt a dpValue/getDpState payload and return UTF-8 JSON text.
SIGNATURE
decrypt_dp_json(ciphertext: bytes, mac: str | bytes, session_rand: int | None = None) -> strPARAMETERS
ciphertext
bytes
mac
str | bytes
session_rand
int | None
= None
hardware/lepro/lib/lepro/firmware_profile.py
7 symbols
parse_hex
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:61
WHAT IT DOES
No description documented yet.
SIGNATURE
parse_hex(value: str, field: str) -> bytesPARAMETERS
value
str
field
str
_parse_int
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:74
WHAT IT DOES
No description documented yet.
SIGNATURE
_parse_int(value: object, field: str) -> intPARAMETERS
value
object
field
str
_parse_bundle
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:82
WHAT IT DOES
No description documented yet.
SIGNATURE
_parse_bundle(raw: dict, profile_id: str) -> BundleConfigPARAMETERS
raw
dict
profile_id
str
_parse_patch
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:105
WHAT IT DOES
No description documented yet.
SIGNATURE
_parse_patch(raw: dict, profile_id: str, index: int) -> BytePatchPARAMETERS
raw
dict
profile_id
str
index
int
_parse_profile
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:121
WHAT IT DOES
No description documented yet.
SIGNATURE
_parse_profile(raw: dict) -> FirmwareProfilePARAMETERS
raw
dict
load_profiles
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:154
WHAT IT DOES
No description documented yet.
SIGNATURE
load_profiles(path: Path | None = None) -> PatchProfilesPARAMETERS
path
Path | None
= None
resolve_profile
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:175
WHAT IT DOES
No description documented yet.
SIGNATURE
resolve_profile(profiles: PatchProfiles, firmware_path: Path | None = None, profile_id: str | None = None) -> FirmwareProfilePARAMETERS
profiles
PatchProfiles
firmware_path
Path | None
= None
profile_id
str | None
= None
hardware/lepro/lib/lepro/frame.py
6 symbols
_magic_byte
No description documented yet.
hardware/lepro/lib/lepro/frame.py:59
WHAT IT DOES
No description documented yet.
SIGNATURE
_magic_byte(magic: tuple[int, int]) -> intPARAMETERS
magic
tuple[int, int]
_is_fragment_magic
No description documented yet.
hardware/lepro/lib/lepro/frame.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
_is_fragment_magic(magic2: int) -> boolPARAMETERS
magic2
int
parse_ota_start_resp
0x1011 OTA start response. v2.3.18 returns compact big-endian u32 status + u32 offset. Older traces used an 8-byte wrapper with a…
hardware/lepro/lib/lepro/frame.py:238
WHAT IT DOES
0x1011 OTA start response. v2.3.18 returns compact big-endian u32 status + u32 offset. Older traces used an 8-byte wrapper with ackSn/code at +4/+6.
SIGNATURE
parse_ota_start_resp(frame: DecryptedFrame) -> OtaStartResponse | NonePARAMETERS
frame
DecryptedFrame
parse_ota_data_resp
0x1013 per-chunk data response.
hardware/lepro/lib/lepro/frame.py:261
WHAT IT DOES
0x1013 per-chunk data response.
SIGNATURE
parse_ota_data_resp(frame: DecryptedFrame) -> OtaDataResponse | NonePARAMETERS
frame
DecryptedFrame
parse_bond_result
0x1003 / 0xaaaa bond response → uint32 result code (big-endian).
hardware/lepro/lib/lepro/frame.py:275
WHAT IT DOES
0x1003 / 0xaaaa bond response → uint32 result code (big-endian).
SIGNATURE
parse_bond_result(frame: DecryptedFrame) -> int | NonePARAMETERS
frame
DecryptedFrame
load_capture_packets
No description documented yet.
hardware/lepro/lib/lepro/frame.py:285
WHAT IT DOES
No description documented yet.
SIGNATURE
load_capture_packets(path: str | Path | None = None) -> list[bytes]PARAMETERS
path
str | Path | None
= None
hardware/lepro/lib/lepro/modes.py
23 symbols
default_bulb_count
No description documented yet.
hardware/lepro/lib/lepro/modes.py:87
WHAT IT DOES
No description documented yet.
SIGNATURE
default_bulb_count() -> intPARAMETERS
No parameters documented.
hsv_hex
12-char HSV protocol string (Hsv.toProtocolString).
hardware/lepro/lib/lepro/modes.py:94
WHAT IT DOES
12-char HSV protocol string (Hsv.toProtocolString).
SIGNATURE
hsv_hex(hue: float, sat: int = 1000, val: int = 1000) -> strPARAMETERS
hue
float
sat
int
= 1000
val
int
= 1000
rgbic_scene
Segmented / RGB-IC scene mode (d2=2 + d50 + d52).
hardware/lepro/lib/lepro/modes.py:102
WHAT IT DOES
Segmented / RGB-IC scene mode (d2=2 + d50 + d52).
SIGNATURE
rgbic_scene(d50: str, brightness: int = 1000, power: bool = True) -> dict[str, Any]PARAMETERS
d50
str
brightness
int
= 1000
power
bool
= True
white_mode
No description documented yet.
hardware/lepro/lib/lepro/modes.py:114
WHAT IT DOES
No description documented yet.
SIGNATURE
white_mode(brightness: int = 500, temp: int = 400, power: bool = True) -> dict[str, Any]PARAMETERS
brightness
int
= 500
temp
int
= 400
power
bool
= True
legacy_scene_d6
Legacy bulb gradient/rainbow scenes on d6 (EffectEntity dpType=d6).
hardware/lepro/lib/lepro/modes.py:125
WHAT IT DOES
Legacy bulb gradient/rainbow scenes on d6 (EffectEntity dpType=d6).
SIGNATURE
legacy_scene_d6(d6: str, power: bool = True) -> dict[str, Any]PARAMETERS
d6
str
power
bool
= True
scene_gradient
No description documented yet.
hardware/lepro/lib/lepro/modes.py:133
WHAT IT DOES
No description documented yet.
SIGNATURE
scene_gradient(power: bool = True) -> dict[str, Any]PARAMETERS
power
bool
= True
scene_rainbow
No description documented yet.
hardware/lepro/lib/lepro/modes.py:137
WHAT IT DOES
No description documented yet.
SIGNATURE
scene_rainbow(power: bool = True) -> dict[str, Any]PARAMETERS
power
bool
= True
_speed_to_hex
No description documented yet.
hardware/lepro/lib/lepro/modes.py:141
WHAT IT DOES
No description documented yet.
SIGNATURE
_speed_to_hex(speed: int) -> strPARAMETERS
speed
int
_speed_to_hex_center
Center-side native clamps speed_time below 0x41 to 0x40 (diyValueCenterSide).
hardware/lepro/lib/lepro/modes.py:149
WHAT IT DOES
Center-side native clamps speed_time below 0x41 to 0x40 (diyValueCenterSide).
SIGNATURE
_speed_to_hex_center(speed: int) -> strPARAMETERS
speed
int
effect_tail
Six DIY effect tails confirmed in D50_FORMAT.md.
hardware/lepro/lib/lepro/modes.py:158
WHAT IT DOES
Six DIY effect tails confirmed in D50_FORMAT.md.
SIGNATURE
effect_tail(name: str, speed: int = 50) -> strPARAMETERS
name
str
speed
int
= 50
build_d50_flash
Type 9 Flash — no F21 length segment; U3F3 opcode (diyValue case 9, lightMode=1).
hardware/lepro/lib/lepro/modes.py:182
WHAT IT DOES
Type 9 Flash — no F21 length segment; U3F3 opcode (diyValue case 9, lightMode=1).
SIGNATURE
build_d50_flash(color: str, speed: int = 50) -> strPARAMETERS
color
str
speed
int
= 50
build_d50_center_solid
Types 12/13 center-side animation on uniform color (#V:02 + #I00/#I01).
hardware/lepro/lib/lepro/modes.py:191
WHAT IT DOES
Types 12/13 center-side animation on uniform color (#V:02 + #I00/#I01).
SIGNATURE
build_d50_center_solid(color: str, effect: str, speed: int = 50, bulb_count: int | None = None) -> strPARAMETERS
color
str
effect
str
speed
int
= 50
bulb_count
int | None
= None
build_d50_solid
Single-color whole-string d50 (one group, all bulbs same color).
hardware/lepro/lib/lepro/modes.py:218
WHAT IT DOES
Single-color whole-string d50 (one group, all bulbs same color).
SIGNATURE
build_d50_solid(color: str, effect: str = 'Steady', speed: int = 50, bulb_count: int | None = None) -> strPARAMETERS
color
str
effect
str
= 'Steady'
speed
int
= 50
bulb_count
int | None
= None
build_d50_from_leds
Full-string d50 from per-bulb colors.
hardware/lepro/lib/lepro/modes.py:238
WHAT IT DOES
Full-string d50 from per-bulb colors.
SIGNATURE
build_d50_from_leds(leds: list[str | None], effect: str = 'Steady', speed: int = 50, bulb_count: int | None = None) -> strPARAMETERS
leds
list[str | None]
effect
str
= 'Steady'
speed
int
= 50
bulb_count
int | None
= None
diy_solid
No description documented yet.
hardware/lepro/lib/lepro/modes.py:265
WHAT IT DOES
No description documented yet.
SIGNATURE
diy_solid(color: str, effect: str = 'Steady', speed: int = 50, brightness: int = 1000, bulb_count: int | None = None) -> dict[str, Any]PARAMETERS
color
str
effect
str
= 'Steady'
speed
int
= 50
brightness
int
= 1000
bulb_count
int | None
= None
list_presets
No description documented yet.
hardware/lepro/lib/lepro/modes.py:299
WHAT IT DOES
No description documented yet.
SIGNATURE
list_presets(presets_dir: Path | None = None) -> list[Path]PARAMETERS
presets_dir
Path | None
= None
load_preset
Load preset JSON by stem name (e.g. 'hulk').
hardware/lepro/lib/lepro/modes.py:306
WHAT IT DOES
Load preset JSON by stem name (e.g. 'hulk').
SIGNATURE
load_preset(name: str, presets_dir: Path | None = None) -> dict[str, Any]PARAMETERS
name
str
presets_dir
Path | None
= None
preset_frames
Normalize preset to list of frame payloads (each gets d1=1 if missing).
hardware/lepro/lib/lepro/modes.py:322
WHAT IT DOES
Normalize preset to list of frame payloads (each gets d1=1 if missing).
SIGNATURE
preset_frames(preset: dict[str, Any]) -> list[dict[str, Any]]PARAMETERS
preset
dict[str, Any]
preset_duration_ms
No description documented yet.
hardware/lepro/lib/lepro/modes.py:340
WHAT IT DOES
No description documented yet.
SIGNATURE
preset_duration_ms(preset: dict[str, Any], default: int = 4000) -> intPARAMETERS
preset
dict[str, Any]
default
int
= 4000
resolve_mode
Build a single DP payload from a built-in mode id.
hardware/lepro/lib/lepro/modes.py:344
WHAT IT DOES
Build a single DP payload from a built-in mode id.
SIGNATURE
resolve_mode(name: str, **kwargs: Any) -> DpPayloadPARAMETERS
name
str
**kwargs
Any
debug_payload
Return JSON text + encrypted size + estimated BLE page count.
hardware/lepro/lib/lepro/modes.py:375
WHAT IT DOES
Return JSON text + encrypted size + estimated BLE page count.
SIGNATURE
debug_payload(mac: str, payload: DpPayload) -> dict[str, Any]PARAMETERS
mac
str
payload
DpPayload
format_mode_catalog
No description documented yet.
hardware/lepro/lib/lepro/modes.py:401
WHAT IT DOES
No description documented yet.
SIGNATURE
format_mode_catalog() -> strPARAMETERS
No parameters documented.
iter_preset_play
No description documented yet.
hardware/lepro/lib/lepro/modes.py:436
WHAT IT DOES
No description documented yet.
SIGNATURE
iter_preset_play(name: str, **kwargs: Any) -> Iterator[tuple[dict[str, Any], int]]PARAMETERS
name
str
**kwargs
Any
hardware/lepro/lib/lepro/ota.py
41 symbols
wait_ota_frag_ack
Wait for per-fragment ACK with matching seq. Mid-fragment ACKs use magic 0x54; the final fragment ACK uses magic 0x50 (0xAAAA).
hardware/lepro/lib/lepro/ota.py:174
WHAT IT DOES
Wait for per-fragment ACK with matching seq. Mid-fragment ACKs use magic 0x54; the final fragment ACK uses magic 0x50 (0xAAAA).
SIGNATURE
wait_ota_frag_ack(session: LeproSession, seq: int, timeout: float = 5.0) -> DecryptedFramePARAMETERS
session
LeproSession
seq
int
timeout
float
= 5.0
send_ota_packets
Send fragmented OTA op, waiting for a per-fragment ACK after each TX.
hardware/lepro/lib/lepro/ota.py:196
WHAT IT DOES
Send fragmented OTA op, waiting for a per-fragment ACK after each TX.
SIGNATURE
send_ota_packets(session: LeproSession, packets: list[bytes], log: OtaLog, label: str) -> DecryptedFrame | NonePARAMETERS
session
LeproSession
packets
list[bytes]
log
OtaLog
label
str
wait_opcode_verbose
Wait for an opcode, logging heartbeats so a stall is obvious.
hardware/lepro/lib/lepro/ota.py:220
WHAT IT DOES
Wait for an opcode, logging heartbeats so a stall is obvious.
SIGNATURE
wait_opcode_verbose(session: LeproSession, opcode: int, timeout: float, log: OtaLog, label: str, heartbeat: float = 5.0) -> DecryptedFramePARAMETERS
session
LeproSession
opcode
int
timeout
float
log
OtaLog
label
str
heartbeat
float
= 5.0
_write_u16_be
No description documented yet.
hardware/lepro/lib/lepro/ota.py:255
WHAT IT DOES
No description documented yet.
SIGNATURE
_write_u16_be(buf: bytearray, offset: int, value: int) -> NonePARAMETERS
buf
bytearray
offset
int
value
int
_write_u32_be
No description documented yet.
hardware/lepro/lib/lepro/ota.py:259
WHAT IT DOES
No description documented yet.
SIGNATURE
_write_u32_be(buf: bytearray, offset: int, value: int) -> NonePARAMETERS
buf
bytearray
offset
int
value
int
build_ota_start_inner
Legacy 5120-byte plaintext inner buffer (older OTA path: JSON at +8).
hardware/lepro/lib/lepro/ota.py:263
WHAT IT DOES
Legacy 5120-byte plaintext inner buffer (older OTA path: JSON at +8).
SIGNATURE
build_ota_start_inner(json_bytes: bytes) -> bytesPARAMETERS
json_bytes
bytes
build_ota_start_plaintext
v2.3.18 OTA start plaintext: NUL-terminated JSON C string.
hardware/lepro/lib/lepro/ota.py:272
WHAT IT DOES
v2.3.18 OTA start plaintext: NUL-terminated JSON C string.
SIGNATURE
build_ota_start_plaintext(json_bytes: bytes) -> bytesPARAMETERS
json_bytes
bytes
build_ota_chunk_inner
Legacy 5120-byte padded inner buffer (pre-v2.3.18 otaProcess layout).
hardware/lepro/lib/lepro/ota.py:279
WHAT IT DOES
Legacy 5120-byte padded inner buffer (pre-v2.3.18 otaProcess layout).
SIGNATURE
build_ota_chunk_inner(offset: int, chunk: bytes) -> bytesPARAMETERS
offset
int
chunk
bytes
build_ota_chunk_plaintext
v2.3.18 OTA data plaintext: 8-byte header + chunk (FUN_420095d4 expects len+8).
hardware/lepro/lib/lepro/ota.py:291
WHAT IT DOES
v2.3.18 OTA data plaintext: 8-byte header + chunk (FUN_420095d4 expects len+8).
SIGNATURE
build_ota_chunk_plaintext(offset: int, chunk: bytes) -> bytesPARAMETERS
offset
int
chunk
bytes
encrypt_ota_inner
No description documented yet.
hardware/lepro/lib/lepro/ota.py:303
WHAT IT DOES
No description documented yet.
SIGNATURE
encrypt_ota_inner(mac: str, session_rand: int, inner: bytes) -> bytesPARAMETERS
mac
str
session_rand
int
inner
bytes
build_ota_start_packets
No description documented yet.
hardware/lepro/lib/lepro/ota.py:308
WHAT IT DOES
No description documented yet.
SIGNATURE
build_ota_start_packets(mac: str, seq: int, json_bytes: bytes, session_rand: int, max_payload: int = 128) -> tuple[list[bytes], int]PARAMETERS
mac
str
seq
int
json_bytes
bytes
session_rand
int
max_payload
int
= 128
build_ota_chunk_packets
No description documented yet.
hardware/lepro/lib/lepro/ota.py:322
WHAT IT DOES
No description documented yet.
SIGNATURE
build_ota_chunk_packets(mac: str, seq: int, offset: int, chunk: bytes, session_rand: int, max_payload: int = 128) -> tuple[list[bytes], int]PARAMETERS
mac
str
seq
int
offset
int
chunk
bytes
session_rand
int
max_payload
int
= 128
firmware_version_from_path
No description documented yet.
hardware/lepro/lib/lepro/ota.py:337
WHAT IT DOES
No description documented yet.
SIGNATURE
firmware_version_from_path(path: Path) -> str | NonePARAMETERS
path
Path
version_from_discovery
Best-effort running fw semver from discovery notify payload.
hardware/lepro/lib/lepro/ota.py:342
WHAT IT DOES
Best-effort running fw semver from discovery notify payload.
SIGNATURE
version_from_discovery(raw: bytes) -> str | NonePARAMETERS
raw
bytes
_semver_tuple
No description documented yet.
hardware/lepro/lib/lepro/ota.py:362
WHAT IT DOES
No description documented yet.
SIGNATURE
_semver_tuple(version: str) -> tuple[int, int, int]PARAMETERS
version
str
adjust_ota_version_for_running
Bump JSON/embedded version when --reflash and device already reports >= proposed OTA version. Only used when --reflash is set. De…
hardware/lepro/lib/lepro/ota.py:369
WHAT IT DOES
Bump JSON/embedded version when --reflash and device already reports >= proposed OTA version. Only used when --reflash is set. Default BLE OTA sends do_check:0, so the firmware version gate is skipped and this ratchet is not needed.
SIGNATURE
adjust_ota_version_for_running(running: str | None, ota_ver: str, reflash: bool) -> strPARAMETERS
running
str | None
ota_ver
str
reflash
bool
bump_ota_version
Bump PATCH so JSON version differs from running fw_version. FUN_42008eb0 strcmp's running fw against JSON version when do_check=1.
hardware/lepro/lib/lepro/ota.py:385
WHAT IT DOES
Bump PATCH so JSON version differs from running fw_version. FUN_42008eb0 strcmp's running fw against JSON version when do_check=1.
SIGNATURE
bump_ota_version(version: str) -> strPARAMETERS
version
str
resolve_ota_version
No description documented yet.
hardware/lepro/lib/lepro/ota.py:400
WHAT IT DOES
No description documented yet.
SIGNATURE
resolve_ota_version(firmware: Path, version: str | None = None, reflash: bool = False) -> strPARAMETERS
firmware
Path
version
str | None
= None
reflash
bool
= False
firmware_cdn_path
No description documented yet.
hardware/lepro/lib/lepro/ota.py:414
WHAT IT DOES
No description documented yet.
SIGNATURE
firmware_cdn_path(path: Path, version: str | None = None) -> strPARAMETERS
path
Path
version
str | None
= None
md5_hex
No description documented yet.
hardware/lepro/lib/lepro/ota.py:422
WHAT IT DOES
No description documented yet.
SIGNATURE
md5_hex(data: bytes) -> strPARAMETERS
data
bytes
bump_embedded_version
Rewrite fixed-width version strings inside an ESP-IDF app image.
hardware/lepro/lib/lepro/ota.py:426
WHAT IT DOES
Rewrite fixed-width version strings inside an ESP-IDF app image.
SIGNATURE
bump_embedded_version(image: bytearray, old_ver: str, new_ver: str) -> intPARAMETERS
image
bytearray
old_ver
str
new_ver
str
_encode_xtensa_movi_n_a8
Encode `movi.n a8, imm` for non-negative immediates representable in RI7.
hardware/lepro/lib/lepro/ota.py:447
WHAT IT DOES
Encode `movi.n a8, imm` for non-negative immediates representable in RI7.
SIGNATURE
_encode_xtensa_movi_n_a8(value: int) -> bytesPARAMETERS
value
int
_decode_xtensa_movi_n_a8
Decode `movi.n a8, imm`; return None when the bytes are not that instruction.
hardware/lepro/lib/lepro/ota.py:457
WHAT IT DOES
Decode `movi.n a8, imm`; return None when the bytes are not that instruction.
SIGNATURE
_decode_xtensa_movi_n_a8(data: bytes) -> int | NonePARAMETERS
data
bytes
patch_discovery_version
Rewrite the hardcoded 0x1001 device-info semver immediates in the firmware.
hardware/lepro/lib/lepro/ota.py:465
WHAT IT DOES
Rewrite the hardcoded 0x1001 device-info semver immediates in the firmware.
SIGNATURE
patch_discovery_version(image: bytearray, version: str) -> intPARAMETERS
image
bytearray
version
str
repair_esp_app_image
Recalculate ESP-IDF image checksum + validation hash after byte patches.
hardware/lepro/lib/lepro/ota.py:499
WHAT IT DOES
Recalculate ESP-IDF image checksum + validation hash after byte patches.
SIGNATURE
repair_esp_app_image(image: bytearray, chip: str = 'esp32s3') -> NonePARAMETERS
image
bytearray
chip
str
= 'esp32s3'
prepare_ota_image
Load firmware bytes for OTA, optionally bumping embedded strings + discovery semver.
hardware/lepro/lib/lepro/ota.py:514
WHAT IT DOES
Load firmware bytes for OTA, optionally bumping embedded strings + discovery semver.
SIGNATURE
prepare_ota_image(firmware: Path, version: str | None = None, reflash: bool = False, chip: str = 'esp32s3') -> tuple[bytes, str]PARAMETERS
firmware
Path
version
str | None
= None
reflash
bool
= False
chip
str
= 'esp32s3'
build_ota_start_json
Build raw JSON bytes for BLE OTA start (FUN_42008eb0 flat parser).
hardware/lepro/lib/lepro/ota.py:539
WHAT IT DOES
Build raw JSON bytes for BLE OTA start (FUN_42008eb0 flat parser).
SIGNATURE
build_ota_start_json(firmware: Path, image: bytes, version: str, path_version: str | None = None, ota_secret: str = '') -> bytesPARAMETERS
firmware
Path
image
bytes
version
str
path_version
str | None
= None
ota_secret
str
= ''
describe_ota_start_error
Human-readable hint for OTA start response codes.
hardware/lepro/lib/lepro/ota.py:561
WHAT IT DOES
Human-readable hint for OTA start response codes.
SIGNATURE
describe_ota_start_error(code: int) -> strPARAMETERS
code
int
describe_ota_data_error
Human-readable hint for OTA data response codes (0x1013 / FUN_420095d4).
hardware/lepro/lib/lepro/ota.py:578
WHAT IT DOES
Human-readable hint for OTA data response codes (0x1013 / FUN_420095d4).
SIGNATURE
describe_ota_data_error(code: int) -> strPARAMETERS
code
int
classify_ota_verdict
Classify post-reboot discovery into stuck vs rolled back vs reconnect failure.
hardware/lepro/lib/lepro/ota.py:599
WHAT IT DOES
Classify post-reboot discovery into stuck vs rolled back vs reconnect failure.
SIGNATURE
classify_ota_verdict(flashed_ver: str, running_ver: str | None, reconnect_ok: bool) -> OtaConfirmVerdictPARAMETERS
flashed_ver
str
running_ver
str | None
reconnect_ok
bool
report_ota_verdict
Log transfer + confirm outcome and exit non-zero on failure.
hardware/lepro/lib/lepro/ota.py:656
WHAT IT DOES
Log transfer + confirm outcome and exit non-zero on failure.
SIGNATURE
report_ota_verdict(verdict: OtaConfirmVerdict, transfer: OtaTransferResult, log: OtaLog) -> NonePARAMETERS
verdict
OtaConfirmVerdict
transfer
OtaTransferResult
log
OtaLog
check_version_policy
No description documented yet.
hardware/lepro/lib/lepro/ota.py:713
WHAT IT DOES
No description documented yet.
SIGNATURE
check_version_policy(firmware: Path, force: bool) -> NonePARAMETERS
firmware
Path
force
bool
_device_matches
True when a bleak device looks like our target light.
hardware/lepro/lib/lepro/ota.py:722
WHAT IT DOES
True when a bleak device looks like our target light.
SIGNATURE
_device_matches(mac: str, device: object) -> boolPARAMETERS
mac
str
device
object
_find_device_active
Active BLE scan; on macOS prefer name 'LP' (random peripheral UUIDs).
hardware/lepro/lib/lepro/ota.py:732
WHAT IT DOES
Active BLE scan; on macOS prefer name 'LP' (random peripheral UUIDs).
SIGNATURE
_find_device_active(mac: str, log: OtaLog, timeout: float) -> object | NonePARAMETERS
mac
str
log
OtaLog
timeout
float
_watch_for_device
Passive scan until the light advertises or deadline passes.
hardware/lepro/lib/lepro/ota.py:758
WHAT IT DOES
Passive scan until the light advertises or deadline passes.
SIGNATURE
_watch_for_device(mac: str, log: OtaLog, deadline: float) -> object | NonePARAMETERS
mac
str
log
OtaLog
deadline
float
_connect_to_device
No description documented yet.
hardware/lepro/lib/lepro/ota.py:791
WHAT IT DOES
No description documented yet.
SIGNATURE
_connect_to_device(device: object, mac: str, log: OtaLog, debug_rx: bool = False, debug_tx: bool = False) -> tuple[OtaTransport, BleakClient]PARAMETERS
device
object
mac
str
log
OtaLog
debug_rx
bool
= False
debug_tx
bool
= False
_connect
No description documented yet.
hardware/lepro/lib/lepro/ota.py:824
WHAT IT DOES
No description documented yet.
SIGNATURE
_connect(mac: str, log: OtaLog, debug_rx: bool = False, debug_tx: bool = False, scan_timeout: float = 15.0, device: object | None = None) -> tuple[OtaTransport, BleakClient]PARAMETERS
mac
str
log
OtaLog
debug_rx
bool
= False
debug_tx
bool
= False
scan_timeout
float
= 15.0
device
object | None
= None
_confirm_with_discovery
Send discovery (0x1000) to trigger esp_ota_mark_app_valid_cancel_rollback.
hardware/lepro/lib/lepro/ota.py:846
WHAT IT DOES
Send discovery (0x1000) to trigger esp_ota_mark_app_valid_cancel_rollback.
SIGNATURE
_confirm_with_discovery(mac: str, transport: OtaTransport, flashed_ver: str, log: OtaLog) -> OtaConfirmVerdictPARAMETERS
mac
str
transport
OtaTransport
flashed_ver
str
log
OtaLog
run_post_reboot_confirm
Reconnect after OTA reboot and run discovery while image is still PENDING_VERIFY.
hardware/lepro/lib/lepro/ota.py:874
WHAT IT DOES
Reconnect after OTA reboot and run discovery while image is still PENDING_VERIFY.
SIGNATURE
run_post_reboot_confirm(mac: str, flashed_ver: str, log: OtaLog, transfer_finished_at: float | None = None, debug_rx: bool = False, scan_timeout: float = 15.0, wait_s: float = POST_REBOOT_WAIT_S, retry_s: float = POST_REBOOT_RETRY_S, retry_interval_s: float = POST_REBOOT_RETRY_INTERVAL_S) -> OtaConfirmVerdictPARAMETERS
mac
str
flashed_ver
str
log
OtaLog
transfer_finished_at
float | None
= None
debug_rx
bool
= False
scan_timeout
float
= 15.0
wait_s
float
= POST_REBOOT_WAIT_S
retry_s
float
= POST_REBOOT_RETRY_S
retry_interval_s
float
= POST_REBOOT_RETRY_INTERVAL_S
run_ota
No description documented yet.
hardware/lepro/lib/lepro/ota.py:1139
WHAT IT DOES
No description documented yet.
SIGNATURE
run_ota(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
main
No description documented yet.
hardware/lepro/lib/lepro/ota.py:1274
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/patch_cdn.py
20 symbols
apply_byte_patch
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:91
WHAT IT DOES
No description documented yet.
SIGNATURE
apply_byte_patch(fw: bytearray, patch: BytePatch) -> PatchResultPARAMETERS
fw
bytearray
patch
BytePatch
check_byte_patch
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:110
WHAT IT DOES
No description documented yet.
SIGNATURE
check_byte_patch(fw: bytes, patch: BytePatch) -> PatchResultPARAMETERS
fw
bytes
patch
BytePatch
apply_byte_patches
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:124
WHAT IT DOES
No description documented yet.
SIGNATURE
apply_byte_patches(fw: bytearray, patches: Sequence[BytePatch]) -> list[PatchResult]PARAMETERS
fw
bytearray
patches
Sequence[BytePatch]
check_byte_patches
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:128
WHAT IT DOES
No description documented yet.
SIGNATURE
check_byte_patches(fw: bytes, patches: Sequence[BytePatch]) -> list[PatchResult]PARAMETERS
fw
bytes
patches
Sequence[BytePatch]
be16
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:132
WHAT IT DOES
No description documented yet.
SIGNATURE
be16(buf: bytes, off: int) -> intPARAMETERS
buf
bytes
off
int
find_bundle_layout
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:136
WHAT IT DOES
No description documented yet.
SIGNATURE
find_bundle_layout(fw: bytes, bundle: BundleConfig, bundle_off: int | None = None, pin_off: int | None = None, expected_record: bytes | None = None) -> BundleLayoutPARAMETERS
fw
bytes
bundle
BundleConfig
bundle_off
int | None
= None
pin_off
int | None
= None
expected_record
bytes | None
= None
parse_bundle_layout
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:180
WHAT IT DOES
No description documented yet.
SIGNATURE
parse_bundle_layout(fw: bytes, bundle_off: int, bundle: BundleConfig, expected_record: bytes | None = None, expected_entry_off: int | None = None) -> BundleLayoutPARAMETERS
fw
bytes
bundle_off
int
bundle
BundleConfig
expected_record
bytes | None
= None
expected_entry_off
int | None
= None
pem_to_der
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:231
WHAT IT DOES
No description documented yet.
SIGNATURE
pem_to_der(pem_path: Path) -> bytesPARAMETERS
pem_path
Path
parse_host_port
Split "host" or "host:port" (ignoring bracketed IPv6) into (host, port).
hardware/lepro/lib/lepro/patch_cdn.py:239
WHAT IT DOES
Split "host" or "host:port" (ignoring bracketed IPv6) into (host, port).
SIGNATURE
parse_host_port(value: str, default_port: int = DEFAULT_CDN_PORT) -> tuple[str, int]PARAMETERS
value
str
default_port
int
= DEFAULT_CDN_PORT
fetch_cert_der_from_host
Open a TLS connection and return the server leaf certificate as DER.
hardware/lepro/lib/lepro/patch_cdn.py:248
WHAT IT DOES
Open a TLS connection and return the server leaf certificate as DER.
SIGNATURE
fetch_cert_der_from_host(host: str, port: int = DEFAULT_CDN_PORT, connect_host: str | None = None, timeout: float = 10.0) -> bytesPARAMETERS
host
str
port
int
= DEFAULT_CDN_PORT
connect_host
str | None
= None
timeout
float
= 10.0
load_cert_der
Resolve the cert to pin: live from `cert_host` if given, else local PEM.
hardware/lepro/lib/lepro/patch_cdn.py:273
WHAT IT DOES
Resolve the cert to pin: live from `cert_host` if given, else local PEM.
SIGNATURE
load_cert_der(cert_path: Path | None, cert_host: str | None, cert_connect: str | None = None, cert_port: int = DEFAULT_CDN_PORT) -> tuple[bytes, str]PARAMETERS
cert_path
Path | None
cert_host
str | None
cert_connect
str | None
= None
cert_port
int
= DEFAULT_CDN_PORT
build_bundle_record
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:292
WHAT IT DOES
No description documented yet.
SIGNATURE
build_bundle_record(cert_der: bytes) -> tuple[bytes, bytes, bytes]PARAMETERS
cert_der
bytes
split_bundle_record
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:302
WHAT IT DOES
No description documented yet.
SIGNATURE
split_bundle_record(record: bytes, layout: BundleLayout) -> tuple[bytes, bytes]PARAMETERS
record
bytes
layout
BundleLayout
sha256_hex
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:306
WHAT IT DOES
No description documented yet.
SIGNATURE
sha256_hex(data: bytes) -> strPARAMETERS
data
bytes
checksum_off
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:310
WHAT IT DOES
No description documented yet.
SIGNATURE
checksum_off(fw: bytes) -> intPARAMETERS
fw
bytes
repair_esp_app_image
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:316
WHAT IT DOES
No description documented yet.
SIGNATURE
repair_esp_app_image(fw: bytearray, chip: str) -> tuple[int, int, str, str]PARAMETERS
fw
bytearray
chip
str
footer_valid
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:333
WHAT IT DOES
No description documented yet.
SIGNATURE
footer_valid(path: Path, chip: str) -> tuple[bool, str]PARAMETERS
path
Path
chip
str
warn_if_footer_invalid
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:348
WHAT IT DOES
No description documented yet.
SIGNATURE
warn_if_footer_invalid(fw: bytes, chip: str) -> NonePARAMETERS
fw
bytes
chip
str
patch_firmware
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:367
WHAT IT DOES
No description documented yet.
SIGNATURE
patch_firmware(profile: FirmwareProfile, firmware_path: Path, output_path: Path, cert_path: Path | None = None, cert_host: str | None = None, cert_connect: str | None = None, bundle_off: int | None = None, pin_off: int | None = None, verify_only: bool = False, force: bool = False) -> NonePARAMETERS
profile
FirmwareProfile
firmware_path
Path
output_path
Path
cert_path
Path | None
= None
cert_host
str | None
= None
cert_connect
str | None
= None
bundle_off
int | None
= None
pin_off
int | None
= None
verify_only
bool
= False
force
bool
= False
main
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:528
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/paths.py
1 symbols
repo_path
No description documented yet.
hardware/lepro/lib/lepro/paths.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
repo_path(*parts: str) -> PathPARAMETERS
*parts
str
hardware/lepro/lib/lepro/protocol.py
11 symbols
opcode_to_wire
Convert native uint16 opcode to (ptype, subtype) wire bytes.
hardware/lepro/lib/lepro/protocol.py:110
WHAT IT DOES
Convert native uint16 opcode to (ptype, subtype) wire bytes.
SIGNATURE
opcode_to_wire(opcode: int) -> tuple[int, int]PARAMETERS
opcode
int
wire_to_opcode
No description documented yet.
hardware/lepro/lib/lepro/protocol.py:115
WHAT IT DOES
No description documented yet.
SIGNATURE
wire_to_opcode(ptype: int, subtype: int) -> intPARAMETERS
ptype
int
subtype
int
crc16_lepro
Native CRC from le_msg_tx_data_ext (table @ 0x14a758, init=0).
hardware/lepro/lib/lepro/protocol.py:119
WHAT IT DOES
Native CRC from le_msg_tx_data_ext (table @ 0x14a758, init=0).
SIGNATURE
crc16_lepro(data: bytes, init: int = 0) -> intPARAMETERS
data
bytes
init
int
= 0
crc16_ibm
CRC-16/IBM — matches native table for all captured CMD/RSP packets.
hardware/lepro/lib/lepro/protocol.py:127
WHAT IT DOES
CRC-16/IBM — matches native table for all captured CMD/RSP packets.
SIGNATURE
crc16_ibm(data: bytes) -> intPARAMETERS
data
bytes
parse_packet
Parse a captured BLE packet. Returns None if too short.
hardware/lepro/lib/lepro/protocol.py:150
WHAT IT DOES
Parse a captured BLE packet. Returns None if too short.
SIGNATURE
parse_packet(raw: bytes) -> PacketHeader | NonePARAMETERS
raw
bytes
_build_body
No description documented yet.
hardware/lepro/lib/lepro/protocol.py:174
WHAT IT DOES
No description documented yet.
SIGNATURE
_build_body(seq: int, magic2: int, field6: int, field7: int, payload: bytes) -> bytesPARAMETERS
seq
int
magic2
int
field6
int
field7
int
payload
bytes
build_packet
Construct a valid LP-light BLE packet (single 0x5A 0x50 frame).
hardware/lepro/lib/lepro/protocol.py:195
WHAT IT DOES
Construct a valid LP-light BLE packet (single 0x5A 0x50 frame).
SIGNATURE
build_packet(seq: int, ptype: int, subtype: int, payload: bytes) -> bytesPARAMETERS
seq
int
ptype
int
subtype
int
payload
bytes
build_packet_opcode
Build packet from native uint16 opcode.
hardware/lepro/lib/lepro/protocol.py:201
WHAT IT DOES
Build packet from native uint16 opcode.
SIGNATURE
build_packet_opcode(seq: int, opcode: int, payload: bytes) -> bytesPARAMETERS
seq
int
opcode
int
payload
bytes
build_packets_fragmented
Split payload across 0x51/0x52/0x53 frames per le_msg_tx_data_ext. max_payload: max bytes per fragment (native ctx+0x14 MTU chunk…
hardware/lepro/lib/lepro/protocol.py:207
WHAT IT DOES
Split payload across 0x51/0x52/0x53 frames per le_msg_tx_data_ext. max_payload: max bytes per fragment (native ctx+0x14 MTU chunk size).
SIGNATURE
build_packets_fragmented(seq: int, opcode: int, payload: bytes, max_payload: int = 128, encrypted: bool = False) -> list[bytes]PARAMETERS
seq
int
opcode
int
payload
bytes
max_payload
int
= 128
encrypted
bool
= False
verify_packet
Verify the CRC of a captured packet.
hardware/lepro/lib/lepro/protocol.py:273
WHAT IT DOES
Verify the CRC of a captured packet.
SIGNATURE
verify_packet(raw: bytes) -> boolPARAMETERS
raw
bytes
_load_capture_packets
No description documented yet.
hardware/lepro/lib/lepro/protocol.py:300
WHAT IT DOES
No description documented yet.
SIGNATURE
_load_capture_packets(path: str = 'captures.log') -> list[bytes]PARAMETERS
path
str
= 'captures.log'
hardware/lepro/lib/lepro/provision.py
11 symbols
_prov_paths_file
No description documented yet.
hardware/lepro/lib/lepro/provision.py:49
WHAT IT DOES
No description documented yet.
SIGNATURE
_prov_paths_file(mac: str) -> PathPARAMETERS
mac
str
resolve_cert_paths
Return root/cert paths to send in provision JSON. Verified against ZB1 v2.3.18 firmware (ota_state_machine_advance, state 0x2b):…
hardware/lepro/lib/lepro/provision.py:54
WHAT IT DOES
Return root/cert paths to send in provision JSON. Verified against ZB1 v2.3.18 firmware (ota_state_machine_advance, state 0x2b): for each of "root"/"cert" the bulb ARMS its per-resource CDN fetch flag (sentinel 0x5a5a5a5a) only when the NVS key is missing (first provision) OR the path we send is byte-identical to the path already stored in NVS. If the path DIFFERS, the firmware does nothing — it neither updates NVS nor arms a fetch. Resend the exact stored path to re-arm and re-download (e.g. after rotating the cert file at the same CDN URL). On **stock** firmware the HTTPS download still requires onboarding mode (prov_mode 2/3); see prepare_cert_refetch(). On **patched** firmware (`lepro-firmware patch`, default) the prov_mode gate is removed so re-provision with the same paths re-fetches certs on an already-provisioned bulb.
SIGNATURE
resolve_cert_paths(mac: str, root: str, cert: str, update_cert_paths: bool = False) -> tuple[str, str]PARAMETERS
mac
str
root
str
cert
str
update_cert_paths
bool
= False
save_cert_paths
No description documented yet.
hardware/lepro/lib/lepro/provision.py:96
WHAT IT DOES
No description documented yet.
SIGNATURE
save_cert_paths(mac: str, root: str, cert: str) -> NonePARAMETERS
mac
str
root
str
cert
str
prepare_cert_refetch
Re-send requestBond magic before WiFi/MQTT provision. On **stock** ZB1 v2.3.18: requestBond runs ota_state_machine_advance(0x14),…
hardware/lepro/lib/lepro/provision.py:102
WHAT IT DOES
Re-send requestBond magic before WiFi/MQTT provision. On **stock** ZB1 v2.3.18: requestBond runs ota_state_machine_advance(0x14), which bumps prov_mode (ota_ctx+8) to 3 ONLY when it is already 2 or 3. The CDN cert fetch at WiFi-up (state 0x2d) is gated on prov_mode in {2, 3}. prov_mode is decided at boot and is 1 (NORMAL) on an already-provisioned bulb, so requestBond cannot enable cert re-download on stock firmware without a pairing/factory reset. On **patched** firmware (`lepro-firmware patch`) this call is harmless but not required for cert refresh — the prov_mode gate NOP makes state 0x2d always fetch.
SIGNATURE
prepare_cert_refetch(session: LeproSession) -> NonePARAMETERS
session
LeproSession
build_wifi_mqtt_json
No description documented yet.
hardware/lepro/lib/lepro/provision.py:130
WHAT IT DOES
No description documented yet.
SIGNATURE
build_wifi_mqtt_json(ssid: str, password: str, domain: str = DEFAULT_DOMAIN, root: str = DEFAULT_ROOT, cert: str = DEFAULT_CERT, host: str = DEFAULT_HOST, port: str = DEFAULT_PORT, uid: str | None = None) -> strPARAMETERS
ssid
str
password
str
domain
str
= DEFAULT_DOMAIN
root
str
= DEFAULT_ROOT
cert
str
= DEFAULT_CERT
host
str
= DEFAULT_HOST
port
str
= DEFAULT_PORT
uid
str | None
= None
_connect
No description documented yet.
hardware/lepro/lib/lepro/provision.py:155
WHAT IT DOES
No description documented yet.
SIGNATURE
_connect(mac: str, debug_rx: bool = False) -> tuple[BleakTransport, BleakClient]PARAMETERS
mac
str
debug_rx
bool
= False
send_wifi_mqtt
No description documented yet.
hardware/lepro/lib/lepro/provision.py:170
WHAT IT DOES
No description documented yet.
SIGNATURE
send_wifi_mqtt(session: LeproSession, ssid: str, password: str, domain: str, root: str, cert: str, host: str, port: str, uid: str | None, dry_run: bool = False) -> NonePARAMETERS
session
LeproSession
ssid
str
password
str
domain
str
root
str
cert
str
host
str
port
str
uid
str | None
dry_run
bool
= False
cmd_provision
No description documented yet.
hardware/lepro/lib/lepro/provision.py:227
WHAT IT DOES
No description documented yet.
SIGNATURE
cmd_provision(args: argparse.Namespace) -> NonePARAMETERS
args
argparse.Namespace
cmd_provision_with_creds
No description documented yet.
hardware/lepro/lib/lepro/provision.py:276
WHAT IT DOES
No description documented yet.
SIGNATURE
cmd_provision_with_creds(session: LeproSession, creds: BondCredentials, args: argparse.Namespace) -> NonePARAMETERS
session
LeproSession
creds
BondCredentials
args
argparse.Namespace
_resolved_cert_paths
No description documented yet.
hardware/lepro/lib/lepro/provision.py:310
WHAT IT DOES
No description documented yet.
SIGNATURE
_resolved_cert_paths(args: argparse.Namespace, mac: str) -> tuple[str, str]PARAMETERS
args
argparse.Namespace
mac
str
_add_cert_refresh_flags
No description documented yet.
hardware/lepro/lib/lepro/provision.py:321
WHAT IT DOES
No description documented yet.
SIGNATURE
_add_cert_refresh_flags(p: argparse.ArgumentParser) -> NonePARAMETERS
p
argparse.ArgumentParser
hardware/lepro/lib/lepro/session.py
1 symbols
bond_device
No description documented yet.
hardware/lepro/lib/lepro/session.py:401
WHAT IT DOES
No description documented yet.
SIGNATURE
bond_device(session: LeproSession, mac: str, force: bool = False) -> BondCredentialsPARAMETERS
session
LeproSession
mac
str
force
bool
= False
hardware/lepro/lib/lepro/tools/debug_hijack.py
10 symbols
_log
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:45
WHAT IT DOES
No description documented yet.
SIGNATURE
_log(hypothesis_id: str, location: str, message: str, data: dict, run_id: str) -> NonePARAMETERS
hypothesis_id
str
location
str
message
str
data
dict
run_id
str
_pem_der
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:62
WHAT IT DOES
No description documented yet.
SIGNATURE
_pem_der(path: Path) -> bytesPARAMETERS
path
Path
_bundle_record_at
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:69
WHAT IT DOES
No description documented yet.
SIGNATURE
_bundle_record_at(fw: bytes, firmware_path: Path | None = None) -> tuple[object, bytes]PARAMETERS
fw
bytes
firmware_path
Path | None
= None
_fetch_peer_der
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:81
WHAT IT DOES
No description documented yet.
SIGNATURE
_fetch_peer_der(host: str, port: int, connect_host: str | None = None) -> bytesPARAMETERS
host
str
port
int
connect_host
str | None
= None
check_firmware_pin
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
check_firmware_pin(stock: Path, patched: Path | None, cert: Path) -> dictPARAMETERS
stock
Path
patched
Path | None
cert
Path
analyze_pcap
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:155
WHAT IT DOES
No description documented yet.
SIGNATURE
analyze_pcap(pcap: Path) -> dictPARAMETERS
pcap
Path
check_dns
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:238
WHAT IT DOES
No description documented yet.
SIGNATURE
check_dns(host: str) -> dictPARAMETERS
host
str
probe_cdn
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:248
WHAT IT DOES
No description documented yet.
SIGNATURE
probe_cdn() -> dictPARAMETERS
No parameters documented.
probe_mqtt_tls
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:295
WHAT IT DOES
No description documented yet.
SIGNATURE
probe_mqtt_tls() -> dictPARAMETERS
No parameters documented.
main
No description documented yet.
hardware/lepro/lib/lepro/tools/debug_hijack.py:315
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/tools/decrypt_capture.py
3 symbols
_format_plaintext
No description documented yet.
hardware/lepro/lib/lepro/tools/decrypt_capture.py:41
WHAT IT DOES
No description documented yet.
SIGNATURE
_format_plaintext(opcode: int, plain: bytes) -> strPARAMETERS
opcode
int
plain
bytes
decrypt_log
No description documented yet.
hardware/lepro/lib/lepro/tools/decrypt_capture.py:58
WHAT IT DOES
No description documented yet.
SIGNATURE
decrypt_log(path: Path, mac: str, session_filter: str | None = None, opcode_filter: int | None = None) -> NonePARAMETERS
path
Path
mac
str
session_filter
str | None
= None
opcode_filter
int | None
= None
main
No description documented yet.
hardware/lepro/lib/lepro/tools/decrypt_capture.py:109
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py
6 symbols
_align4
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:72
WHAT IT DOES
No description documented yet.
SIGNATURE
_align4(n: int) -> intPARAMETERS
n
int
parse_esp_image
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:76
WHAT IT DOES
No description documented yet.
SIGNATURE
parse_esp_image(data: bytes) -> tuple[int, list[Segment]]PARAMETERS
data
bytes
_build_shstrtab
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:100
WHAT IT DOES
No description documented yet.
SIGNATURE
_build_shstrtab(segments: list[Segment]) -> bytesPARAMETERS
segments
list[Segment]
build_elf
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:108
WHAT IT DOES
No description documented yet.
SIGNATURE
build_elf(entry: int, segments: list[Segment]) -> bytesPARAMETERS
entry
int
segments
list[Segment]
convert
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:220
WHAT IT DOES
No description documented yet.
SIGNATURE
convert(src: Path, dst: Path) -> NonePARAMETERS
src
Path
dst
Path
main
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:237
WHAT IT DOES
No description documented yet.
SIGNATURE
main(argv: list[str] | None = None) -> intPARAMETERS
argv
list[str] | None
= None
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py
7 symbols
_spki_fp
No description documented yet.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:60
WHAT IT DOES
No description documented yet.
SIGNATURE
_spki_fp(cert: x509.Certificate) -> strPARAMETERS
cert
x509.Certificate
_cert_fp
No description documented yet.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:68
WHAT IT DOES
No description documented yet.
SIGNATURE
_cert_fp(cert: x509.Certificate) -> strPARAMETERS
cert
x509.Certificate
_name
No description documented yet.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:72
WHAT IT DOES
No description documented yet.
SIGNATURE
_name(n: x509.Name) -> strPARAMETERS
n
x509.Name
fetch_cdn_body
HTTPS GET of the provisioned root path — the bytes the bulb stores verbatim.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:76
WHAT IT DOES
HTTPS GET of the provisioned root path — the bytes the bulb stores verbatim.
SIGNATURE
fetch_cdn_body(host: str, ip: str, root: str) -> bytesPARAMETERS
host
str
ip
str
root
str
_dechunk
No description documented yet.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:99
WHAT IT DOES
No description documented yet.
SIGNATURE
_dechunk(body: bytes) -> bytesPARAMETERS
body
bytes
fetch_broker_chain
Pull the FULL cert chain the broker presents (leaf first). Python's ssl only exposes the leaf when verification fails (which is e…
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:114
WHAT IT DOES
Pull the FULL cert chain the broker presents (leaf first). Python's ssl only exposes the leaf when verification fails (which is exactly our case), so shell out to `openssl s_client -showcerts` to capture every certificate the server sends, regardless of trust.
SIGNATURE
fetch_broker_chain(host: str, ip: str, port: int) -> list[x509.Certificate]PARAMETERS
host
str
ip
str
port
int
main
No description documented yet.
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py:153
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> intPARAMETERS
No parameters documented.
hardware/lepro/lib/lepro/tools/replay.py
1 symbols
run
No description documented yet.
hardware/lepro/lib/lepro/tools/replay.py:70
WHAT IT DOES
No description documented yet.
SIGNATURE
run(target_mac: str | None)PARAMETERS
target_mac
str | None
hardware/lepro/lib/lepro/tools/validate_ota_parser.py
3 symbols
simulate_parse
Walk the FUN_42008eb0 branch logic symbolically; return failing PC label.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:165
WHAT IT DOES
Walk the FUN_42008eb0 branch logic symbolically; return failing PC label.
SIGNATURE
simulate_parse(obj: dict[str, Any], ctx0: int = 1, running_version: str = '2.3.18') -> strPARAMETERS
obj
dict[str, Any]
ctx0
int
= 1
running_version
str
= '2.3.18'
validate
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:225
WHAT IT DOES
No description documented yet.
SIGNATURE
validate(elf_path: Path) -> intPARAMETERS
elf_path
Path
main
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:287
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/lepro/setup.py
1 symbols
main
No description documented yet.
hardware/lepro/setup.py:284
WHAT IT DOES
No description documented yet.
SIGNATURE
main() -> NonePARAMETERS
No parameters documented.
hardware/web/app.py
3 symbols
home
No description documented yet.
hardware/web/app.py:182
WHAT IT DOES
No description documented yet.
SIGNATURE
home(request: Request)PARAMETERS
request
Request
DECORATORS
dashboard
No description documented yet.
hardware/web/app.py:192
WHAT IT DOES
No description documented yet.
SIGNATURE
dashboard(request: Request)PARAMETERS
request
Request
DECORATORS
chat
No description documented yet.
hardware/web/app.py:207
WHAT IT DOES
No description documented yet.
SIGNATURE
chat(data: dict)PARAMETERS
data
dict
DECORATORS
interfaces/web/app.py
3 symbols
home
No description documented yet.
interfaces/web/app.py:183
WHAT IT DOES
No description documented yet.
SIGNATURE
home(request: Request)PARAMETERS
request
Request
DECORATORS
dashboard
No description documented yet.
interfaces/web/app.py:194
WHAT IT DOES
No description documented yet.
SIGNATURE
dashboard(request: Request)PARAMETERS
request
Request
DECORATORS
chat
No description documented yet.
interfaces/web/app.py:210
WHAT IT DOES
No description documented yet.
SIGNATURE
chat(data: dict)PARAMETERS
data
dict
DECORATORS
main.py
1 symbols
main
No description documented yet.
main.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
main()PARAMETERS
No parameters documented.
memory/memory.py
1 symbols
remember
No description documented yet.
memory/memory.py:61
WHAT IT DOES
No description documented yet.
SIGNATURE
remember(self, user_id, content, category = 'general', importance = 5)PARAMETERS
self
user_id
content
category
= 'general'
importance
= 5
memory/sqlite.py
3 symbols
connect
No description documented yet.
memory/sqlite.py:28
WHAT IT DOES
No description documented yet.
SIGNATURE
connect(db_path = None)PARAMETERS
db_path
= None
ensure_schema
No description documented yet.
memory/sqlite.py:112
WHAT IT DOES
No description documented yet.
SIGNATURE
ensure_schema(conn)PARAMETERS
conn
save_conversation
No description documented yet.
memory/sqlite.py:326
WHAT IT DOES
No description documented yet.
SIGNATURE
save_conversation(conn, user_id, role, message)PARAMETERS
conn
user_id
role
message
test_refactor.py
8 symbols
test_intent_detection
No description documented yet.
test_refactor.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
test_intent_detection()PARAMETERS
No parameters documented.
test_position_query
No description documented yet.
test_refactor.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
test_position_query()PARAMETERS
No parameters documented.
test_list_query
No description documented yet.
test_refactor.py:36
WHAT IT DOES
No description documented yet.
SIGNATURE
test_list_query()PARAMETERS
No parameters documented.
test_search_query_building
No description documented yet.
test_refactor.py:46
WHAT IT DOES
No description documented yet.
SIGNATURE
test_search_query_building()PARAMETERS
No parameters documented.
test_filtering
No description documented yet.
test_refactor.py:58
WHAT IT DOES
No description documented yet.
SIGNATURE
test_filtering()PARAMETERS
No parameters documented.
test_ranking
No description documented yet.
test_refactor.py:76
WHAT IT DOES
No description documented yet.
SIGNATURE
test_ranking()PARAMETERS
No parameters documented.
test_fursuit_query
No description documented yet.
test_refactor.py:98
WHAT IT DOES
No description documented yet.
SIGNATURE
test_fursuit_query()PARAMETERS
No parameters documented.
test_backward_compatibility
No description documented yet.
test_refactor.py:110
WHAT IT DOES
No description documented yet.
SIGNATURE
test_backward_compatibility()PARAMETERS
No parameters documented.
tests/auto_promt_test.py
5 symbols
load_cyn_personality
No description documented yet.
tests/auto_promt_test.py:62
WHAT IT DOES
No description documented yet.
SIGNATURE
load_cyn_personality(files)PARAMETERS
files
loading_animation
No description documented yet.
tests/auto_promt_test.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
loading_animation(stop_event, start_time)PARAMETERS
stop_event
start_time
ask_model
No description documented yet.
tests/auto_promt_test.py:159
WHAT IT DOES
No description documented yet.
SIGNATURE
ask_model(user_prompt, system_prompt)PARAMETERS
user_prompt
system_prompt
generate_tests
No description documented yet.
tests/auto_promt_test.py:323
WHAT IT DOES
No description documented yet.
SIGNATURE
generate_tests()PARAMETERS
No parameters documented.
run_tests
No description documented yet.
tests/auto_promt_test.py:416
WHAT IT DOES
No description documented yet.
SIGNATURE
run_tests()PARAMETERS
No parameters documented.
tests/test_memory_system.py
1 symbols
test_memory_system
Test memory manager and extractor.
tests/test_memory_system.py:18
WHAT IT DOES
Test memory manager and extractor.
SIGNATURE
test_memory_system()PARAMETERS
No parameters documented.
tests/test_prompt_builder.py
1 symbols
test_build_prompt_minimal
No description documented yet.
tests/test_prompt_builder.py:4
WHAT IT DOES
No description documented yet.
SIGNATURE
test_build_prompt_minimal()PARAMETERS
No parameters documented.
tests/verify_refactoring.py
9 symbols
test_prompt_manager
Test PromptManager basic functionality.
tests/verify_refactoring.py:18
WHAT IT DOES
Test PromptManager basic functionality.
SIGNATURE
test_prompt_manager()PARAMETERS
No parameters documented.
test_cyn_personality_preserved
Test that Cyn's core personality is preserved.
tests/verify_refactoring.py:69
WHAT IT DOES
Test that Cyn's core personality is preserved.
SIGNATURE
test_cyn_personality_preserved()PARAMETERS
No parameters documented.
test_key_features_present
Test that all key Cyn features are preserved.
tests/verify_refactoring.py:96
WHAT IT DOES
Test that all key Cyn features are preserved.
SIGNATURE
test_key_features_present()PARAMETERS
No parameters documented.
test_examples_quality
Test that examples are well-formed and diverse.
tests/verify_refactoring.py:127
WHAT IT DOES
Test that examples are well-formed and diverse.
SIGNATURE
test_examples_quality()PARAMETERS
No parameters documented.
test_no_major_duplicates
Test that major duplicates have been removed.
tests/verify_refactoring.py:151
WHAT IT DOES
Test that major duplicates have been removed.
SIGNATURE
test_no_major_duplicates()PARAMETERS
No parameters documented.
test_backwards_compatibility
Test that legacy code still works.
tests/verify_refactoring.py:179
WHAT IT DOES
Test that legacy code still works.
SIGNATURE
test_backwards_compatibility()PARAMETERS
No parameters documented.
test_context_reduction
Test that context usage has been reduced.
tests/verify_refactoring.py:207
WHAT IT DOES
Test that context usage has been reduced.
SIGNATURE
test_context_reduction()PARAMETERS
No parameters documented.
test_mode_independence
Test that modes don't interfere with each other.
tests/verify_refactoring.py:238
WHAT IT DOES
Test that modes don't interfere with each other.
SIGNATURE
test_mode_independence()PARAMETERS
No parameters documented.
run_all_tests
Run all verification tests.
tests/verify_refactoring.py:261
WHAT IT DOES
Run all verification tests.
SIGNATURE
run_all_tests()PARAMETERS
No parameters documented.
tools/SmokeCounterTool.py
13 symbols
get_connection
Open the smoke-counter SQLite database.
tools/SmokeCounterTool.py:47
WHAT IT DOES
Open the smoke-counter SQLite database.
SIGNATURE
get_connection() -> sqlite3.ConnectionPARAMETERS
No parameters documented.
init_db
Create the smoke-session table if it does not already exist.
tools/SmokeCounterTool.py:54
WHAT IT DOES
Create the smoke-session table if it does not already exist.
SIGNATURE
init_db() -> NonePARAMETERS
No parameters documented.
_row_to_session
Convert a SQLite row into the session structure used by CYN.
tools/SmokeCounterTool.py:71
WHAT IT DOES
Convert a SQLite row into the session structure used by CYN.
SIGNATURE
_row_to_session(row: sqlite3.Row) -> Dict[str, Any]PARAMETERS
row
sqlite3.Row
migrate_json_once
Migrate the legacy smoking_log.json into SQLite once. The JSON file is never used as the active source of truth after migration.
tools/SmokeCounterTool.py:85
WHAT IT DOES
Migrate the legacy smoking_log.json into SQLite once. The JSON file is never used as the active source of truth after migration.
SIGNATURE
migrate_json_once() -> NonePARAMETERS
No parameters documented.
log_smoke
Log a smoking session into SQLite. Cigarettes: 1 cigarette = 0.5 units Other types: amount = units directly
tools/SmokeCounterTool.py:173
WHAT IT DOES
Log a smoking session into SQLite. Cigarettes: 1 cigarette = 0.5 units Other types: amount = units directly
SIGNATURE
log_smoke(smoke_type: str, amount: float = 1) -> Dict[str, Any]PARAMETERS
smoke_type
str
amount
float
= 1
normalize_smoke_type
Normalize common aliases to canonical smoke types.
tools/SmokeCounterTool.py:278
WHAT IT DOES
Normalize common aliases to canonical smoke types.
SIGNATURE
normalize_smoke_type(value: Optional[str]) -> Optional[str]PARAMETERS
value
Optional[str]
get_stats
Return smoking statistics directly from SQLite.
tools/SmokeCounterTool.py:310
WHAT IT DOES
Return smoking statistics directly from SQLite.
SIGNATURE
get_stats(smoke_type: Optional[str] = None, scope: str = 'all') -> Dict[str, Any]PARAMETERS
smoke_type
Optional[str]
= None
scope
str
= 'all'
get_recent
Return the most recent smoking sessions from SQLite.
tools/SmokeCounterTool.py:443
WHAT IT DOES
Return the most recent smoking sessions from SQLite.
SIGNATURE
get_recent(limit: int = 10) -> Dict[str, Any]PARAMETERS
limit
int
= 10
get_last
Return the most recently logged session.
tools/SmokeCounterTool.py:488
WHAT IT DOES
Return the most recently logged session.
SIGNATURE
get_last() -> Dict[str, Any]PARAMETERS
No parameters documented.
reset_stats
Completely reset the smoking tracker. This deletes all rows from the SQLite smoke-session table.
tools/SmokeCounterTool.py:525
WHAT IT DOES
Completely reset the smoking tracker. This deletes all rows from the SQLite smoke-session table.
SIGNATURE
reset_stats() -> Dict[str, Any]PARAMETERS
No parameters documented.
repair_aggregates
Return current database-derived statistics. Kept for compatibility with the old API. SQLite is already the source of truth, so no…
tools/SmokeCounterTool.py:556
WHAT IT DOES
Return current database-derived statistics. Kept for compatibility with the old API. SQLite is already the source of truth, so no aggregate repair is necessary.
SIGNATURE
repair_aggregates() -> Dict[str, Any]PARAMETERS
No parameters documented.
smoke_counter_call
Convenience function for CYN's tool registry.
tools/SmokeCounterTool.py:716
WHAT IT DOES
Convenience function for CYN's tool registry.
SIGNATURE
smoke_counter_call(action: str = 'stats', smoke_type: Optional[str] = None, amount: float = 1, limit: int = 10, scope: str = 'all') -> Dict[str, Any]PARAMETERS
action
str
= 'stats'
smoke_type
Optional[str]
= None
amount
float
= 1
limit
int
= 10
scope
str
= 'all'
repair_aggregates
Force-recompute and persist aggregate fields from sessions without changing sessions. Returns the reconciled data dict.
tools/SmokeCounterTool.py:741
WHAT IT DOES
Force-recompute and persist aggregate fields from sessions without changing sessions. Returns the reconciled data dict.
SIGNATURE
repair_aggregates() -> Dict[str, Any]PARAMETERS
No parameters documented.
tools/web_search.py
11 symbols
contains_any
No description documented yet.
tools/web_search.py:424
WHAT IT DOES
No description documented yet.
SIGNATURE
contains_any(text: str, words: Iterable[str]) -> boolPARAMETERS
text
str
words
Iterable[str]
dedupe_terms
No description documented yet.
tools/web_search.py:435
WHAT IT DOES
No description documented yet.
SIGNATURE
dedupe_terms(*groups: Iterable[str]) -> list[str]PARAMETERS
*groups
Iterable[str]
extract_query_tokens
No description documented yet.
tools/web_search.py:456
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_query_tokens(query: str) -> tuple[str, ...]PARAMETERS
query
str
normalize_domain
No description documented yet.
tools/web_search.py:473
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_domain(href: str) -> strPARAMETERS
href
str
detect_research_intent
No description documented yet.
tools/web_search.py:504
WHAT IT DOES
No description documented yet.
SIGNATURE
detect_research_intent(query: str) -> boolPARAMETERS
query
str
detect_output_type
No description documented yet.
tools/web_search.py:531
WHAT IT DOES
No description documented yet.
SIGNATURE
detect_output_type(query: str) -> OutputModePARAMETERS
query
str
build_intent
No description documented yet.
tools/web_search.py:553
WHAT IT DOES
No description documented yet.
SIGNATURE
build_intent(query: str) -> SearchIntentPARAMETERS
query
str
build_search_query
No description documented yet.
tools/web_search.py:817
WHAT IT DOES
No description documented yet.
SIGNATURE
build_search_query(intent: SearchIntent) -> strPARAMETERS
intent
SearchIntent
classify_source
No description documented yet.
tools/web_search.py:1149
WHAT IT DOES
No description documented yet.
SIGNATURE
classify_source(href: str) -> strPARAMETERS
href
str
fetch_page_text
Fetch the actual webpage and extract readable text. This is intentionally lightweight. Search snippets remain the fallback when a…
tools/web_search.py:1184
WHAT IT DOES
Fetch the actual webpage and extract readable text. This is intentionally lightweight. Search snippets remain the fallback when a page cannot be retrieved.
SIGNATURE
fetch_page_text(href: str, max_chars: int = 8000) -> strPARAMETERS
href
str
max_chars
int
= 8000
extract_relevant_evidence
Pulls passages that appear relevant to the query. This is deliberately conservative. It does not invent summaries; it returns sou…
tools/web_search.py:1314
WHAT IT DOES
Pulls passages that appear relevant to the query. This is deliberately conservative. It does not invent summaries; it returns source text surrounding matching terms.
SIGNATURE
extract_relevant_evidence(text: str, query: str, max_chars: int = 3500) -> strPARAMETERS
text
str
query
str
max_chars
int
= 3500
ai/chat_engine.py · ChatEngine
6 symbols
__init__
No description documented yet.
ai/chat_engine.py:50
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, ollama_client, prompt_builder, memory_store, tool_router, mode_manager, memory_manager: Optional[MemoryManager] = None, memory_extractor: Optional[MemoryExtractor] = None, context_manager = None, logger_obj = None)PARAMETERS
self
ollama_client
prompt_builder
memory_store
tool_router
mode_manager
memory_manager
Optional[MemoryManager]
= None
memory_extractor
Optional[MemoryExtractor]
= None
context_manager
= None
logger_obj
= None
trim_context
No description documented yet.
ai/chat_engine.py:98
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_context(self, text: str, limit: int) -> strPARAMETERS
self
text
str
limit
int
_estimate_message_tokens
Roughly estimate tokens in an Ollama message. This is intentionally conservative. Actual tokenization is model-dependent, so the…
ai/chat_engine.py:116
WHAT IT DOES
Roughly estimate tokens in an Ollama message. This is intentionally conservative. Actual tokenization is model-dependent, so the final context budget keeps headroom.
SIGNATURE
_estimate_message_tokens(self, message) -> intPARAMETERS
self
message
_trim_ollama_messages
Prevent Ollama requests from exceeding the available context. Priority: 1. System prompt 2. Current user message 3. Tool results…
ai/chat_engine.py:149
WHAT IT DOES
Prevent Ollama requests from exceeding the available context. Priority: 1. System prompt 2. Current user message 3. Tool results required for the current response 4. Newest conversation history 5. Older conversation history The current user message is never intentionally removed.
SIGNATURE
_trim_ollama_messages(self, messages, max_tokens: int = OLLAMA_PROMPT_BUDGET)PARAMETERS
self
messages
max_tokens
int
= OLLAMA_PROMPT_BUDGET
_ollama_tools
No description documented yet.
ai/chat_engine.py:471
WHAT IT DOES
No description documented yet.
SIGNATURE
_ollama_tools(self, user_text: str = '')PARAMETERS
self
user_text
str
= ''
handle_user_message
Process a user message. Flow: 1. Retrieve relevant context 2. Build Cyn prompt 3. Detect tools 4. Execute tools 5. Generate respo…
ai/chat_engine.py:501
WHAT IT DOES
Process a user message. Flow: 1. Retrieve relevant context 2. Build Cyn prompt 3. Detect tools 4. Execute tools 5. Generate response 6. Extract memories 7. Save conversation info
SIGNATURE
handle_user_message(self, user_id: str, text: str, mode: str = 'normal', personality: str = 'normal', request_id: Optional[str] = None) -> strPARAMETERS
self
user_id
str
text
str
mode
str
= 'normal'
personality
str
= 'normal'
request_id
Optional[str]
= None
ai/context_manager.py · ContextManager
2 symbols
__init__
No description documented yet.
ai/context_manager.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, memory_store, knowledge_store)PARAMETERS
self
memory_store
knowledge_store
build_context
No description documented yet.
ai/context_manager.py:27
WHAT IT DOES
No description documented yet.
SIGNATURE
build_context(self, user_id, user_message)PARAMETERS
self
user_id
user_message
ai/knowledge/store.py · KnowledgeStore
4 symbols
__init__
No description documented yet.
ai/knowledge/store.py:7
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
add
No description documented yet.
ai/knowledge/store.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
add(self, content, title = '', category = 'general', importance = 5, tags = None)PARAMETERS
self
content
title
= ''
category
= 'general'
importance
= 5
tags
= None
search
No description documented yet.
ai/knowledge/store.py:68
WHAT IT DOES
No description documented yet.
SIGNATURE
search(self, query, limit = 5)PARAMETERS
self
query
limit
= 5
recent
No description documented yet.
ai/knowledge/store.py:156
WHAT IT DOES
No description documented yet.
SIGNATURE
recent(self, limit = 10)PARAMETERS
self
limit
= 10
ai/memory_system/extractor.py · MemoryExtractor
10 symbols
__init__
No description documented yet.
ai/memory_system/extractor.py:30
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, memory_store)PARAMETERS
self
memory_store
extract_and_save
No description documented yet.
ai/memory_system/extractor.py:49
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_and_save(self, user_id: str, user_message: str, assistant_response: str = '') -> List[int]PARAMETERS
self
user_id
str
user_message
str
assistant_response
str
= ''
extract_preferences
No description documented yet.
ai/memory_system/extractor.py:292
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_preferences(self, text)PARAMETERS
self
text
extract_goals
No description documented yet.
ai/memory_system/extractor.py:328
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_goals(self, text)PARAMETERS
self
text
extract_projects
No description documented yet.
ai/memory_system/extractor.py:365
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_projects(self, text)PARAMETERS
self
text
extract_names
No description documented yet.
ai/memory_system/extractor.py:402
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_names(self, text)PARAMETERS
self
text
extract_style
No description documented yet.
ai/memory_system/extractor.py:442
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_style(self, text)PARAMETERS
self
text
match_patterns
No description documented yet.
ai/memory_system/extractor.py:488
WHAT IT DOES
No description documented yet.
SIGNATURE
match_patterns(self, patterns, text, prefix)PARAMETERS
self
patterns
text
prefix
meaningful
No description documented yet.
ai/memory_system/extractor.py:548
WHAT IT DOES
No description documented yet.
SIGNATURE
meaningful(self, text)PARAMETERS
self
text
should_save
No description documented yet.
ai/memory_system/extractor.py:577
WHAT IT DOES
No description documented yet.
SIGNATURE
should_save(self, content)PARAMETERS
self
content
ai/memory_system/manager.py · MemoryManager
9 symbols
__init__
No description documented yet.
ai/memory_system/manager.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
remember
No description documented yet.
ai/memory_system/manager.py:62
WHAT IT DOES
No description documented yet.
SIGNATURE
remember(self, user_id, content, category = 'general', importance = 5)PARAMETERS
self
user_id
content
category
= 'general'
importance
= 5
recall
No description documented yet.
ai/memory_system/manager.py:160
WHAT IT DOES
No description documented yet.
SIGNATURE
recall(self, user_id, limit = 5, min_importance = 1, categories = None)PARAMETERS
self
user_id
limit
= 5
min_importance
= 1
categories
= None
search
No description documented yet.
ai/memory_system/manager.py:265
WHAT IT DOES
No description documented yet.
SIGNATURE
search(self, user_id, query, limit = 5)PARAMETERS
self
user_id
query
limit
= 5
get_all_memories
No description documented yet.
ai/memory_system/manager.py:368
WHAT IT DOES
No description documented yet.
SIGNATURE
get_all_memories(self, user_id)PARAMETERS
self
user_id
recent
No description documented yet.
ai/memory_system/manager.py:424
WHAT IT DOES
No description documented yet.
SIGNATURE
recent(self, limit = 10)PARAMETERS
self
limit
= 10
delete_memory
No description documented yet.
ai/memory_system/manager.py:472
WHAT IT DOES
No description documented yet.
SIGNATURE
delete_memory(self, memory_id)PARAMETERS
self
memory_id
update_memory
No description documented yet.
ai/memory_system/manager.py:522
WHAT IT DOES
No description documented yet.
SIGNATURE
update_memory(self, memory_id, importance = None, content = None)PARAMETERS
self
memory_id
importance
= None
content
= None
format_for_prompt
No description documented yet.
ai/memory_system/manager.py:598
WHAT IT DOES
No description documented yet.
SIGNATURE
format_for_prompt(self, memories)PARAMETERS
self
memories
ai/mode_manager.py · ModeSpec
1 symbols
__init__
No description documented yet.
ai/mode_manager.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, name: str, allowed_tools: List[str] = None, instruction_fragment: str = '')PARAMETERS
self
name
str
allowed_tools
List[str]
= None
instruction_fragment
str
= ''
ai/mode_manager.py · ModeManager
4 symbols
__init__
No description documented yet.
ai/mode_manager.py:21
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
_init_default_modes
No description documented yet.
ai/mode_manager.py:25
WHAT IT DOES
No description documented yet.
SIGNATURE
_init_default_modes(self)PARAMETERS
self
get_mode
No description documented yet.
ai/mode_manager.py:100
WHAT IT DOES
No description documented yet.
SIGNATURE
get_mode(self, name: str) -> ModeSpecPARAMETERS
self
name
str
allowed_tools_for
No description documented yet.
ai/mode_manager.py:106
WHAT IT DOES
No description documented yet.
SIGNATURE
allowed_tools_for(self, name: str)PARAMETERS
self
name
str
ai/ollama_client.py · OllamaClient
4 symbols
__init__
No description documented yet.
ai/ollama_client.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, base_url: str = 'http://localhost:11434', model: str = 'cyn-x:latest', timeout: int = 600)PARAMETERS
self
base_url
str
= 'http://localhost:11434'
model
str
= 'cyn-x:latest'
timeout
int
= 600
generate
No description documented yet.
ai/ollama_client.py:30
WHAT IT DOES
No description documented yet.
SIGNATURE
generate(self, prompt: str, max_tokens: int = 512, stream: bool = False, **kwargs) -> Dict[str, Any]PARAMETERS
self
prompt
str
max_tokens
int
= 512
stream
bool
= False
**kwargs
chat
Call Ollama's chat endpoint with optional tools.
ai/ollama_client.py:102
WHAT IT DOES
Call Ollama's chat endpoint with optional tools.
SIGNATURE
chat(self, messages: List[Dict[str, Any]], tools: Optional[List[Dict[str, Any]]] = None, stream: bool = False, **kwargs) -> Dict[str, Any]PARAMETERS
self
messages
List[Dict[str, Any]]
tools
Optional[List[Dict[str, Any]]]
= None
stream
bool
= False
**kwargs
generate_stream
No description documented yet.
ai/ollama_client.py:304
WHAT IT DOES
No description documented yet.
SIGNATURE
generate_stream(self, prompt: str, max_tokens: int = 512, **kwargs) -> Generator[str, None, None]PARAMETERS
self
prompt
str
max_tokens
int
= 512
**kwargs
ai/prompt_builder.py · PromptBuilder
12 symbols
__init__
No description documented yet.
ai/prompt_builder.py:226
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, templates_dir: Optional[str] = None)PARAMETERS
self
templates_dir
Optional[str]
= None
normalize_prompt_layers
No description documented yet.
ai/prompt_builder.py:244
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_prompt_layers(self, prompt_layers: Optional[Dict[str, bool]] = None) -> Dict[str, bool]PARAMETERS
self
prompt_layers
Optional[Dict[str, bool]]
= None
set_prompt_layers
No description documented yet.
ai/prompt_builder.py:266
WHAT IT DOES
No description documented yet.
SIGNATURE
set_prompt_layers(self, prompt_layers: Optional[Dict[str, bool]] = None) -> Dict[str, bool]PARAMETERS
self
prompt_layers
Optional[Dict[str, bool]]
= None
get_prompt_layers
No description documented yet.
ai/prompt_builder.py:282
WHAT IT DOES
No description documented yet.
SIGNATURE
get_prompt_layers(self) -> Dict[str, bool]PARAMETERS
self
apply_prompt_preset
No description documented yet.
ai/prompt_builder.py:291
WHAT IT DOES
No description documented yet.
SIGNATURE
apply_prompt_preset(self, preset: str) -> Dict[str, bool]PARAMETERS
self
preset
str
trim_context
No description documented yet.
ai/prompt_builder.py:311
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_context(self, text: str, limit: int) -> strPARAMETERS
self
text
str
limit
int
should_include_context
No description documented yet.
ai/prompt_builder.py:339
WHAT IT DOES
No description documented yet.
SIGNATURE
should_include_context(self, text: str) -> boolPARAMETERS
self
text
str
score_context
No description documented yet.
ai/prompt_builder.py:360
WHAT IT DOES
No description documented yet.
SIGNATURE
score_context(self, chunk: str, query: str) -> intPARAMETERS
self
chunk
str
query
str
select_context
No description documented yet.
ai/prompt_builder.py:397
WHAT IT DOES
No description documented yet.
SIGNATURE
select_context(self, chunks: List[str], query: str, limit: int) -> strPARAMETERS
self
chunks
List[str]
query
str
limit
int
build_system_prompt
No description documented yet.
ai/prompt_builder.py:472
WHAT IT DOES
No description documented yet.
SIGNATURE
build_system_prompt(self, modes: Optional[List[str]] = None, memory: str = '', context: str = '', prompt_layers: Optional[Dict[str, bool]] = None) -> strPARAMETERS
self
modes
Optional[List[str]]
= None
memory
str
= ''
context
str
= ''
prompt_layers
Optional[Dict[str, bool]]
= None
budget_context
No description documented yet.
ai/prompt_builder.py:551
WHAT IT DOES
No description documented yet.
SIGNATURE
budget_context(self, sections: List[Dict[str, Any]]) -> List[str]PARAMETERS
self
sections
List[Dict[str, Any]]
build_prompt
No description documented yet.
ai/prompt_builder.py:688
WHAT IT DOES
No description documented yet.
SIGNATURE
build_prompt(self, user_input: str, mode_fragment: str = '', personality_fragment: str = '', history: Optional[List[dict]] = None, memory_summary: str = '', knowledge_context: str = '', tools_spec: str = '', intent: str = '', conversation_summary: str = '', prompt_layers: Optional[Dict[str, bool]] = None) -> strPARAMETERS
self
user_input
str
mode_fragment
str
= ''
personality_fragment
str
= ''
history
Optional[List[dict]]
= None
memory_summary
str
= ''
knowledge_context
str
= ''
tools_spec
str
= ''
intent
str
= ''
conversation_summary
str
= ''
prompt_layers
Optional[Dict[str, bool]]
= None
ai/prompt_manager.py · PromptManager
10 symbols
__init__
No description documented yet.
ai/prompt_manager.py:97
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, prompts_dir: Optional[str] = None)PARAMETERS
self
prompts_dir
Optional[str]
= None
normalize_prompt_layers
No description documented yet.
ai/prompt_manager.py:151
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_prompt_layers(self, enabled_layers = None)PARAMETERS
self
enabled_layers
= None
_load_file
No description documented yet.
ai/prompt_manager.py:182
WHAT IT DOES
No description documented yet.
SIGNATURE
_load_file(self, path: Path)PARAMETERS
self
path
Path
trim_text
No description documented yet.
ai/prompt_manager.py:220
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_text(self, text, limit)PARAMETERS
self
text
limit
load_core_prompts
No description documented yet.
ai/prompt_manager.py:254
WHAT IT DOES
No description documented yet.
SIGNATURE
load_core_prompts(self)PARAMETERS
self
load_personality_matrix
No description documented yet.
ai/prompt_manager.py:364
WHAT IT DOES
No description documented yet.
SIGNATURE
load_personality_matrix(self)PARAMETERS
self
load_optional
No description documented yet.
ai/prompt_manager.py:408
WHAT IT DOES
No description documented yet.
SIGNATURE
load_optional(self, name)PARAMETERS
self
name
load_option
No description documented yet.
ai/prompt_manager.py:441
WHAT IT DOES
No description documented yet.
SIGNATURE
load_option(self, name)PARAMETERS
self
name
load_mode
No description documented yet.
ai/prompt_manager.py:474
WHAT IT DOES
No description documented yet.
SIGNATURE
load_mode(self, mode_name)PARAMETERS
self
mode_name
build_system_prompt
No description documented yet.
ai/prompt_manager.py:519
WHAT IT DOES
No description documented yet.
SIGNATURE
build_system_prompt(self, active_modes = None, active_options = None, memory_summary = '', additional_context = '', include_safety = True, enabled_layers = None)PARAMETERS
self
active_modes
= None
active_options
= None
memory_summary
= ''
additional_context
= ''
include_safety
= True
enabled_layers
= None
ai/terminal_ui/renderer.py · CYNXTerminal
22 symbols
__init__
No description documented yet.
ai/terminal_ui/renderer.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
_print_label
No description documented yet.
ai/terminal_ui/renderer.py:40
WHAT IT DOES
No description documented yet.
SIGNATURE
_print_label(self, label, value = None, style, value_style = 'white')PARAMETERS
self
label
value
= None
style
value_style
= 'white'
section
No description documented yet.
ai/terminal_ui/renderer.py:48
WHAT IT DOES
No description documented yet.
SIGNATURE
section(self, title)PARAMETERS
self
title
info
No description documented yet.
ai/terminal_ui/renderer.py:51
WHAT IT DOES
No description documented yet.
SIGNATURE
info(self, message)PARAMETERS
self
message
memory
No description documented yet.
ai/terminal_ui/renderer.py:54
WHAT IT DOES
No description documented yet.
SIGNATURE
memory(self, message)PARAMETERS
self
message
warning
No description documented yet.
ai/terminal_ui/renderer.py:57
WHAT IT DOES
No description documented yet.
SIGNATURE
warning(self, message)PARAMETERS
self
message
error
No description documented yet.
ai/terminal_ui/renderer.py:60
WHAT IT DOES
No description documented yet.
SIGNATURE
error(self, message)PARAMETERS
self
message
dim
No description documented yet.
ai/terminal_ui/renderer.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
dim(self, message)PARAMETERS
self
message
user
No description documented yet.
ai/terminal_ui/renderer.py:66
WHAT IT DOES
No description documented yet.
SIGNATURE
user(self, message)PARAMETERS
self
message
ollama
No description documented yet.
ai/terminal_ui/renderer.py:69
WHAT IT DOES
No description documented yet.
SIGNATURE
ollama(self, label = 'OLLAMA CALL', value = None)PARAMETERS
self
label
= 'OLLAMA CALL'
value
= None
model
No description documented yet.
ai/terminal_ui/renderer.py:72
WHAT IT DOES
No description documented yet.
SIGNATURE
model(self, label = 'MODEL RESPONSE', value = None)PARAMETERS
self
label
= 'MODEL RESPONSE'
value
= None
tool
No description documented yet.
ai/terminal_ui/renderer.py:75
WHAT IT DOES
No description documented yet.
SIGNATURE
tool(self, label = 'TOOL CALL', value = None)PARAMETERS
self
label
= 'TOOL CALL'
value
= None
tool_args
No description documented yet.
ai/terminal_ui/renderer.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
tool_args(self, label = 'TOOL ARGUMENTS', value = None)PARAMETERS
self
label
= 'TOOL ARGUMENTS'
value
= None
execute
No description documented yet.
ai/terminal_ui/renderer.py:81
WHAT IT DOES
No description documented yet.
SIGNATURE
execute(self, label = 'EXECUTING TOOL', value = None)PARAMETERS
self
label
= 'EXECUTING TOOL'
value
= None
result
No description documented yet.
ai/terminal_ui/renderer.py:84
WHAT IT DOES
No description documented yet.
SIGNATURE
result(self, label = 'TOOL RESULT', value = None)PARAMETERS
self
label
= 'TOOL RESULT'
value
= None
prompt
No description documented yet.
ai/terminal_ui/renderer.py:87
WHAT IT DOES
No description documented yet.
SIGNATURE
prompt(self, label = 'PROMPT SECTION', value = None)PARAMETERS
self
label
= 'PROMPT SECTION'
value
= None
final_prompt
No description documented yet.
ai/terminal_ui/renderer.py:90
WHAT IT DOES
No description documented yet.
SIGNATURE
final_prompt(self, label = 'FINAL SYSTEM PROMPT', value = None)PARAMETERS
self
label
= 'FINAL SYSTEM PROMPT'
value
= None
available_tools
No description documented yet.
ai/terminal_ui/renderer.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
available_tools(self, tools)PARAMETERS
self
tools
json
No description documented yet.
ai/terminal_ui/renderer.py:96
WHAT IT DOES
No description documented yet.
SIGNATURE
json(self, payload)PARAMETERS
self
payload
timing
No description documented yet.
ai/terminal_ui/renderer.py:102
WHAT IT DOES
No description documented yet.
SIGNATURE
timing(self, message)PARAMETERS
self
message
memory_error
No description documented yet.
ai/terminal_ui/renderer.py:105
WHAT IT DOES
No description documented yet.
SIGNATURE
memory_error(self, message)PARAMETERS
self
message
blank
No description documented yet.
ai/terminal_ui/renderer.py:108
WHAT IT DOES
No description documented yet.
SIGNATURE
blank(self)PARAMETERS
self
barkly_docs.py · FunctionInfo
2 symbols
qualified_name
No description documented yet.
barkly_docs.py:146
WHAT IT DOES
No description documented yet.
SIGNATURE
qualified_name(self) -> strPARAMETERS
self
DECORATORS
signature
No description documented yet.
barkly_docs.py:152
WHAT IT DOES
No description documented yet.
SIGNATURE
signature(self) -> strPARAMETERS
self
DECORATORS
barkly_docs.py · EndpointInfo
1 symbols
method_text
No description documented yet.
barkly_docs.py:202
WHAT IT DOES
No description documented yet.
SIGNATURE
method_text(self) -> strPARAMETERS
self
DECORATORS
barkly_docs.py · PythonScanner
7 symbols
__init__
No description documented yet.
barkly_docs.py:592
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, root: Path)PARAMETERS
self
root
Path
scan
No description documented yet.
barkly_docs.py:600
WHAT IT DOES
No description documented yet.
SIGNATURE
scan(self) -> NonePARAMETERS
self
scan_file
No description documented yet.
barkly_docs.py:607
WHAT IT DOES
No description documented yet.
SIGNATURE
scan_file(self, path: Path) -> NonePARAMETERS
self
path
Path
function_node_for_class_method
No description documented yet.
barkly_docs.py:665
WHAT IT DOES
No description documented yet.
SIGNATURE
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]PARAMETERS
self
class_node
ast.ClassDef
method_name
str
make_function
No description documented yet.
barkly_docs.py:680
WHAT IT DOES
No description documented yet.
SIGNATURE
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfoPARAMETERS
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
make_class
No description documented yet.
barkly_docs.py:699
WHAT IT DOES
No description documented yet.
SIGNATURE
make_class(self, node: ast.ClassDef, file: str) -> ClassInfoPARAMETERS
self
node
ast.ClassDef
file
str
find_endpoints
No description documented yet.
barkly_docs.py:729
WHAT IT DOES
No description documented yet.
SIGNATURE
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> NonePARAMETERS
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
benchmark/cleaner.py · BenchmarkCleaner
8 symbols
__init__
No description documented yet.
benchmark/cleaner.py:99
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, execute: bool = False, remove_temp: bool = False)PARAMETERS
self
execute
bool
= False
remove_temp
bool
= False
show_delete
No description documented yet.
benchmark/cleaner.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
show_delete(self, path: Path)PARAMETERS
self
path
Path
is_protected
No description documented yet.
benchmark/cleaner.py:150
WHAT IT DOES
No description documented yet.
SIGNATURE
is_protected(self, path: Path) -> boolPARAMETERS
self
path
Path
clean_results
No description documented yet.
benchmark/cleaner.py:210
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_results(self)PARAMETERS
self
clean_temp_files
No description documented yet.
benchmark/cleaner.py:255
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_temp_files(self)PARAMETERS
self
clean_empty_directories
No description documented yet.
benchmark/cleaner.py:304
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_empty_directories(self)PARAMETERS
self
print_protected_info
No description documented yet.
benchmark/cleaner.py:361
WHAT IT DOES
No description documented yet.
SIGNATURE
print_protected_info(self)PARAMETERS
self
summary
No description documented yet.
benchmark/cleaner.py:393
WHAT IT DOES
No description documented yet.
SIGNATURE
summary(self)PARAMETERS
self
benchmark/runner.py · BenchmarkStorage
5 symbols
__init__
No description documented yet.
benchmark/runner.py:754
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
save_test
No description documented yet.
benchmark/runner.py:775
WHAT IT DOES
No description documented yet.
SIGNATURE
save_test(self, result)PARAMETERS
self
result
add
No description documented yet.
benchmark/runner.py:950
WHAT IT DOES
No description documented yet.
SIGNATURE
add(self, result)PARAMETERS
self
result
save_raw
No description documented yet.
benchmark/runner.py:967
WHAT IT DOES
No description documented yet.
SIGNATURE
save_raw(self)PARAMETERS
self
save_summary
No description documented yet.
benchmark/runner.py:1034
WHAT IT DOES
No description documented yet.
SIGNATURE
save_summary(self)PARAMETERS
self
hardware/lepro/config.py · LeproConfig
6 symbols
__init__
No description documented yet.
hardware/lepro/config.py:11
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, path: Path) -> NonePARAMETERS
self
path
Path
load
No description documented yet.
hardware/lepro/config.py:14
WHAT IT DOES
No description documented yet.
SIGNATURE
load(self) -> dict[str, Any]PARAMETERS
self
save
No description documented yet.
hardware/lepro/config.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
save(self, data: dict[str, Any]) -> NonePARAMETERS
self
data
dict[str, Any]
add_device
No description documented yet.
hardware/lepro/config.py:42
WHAT IT DOES
No description documented yet.
SIGNATURE
add_device(self, name: str, mac: str, device_type: str = 'lepro', discovered_name: str | None = None) -> dict[str, Any]PARAMETERS
self
name
str
mac
str
device_type
str
= 'lepro'
discovered_name
str | None
= None
get_device
No description documented yet.
hardware/lepro/config.py:68
WHAT IT DOES
No description documented yet.
SIGNATURE
get_device(self, name: str) -> dict[str, Any] | NonePARAMETERS
self
name
str
list_devices
No description documented yet.
hardware/lepro/config.py:75
WHAT IT DOES
No description documented yet.
SIGNATURE
list_devices(self) -> list[dict[str, Any]]PARAMETERS
self
hardware/lepro/devices.py · LeproDevice
11 symbols
__init__
No description documented yet.
hardware/lepro/devices.py:29
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, name: str, mac: str)PARAMETERS
self
name
str
mac
str
has_credentials
Return True if this device has been bonded.
hardware/lepro/devices.py:37
WHAT IT DOES
Return True if this device has been bonded.
SIGNATURE
has_credentials(self) -> boolPARAMETERS
self
credential_path
Return the path where Lepro stores this device's credentials.
hardware/lepro/devices.py:41
WHAT IT DOES
Return the path where Lepro stores this device's credentials.
SIGNATURE
credential_path(self)PARAMETERS
self
connect
Connect to the physical Lepro device.
hardware/lepro/devices.py:49
WHAT IT DOES
Connect to the physical Lepro device.
SIGNATURE
connect(self)PARAMETERS
self
bond
Bond this device with CYN-X.
hardware/lepro/devices.py:57
WHAT IT DOES
Bond this device with CYN-X.
SIGNATURE
bond(self, force: bool = False) -> AnyPARAMETERS
self
force
bool
= False
_run_control
Send a datapoint control payload to the device.
hardware/lepro/devices.py:80
WHAT IT DOES
Send a datapoint control payload to the device.
SIGNATURE
_run_control(self, payload: dict[str, Any] | list[str]) -> AnyPARAMETERS
self
payload
dict[str, Any] | list[str]
turn_on
Turn the light on.
hardware/lepro/devices.py:114
WHAT IT DOES
Turn the light on.
SIGNATURE
turn_on(self, brightness: int = 1000) -> AnyPARAMETERS
self
brightness
int
= 1000
turn_off
Turn the light off.
hardware/lepro/devices.py:126
WHAT IT DOES
Turn the light off.
SIGNATURE
turn_off(self) -> AnyPARAMETERS
self
set_color_rgb
Set the light color using RGB values.
hardware/lepro/devices.py:137
WHAT IT DOES
Set the light color using RGB values.
SIGNATURE
set_color_rgb(self, red: int, green: int, blue: int, brightness: int = 1000) -> AnyPARAMETERS
self
red
int
green
int
blue
int
brightness
int
= 1000
set_color_hsv
Set the light color using HSV values.
hardware/lepro/devices.py:155
WHAT IT DOES
Set the light color using HSV values.
SIGNATURE
set_color_hsv(self, hue: float, saturation: int = 1000, value: int = 1000, brightness: int = 1000) -> AnyPARAMETERS
self
hue
float
saturation
int
= 1000
value
int
= 1000
brightness
int
= 1000
get_status
Query the current datapoint state of the light. This uses the upstream Lepro protocol directly without modifying the upstream lib…
hardware/lepro/devices.py:177
WHAT IT DOES
Query the current datapoint state of the light. This uses the upstream Lepro protocol directly without modifying the upstream library.
SIGNATURE
get_status(self) -> dict[str, Any]PARAMETERS
self
hardware/lepro/discovery.py · LeproDiscovery
2 symbols
__init__
No description documented yet.
hardware/lepro/discovery.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, timeout: float = 15.0)PARAMETERS
self
timeout
float
= 15.0
scan
No description documented yet.
hardware/lepro/discovery.py:18
WHAT IT DOES
No description documented yet.
SIGNATURE
scan(self) -> list[dict[str, Any]]PARAMETERS
self
hardware/lepro/lib/lepro/bond.py · BondTokens
3 symbols
validate
No description documented yet.
hardware/lepro/lib/lepro/bond.py:50
WHAT IT DOES
No description documented yet.
SIGNATURE
validate(self) -> NonePARAMETERS
self
to_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:57
WHAT IT DOES
No description documented yet.
SIGNATURE
to_dict(self) -> dict[str, str]PARAMETERS
self
from_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:61
WHAT IT DOES
No description documented yet.
SIGNATURE
from_dict(cls, d: dict[str, str]) -> BondTokensPARAMETERS
cls
d
dict[str, str]
DECORATORS
hardware/lepro/lib/lepro/bond.py · BondCredentials
3 symbols
__post_init__
No description documented yet.
hardware/lepro/lib/lepro/bond.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
__post_init__(self) -> NonePARAMETERS
self
to_json_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:83
WHAT IT DOES
No description documented yet.
SIGNATURE
to_json_dict(self) -> dictPARAMETERS
self
from_json_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:92
WHAT IT DOES
No description documented yet.
SIGNATURE
from_json_dict(cls, d: dict) -> BondCredentialsPARAMETERS
cls
d
dict
DECORATORS
hardware/lepro/lib/lepro/firmware_profile.py · PatchProfiles
1 symbols
by_id
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:53
WHAT IT DOES
No description documented yet.
SIGNATURE
by_id(self, profile_id: str) -> FirmwareProfilePARAMETERS
self
profile_id
str
hardware/lepro/lib/lepro/frame.py · RxAssembler
8 symbols
__init__
No description documented yet.
hardware/lepro/lib/lepro/frame.py:76
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, mac: str, session_rand: int | None = None) -> NonePARAMETERS
self
mac
str
session_rand
int | None
= None
set_session_rand
Update key after 0x1000 hello reveals bleInit rand() in ctx1.
hardware/lepro/lib/lepro/frame.py:90
WHAT IT DOES
Update key after 0x1000 hello reveals bleInit rand() in ctx1.
SIGNATURE
set_session_rand(self, session_rand: int) -> NonePARAMETERS
self
session_rand
int
feed
No description documented yet.
hardware/lepro/lib/lepro/frame.py:95
WHAT IT DOES
No description documented yet.
SIGNATURE
feed(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_reset_fragment
No description documented yet.
hardware/lepro/lib/lepro/frame.py:111
WHAT IT DOES
No description documented yet.
SIGNATURE
_reset_fragment(self) -> NonePARAMETERS
self
_feed_fragment
No description documented yet.
hardware/lepro/lib/lepro/frame.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
_feed_fragment(self, raw: bytes, magic2: int) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
magic2
int
_dispatch_single
No description documented yet.
hardware/lepro/lib/lepro/frame.py:176
WHAT IT DOES
No description documented yet.
SIGNATURE
_dispatch_single(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_maybe_decrypt
No description documented yet.
hardware/lepro/lib/lepro/frame.py:188
WHAT IT DOES
No description documented yet.
SIGNATURE
_maybe_decrypt(self, frame: DecryptedFrame) -> DecryptedFramePARAMETERS
self
frame
DecryptedFrame
_synthetic_body
No description documented yet.
hardware/lepro/lib/lepro/frame.py:206
WHAT IT DOES
No description documented yet.
SIGNATURE
_synthetic_body(seq: int, magic2: int, ptype: int, subtype: int, payload: bytes) -> bytesPARAMETERS
seq
int
magic2
int
ptype
int
subtype
int
payload
bytes
DECORATORS
hardware/lepro/lib/lepro/ota.py · OtaTransferResult
2 symbols
finalize_code
No description documented yet.
hardware/lepro/lib/lepro/ota.py:113
WHAT IT DOES
No description documented yet.
SIGNATURE
finalize_code(self) -> int | NonePARAMETERS
self
DECORATORS
transfer_complete
No description documented yet.
hardware/lepro/lib/lepro/ota.py:117
WHAT IT DOES
No description documented yet.
SIGNATURE
transfer_complete(self) -> boolPARAMETERS
self
DECORATORS
hardware/lepro/lib/lepro/ota.py · OtaLog
3 symbols
info
No description documented yet.
hardware/lepro/lib/lepro/ota.py:138
WHAT IT DOES
No description documented yet.
SIGNATURE
info(self, msg: str) -> NonePARAMETERS
self
msg
str
phase
No description documented yet.
hardware/lepro/lib/lepro/ota.py:144
WHAT IT DOES
No description documented yet.
SIGNATURE
phase(self, name: str) -> NonePARAMETERS
self
name
str
wait
No description documented yet.
hardware/lepro/lib/lepro/ota.py:147
WHAT IT DOES
No description documented yet.
SIGNATURE
wait(self, msg: str, timeout: float) -> NonePARAMETERS
self
msg
str
timeout
float
hardware/lepro/lib/lepro/ota.py · OtaTransport
2 symbols
on_notify
No description documented yet.
hardware/lepro/lib/lepro/ota.py:159
WHAT IT DOES
No description documented yet.
SIGNATURE
on_notify(self, _sender: object, data: bytearray) -> NonePARAMETERS
self
_sender
object
data
bytearray
send
No description documented yet.
hardware/lepro/lib/lepro/ota.py:165
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
hardware/lepro/lib/lepro/ota.py · BleOtaSession
2 symbols
__init__
No description documented yet.
hardware/lepro/lib/lepro/ota.py:954
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, session: LeproSession, firmware: Path, image: bytes, log: OtaLog) -> NonePARAMETERS
self
session
LeproSession
firmware
Path
image
bytes
log
OtaLog
run
No description documented yet.
hardware/lepro/lib/lepro/ota.py:966
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self, json_bytes: bytes, chunk_size: int = 4096, max_retries: int = 3, dry_run: bool = False) -> OtaTransferResultPARAMETERS
self
json_bytes
bytes
chunk_size
int
= 4096
max_retries
int
= 3
dry_run
bool
= False
hardware/lepro/lib/lepro/patch_cdn.py · BundleLayout
1 symbols
record_len
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
record_len(self) -> intPARAMETERS
self
DECORATORS
hardware/lepro/lib/lepro/session.py · DeviceInfo
3 symbols
prov_state
OTA/provisioning state-machine value (device-info byte[1] = ota_ctx+0x10).
hardware/lepro/lib/lepro/session.py:71
WHAT IT DOES
OTA/provisioning state-machine value (device-info byte[1] = ota_ctx+0x10).
SIGNATURE
prov_state(self) -> int | NonePARAMETERS
self
DECORATORS
prov_slot
Retained provisioning flag (device-info byte[2], from ota_ctx slot 0x42000b3c). Verified in ZB1 v2.3.18 build_device_info_reply:…
hardware/lepro/lib/lepro/session.py:76
WHAT IT DOES
Retained provisioning flag (device-info byte[2], from ota_ctx slot 0x42000b3c). Verified in ZB1 v2.3.18 build_device_info_reply: 6 = addable/onboarding (slot unset or factory), 7 = provisioned. NOTE: a power-cycle reset re-enters onboarding via the reboot counter WITHOUT clearing this slot, so a 7 here does NOT prove the CDN cert fetch is disabled — it is only conclusive when 6.
SIGNATURE
prov_slot(self) -> int | NonePARAMETERS
self
DECORATORS
provisioning_summary
One-line human-readable provisioning/cert-fetch status for CLI output.
hardware/lepro/lib/lepro/session.py:87
WHAT IT DOES
One-line human-readable provisioning/cert-fetch status for CLI output.
SIGNATURE
provisioning_summary(self) -> strPARAMETERS
self
hardware/lepro/lib/lepro/session.py · Transport
3 symbols
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:105
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:106
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:107
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
hardware/lepro/lib/lepro/session.py · DryRunTransport
3 symbols
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:119
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:122
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
hardware/lepro/lib/lepro/session.py · BleakTransport
4 symbols
on_notify
No description documented yet.
hardware/lepro/lib/lepro/session.py:134
WHAT IT DOES
No description documented yet.
SIGNATURE
on_notify(self, _sender: object, data: bytearray) -> NonePARAMETERS
self
_sender
object
data
bytearray
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:140
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:145
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:151
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
hardware/lepro/lib/lepro/session.py · LeproSession
18 symbols
__init__
No description documented yet.
hardware/lepro/lib/lepro/session.py:167
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, mac: str, transport: Transport, config: SessionConfig | None = None) -> NonePARAMETERS
self
mac
str
transport
Transport
config
SessionConfig | None
= None
_require_session_rand
No description documented yet.
hardware/lepro/lib/lepro/session.py:183
WHAT IT DOES
No description documented yet.
SIGNATURE
_require_session_rand(self) -> intPARAMETERS
self
_send
No description documented yet.
hardware/lepro/lib/lepro/session.py:188
WHAT IT DOES
No description documented yet.
SIGNATURE
_send(self, pkt: bytes, label: str = '') -> NonePARAMETERS
self
pkt
bytes
label
str
= ''
_next_seq
No description documented yet.
hardware/lepro/lib/lepro/session.py:192
WHAT IT DOES
No description documented yet.
SIGNATURE
_next_seq(self) -> intPARAMETERS
self
_ingest_rx
No description documented yet.
hardware/lepro/lib/lepro/session.py:197
WHAT IT DOES
No description documented yet.
SIGNATURE
_ingest_rx(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_wait_opcode
No description documented yet.
hardware/lepro/lib/lepro/session.py:203
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_opcode(self, opcode: int, timeout: float | None = None) -> DecryptedFramePARAMETERS
self
opcode
int
timeout
float | None
= None
_wait_any
No description documented yet.
hardware/lepro/lib/lepro/session.py:217
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_any(self, opcodes: set[int], timeout: float) -> DecryptedFramePARAMETERS
self
opcodes
set[int]
timeout
float
run_phase_discovery
No description documented yet.
hardware/lepro/lib/lepro/session.py:231
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_discovery(self) -> DeviceInfoPARAMETERS
self
_wait_new_auth_resp
No description documented yet.
hardware/lepro/lib/lepro/session.py:269
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_new_auth_resp(self, after_count: int, timeout: float) -> DecryptedFramePARAMETERS
self
after_count
int
timeout
float
_request_bond
No description documented yet.
hardware/lepro/lib/lepro/session.py:285
WHAT IT DOES
No description documented yet.
SIGNATURE
_request_bond(self, payload: bytes, label: str) -> DecryptedFramePARAMETERS
self
payload
bytes
label
str
run_phase_bond
No description documented yet.
hardware/lepro/lib/lepro/session.py:290
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_bond(self, fallback_hs: bytes | None = None) -> BondTokensPARAMETERS
self
fallback_hs
bytes | None
= None
_wait_auth_resp
No description documented yet.
hardware/lepro/lib/lepro/session.py:321
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_auth_resp(self, timeout: float | None = None) -> DecryptedFramePARAMETERS
self
timeout
float | None
= None
run_phase_auth
No description documented yet.
hardware/lepro/lib/lepro/session.py:324
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_auth(self, creds: BondCredentials) -> NonePARAMETERS
self
creds
BondCredentials
send_dp_ciphertext
No description documented yet.
hardware/lepro/lib/lepro/session.py:339
WHAT IT DOES
No description documented yet.
SIGNATURE
send_dp_ciphertext(self, ciphertext: bytes) -> NonePARAMETERS
self
ciphertext
bytes
send_dp_payload
No description documented yet.
hardware/lepro/lib/lepro/session.py:345
WHAT IT DOES
No description documented yet.
SIGNATURE
send_dp_payload(self, payload: DpPayload) -> NonePARAMETERS
self
payload
DpPayload
send_get_dp_state
No description documented yet.
hardware/lepro/lib/lepro/session.py:353
WHAT IT DOES
No description documented yet.
SIGNATURE
send_get_dp_state(self, payload: DpPayload) -> DecryptedFramePARAMETERS
self
payload
DpPayload
commit_control
No description documented yet.
hardware/lepro/lib/lepro/session.py:360
WHAT IT DOES
No description documented yet.
SIGNATURE
commit_control(self, creds: BondCredentials) -> NonePARAMETERS
self
creds
BondCredentials
run_control
Full control session. pre_bulk_pages is only for large scene uploads (capture 11:17 colour).
hardware/lepro/lib/lepro/session.py:379
WHAT IT DOES
Full control session. pre_bulk_pages is only for large scene uploads (capture 11:17 colour).
SIGNATURE
run_control(self, creds: BondCredentials, dp_payload: DpPayload, pre_bulk_pages: list[bytes] | None = None) -> NonePARAMETERS
self
creds
BondCredentials
dp_payload
DpPayload
pre_bulk_pages
list[bytes] | None
= None
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py · Segment
2 symbols
p_flags
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:48
WHAT IT DOES
No description documented yet.
SIGNATURE
p_flags(self) -> intPARAMETERS
self
DECORATORS
sh_flags
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
sh_flags(self) -> intPARAMETERS
self
DECORATORS
hardware/lepro/lib/lepro/tools/validate_ota_parser.py · Elf32
5 symbols
__init__
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:123
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, data: bytes) -> NonePARAMETERS
self
data
bytes
u32
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:131
WHAT IT DOES
No description documented yet.
SIGNATURE
u32(self, off: int) -> intPARAMETERS
self
off
int
vma_to_offset
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:134
WHAT IT DOES
No description documented yet.
SIGNATURE
vma_to_offset(self, vma: int) -> int | NonePARAMETERS
self
vma
int
read_cstr
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:146
WHAT IT DOES
No description documented yet.
SIGNATURE
read_cstr(self, vma: int) -> str | NonePARAMETERS
self
vma
int
pool_strings
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:153
WHAT IT DOES
No description documented yet.
SIGNATURE
pool_strings(self, pool_vma: int, count: int) -> list[tuple[int, int, str | None]]PARAMETERS
self
pool_vma
int
count
int
hardware/lepro/setup.py · LeproSetup
3 symbols
__init__
No description documented yet.
hardware/lepro/setup.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, base_dir: Path | None = None)PARAMETERS
self
base_dir
Path | None
= None
run
No description documented yet.
hardware/lepro/setup.py:28
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self) -> dict[str, Any]PARAMETERS
self
fail
No description documented yet.
hardware/lepro/setup.py:254
WHAT IT DOES
No description documented yet.
SIGNATURE
fail(stage: str, message: str) -> dict[str, Any]PARAMETERS
stage
str
message
str
DECORATORS
interfaces/discord_bot.py · DiscordAdapter
2 symbols
__init__
No description documented yet.
interfaces/discord_bot.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
start
No description documented yet.
interfaces/discord_bot.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
start(self)PARAMETERS
self
interfaces/terminal.py · TerminalAdapter
2 symbols
__init__
No description documented yet.
interfaces/terminal.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
run
No description documented yet.
interfaces/terminal.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self)PARAMETERS
self
interfaces/web_ui.py · WebUIAdapter
2 symbols
__init__
No description documented yet.
interfaces/web_ui.py:6
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
start
No description documented yet.
interfaces/web_ui.py:10
WHAT IT DOES
No description documented yet.
SIGNATURE
start(self, host = '127.0.0.1', port = 8000)PARAMETERS
self
host
= '127.0.0.1'
port
= 8000
memory/embeddings.py · EmbeddingsProvider
4 symbols
__init__
No description documented yet.
memory/embeddings.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
embed
No description documented yet.
memory/embeddings.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
embed(self, texts: List[str]) -> List[List[float]]PARAMETERS
self
texts
List[str]
store_embeddings
No description documented yet.
memory/embeddings.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
store_embeddings(self, ids: List[int], vectors: List[List[float]])PARAMETERS
self
ids
List[int]
vectors
List[List[float]]
query
No description documented yet.
memory/embeddings.py:18
WHAT IT DOES
No description documented yet.
SIGNATURE
query(self, vector: List[float], top_k: int = 5)PARAMETERS
self
vector
List[float]
top_k
int
= 5
memory/memory.py · MemoryManager
1 symbols
__init__
No description documented yet.
memory/memory.py:23
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
tools/base.py · BaseTool
1 symbols
call
No description documented yet.
tools/base.py:19
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
tools/calculator.py · CalculatorTool
2 symbols
_safe_eval
No description documented yet.
tools/calculator.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
_safe_eval(self, expr: str) -> floatPARAMETERS
self
expr
str
call
No description documented yet.
tools/calculator.py:23
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
tools/chart_tool.py · ChartTool
18 symbols
call
Main BaseTool entry point. ToolRouter calls: tool.call(args) and expects a ToolResult.
tools/chart_tool.py:68
WHAT IT DOES
Main BaseTool entry point. ToolRouter calls: tool.call(args) and expects a ToolResult.
SIGNATURE
call(self, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
args
Dict[str, Any]
create_chart
Create one complete chart specification.
tools/chart_tool.py:140
WHAT IT DOES
Create one complete chart specification.
SIGNATURE
create_chart(self, chart_type: str, title: str, data: List[Dict[str, Any]], x_key: str | None = None, series: List[Dict[str, Any]] | None = None, description: str | None = None, footer: str | None = None, x_axis_label: str | None = None, x_axis_scale: str | None = None, y_axis_min: float | None = None, y_axis_max: float | None = None, layout: str | None = None, name_key: str | None = None, value_key: str | None = None) -> Dict[str, Any]PARAMETERS
self
chart_type
str
title
str
data
List[Dict[str, Any]]
x_key
str | None
= None
series
List[Dict[str, Any]] | None
= None
description
str | None
= None
footer
str | None
= None
x_axis_label
str | None
= None
x_axis_scale
str | None
= None
y_axis_min
float | None
= None
y_axis_max
float | None
= None
layout
str | None
= None
name_key
str | None
= None
value_key
str | None
= None
bar
No description documented yet.
tools/chart_tool.py:291
WHAT IT DOES
No description documented yet.
SIGNATURE
bar(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
line
No description documented yet.
tools/chart_tool.py:309
WHAT IT DOES
No description documented yet.
SIGNATURE
line(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
pie
No description documented yet.
tools/chart_tool.py:327
WHAT IT DOES
No description documented yet.
SIGNATURE
pie(self, title: str, data: List[Dict[str, Any]], name_key: str, value_key: str, series: List[Dict[str, Any]] | None = None, **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
name_key
str
value_key
str
series
List[Dict[str, Any]] | None
= None
**kwargs
Any
scatter
No description documented yet.
tools/chart_tool.py:347
WHAT IT DOES
No description documented yet.
SIGNATURE
scatter(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
make_series
Build a series definition. Example: ChartTool.make_series( data_key="cigarettes", label="Cigarettes", axis_label="Cigarettes", va…
tools/chart_tool.py:370
WHAT IT DOES
Build a series definition. Example: ChartTool.make_series( data_key="cigarettes", label="Cigarettes", axis_label="Cigarettes", value_format="integer", )
SIGNATURE
make_series(data_key: str, label: str | None = None, axis_label: str | None = None, value_format: str | None = None, value_prefix: str | None = None, value_suffix: str | None = None, stack: str | None = None) -> Dict[str, Any]PARAMETERS
data_key
str
label
str | None
= None
axis_label
str | None
= None
value_format
str | None
= None
value_prefix
str | None
= None
value_suffix
str | None
= None
stack
str | None
= None
DECORATORS
_normalize_chart_type
No description documented yet.
tools/chart_tool.py:447
WHAT IT DOES
No description documented yet.
SIGNATURE
_normalize_chart_type(chart_type: str) -> strPARAMETERS
chart_type
str
DECORATORS
_normalize_series
No description documented yet.
tools/chart_tool.py:459
WHAT IT DOES
No description documented yet.
SIGNATURE
_normalize_series(cls, series: List[Dict[str, Any]]) -> List[Dict[str, Any]]PARAMETERS
cls
series
List[Dict[str, Any]]
DECORATORS
_validate_chart_type
No description documented yet.
tools/chart_tool.py:554
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_chart_type(self, chart_type: str) -> NonePARAMETERS
self
chart_type
str
_validate_title
No description documented yet.
tools/chart_tool.py:570
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_title(title: str) -> NonePARAMETERS
title
str
DECORATORS
_validate_data
No description documented yet.
tools/chart_tool.py:585
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_data(data: List[Dict[str, Any]]) -> NonePARAMETERS
data
List[Dict[str, Any]]
DECORATORS
_validate_cartesian_chart
No description documented yet.
tools/chart_tool.py:607
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_cartesian_chart(chart_type: str, data: List[Dict[str, Any]], x_key: str | None, series: List[Dict[str, Any]]) -> NonePARAMETERS
chart_type
str
data
List[Dict[str, Any]]
x_key
str | None
series
List[Dict[str, Any]]
DECORATORS
_validate_pie_chart
No description documented yet.
tools/chart_tool.py:648
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_pie_chart(data: List[Dict[str, Any]], name_key: str | None, value_key: str | None) -> NonePARAMETERS
data
List[Dict[str, Any]]
name_key
str | None
value_key
str | None
DECORATORS
_validate_x_axis_scale
No description documented yet.
tools/chart_tool.py:705
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_x_axis_scale(chart_type: str, x_axis_scale: str, data: List[Dict[str, Any]], x_key: str | None) -> NonePARAMETERS
chart_type
str
x_axis_scale
str
data
List[Dict[str, Any]]
x_key
str | None
DECORATORS
_validate_layout
No description documented yet.
tools/chart_tool.py:742
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_layout(layout: str) -> NonePARAMETERS
layout
str
DECORATORS
_validate_y_axis
No description documented yet.
tools/chart_tool.py:752
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_y_axis(y_axis_min: float | None, y_axis_max: float | None) -> NonePARAMETERS
y_axis_min
float | None
y_axis_max
float | None
DECORATORS
_format_output
Serialize the chart specification for ToolResult.output. ChatEngine can then parse/recognize the structured chart object rather t…
tools/chart_tool.py:792
WHAT IT DOES
Serialize the chart specification for ToolResult.output. ChatEngine can then parse/recognize the structured chart object rather than treating it as ordinary prose.
SIGNATURE
_format_output(chart: Dict[str, Any]) -> strPARAMETERS
chart
Dict[str, Any]
DECORATORS
tools/ChartTool.py · ChartTool
3 symbols
_ensure_db
No description documented yet.
tools/ChartTool.py:22
WHAT IT DOES
No description documented yet.
SIGNATURE
_ensure_db(self)PARAMETERS
self
_smoke_data
No description documented yet.
tools/ChartTool.py:35
WHAT IT DOES
No description documented yet.
SIGNATURE
_smoke_data(self, scope: str = '7d', smoke_type: str | None = None)PARAMETERS
self
scope
str
= '7d'
smoke_type
str | None
= None
call
No description documented yet.
tools/ChartTool.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
args
Dict[str, Any]
tools/filesystem.py · FilesystemTool
1 symbols
call
No description documented yet.
tools/filesystem.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
tools/lepro_lights.py · LeproLightsTool
3 symbols
__init__
No description documented yet.
tools/lepro_lights.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, device_name: str, mac: str)PARAMETERS
self
device_name
str
mac
str
schema
Return the tool schema exposed to CYN.
tools/lepro_lights.py:30
WHAT IT DOES
Return the tool schema exposed to CYN.
SIGNATURE
schema(self) -> dict[str, Any]PARAMETERS
self
execute
Execute a light-control request.
tools/lepro_lights.py:86
WHAT IT DOES
Execute a light-control request.
SIGNATURE
execute(self, arguments: dict[str, Any]) -> ToolResultPARAMETERS
self
arguments
dict[str, Any]
tools/LeproLightsTool.py · LeproLightsTool
3 symbols
__init__
No description documented yet.
tools/LeproLightsTool.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, device_name: str, mac: str)PARAMETERS
self
device_name
str
mac
str
schema
Return the tool schema exposed to CYN.
tools/LeproLightsTool.py:30
WHAT IT DOES
Return the tool schema exposed to CYN.
SIGNATURE
schema(self) -> dict[str, Any]PARAMETERS
self
execute
Execute a light-control request.
tools/LeproLightsTool.py:86
WHAT IT DOES
Execute a light-control request.
SIGNATURE
execute(self, arguments: dict[str, Any]) -> ToolResultPARAMETERS
self
arguments
dict[str, Any]
tools/SmokeCounterTool.py · SmokeCounterTool
1 symbols
call
Flexible call interface: - If args is a dict (tool_router), use it. - Otherwise accept keyword args for backward compatibility. R…
tools/SmokeCounterTool.py:611
WHAT IT DOES
Flexible call interface: - If args is a dict (tool_router), use it. - Otherwise accept keyword args for backward compatibility. Returns a ToolResult with a human-readable output and metadata containing the raw result dict.
SIGNATURE
call(self, args = None, action: str = 'stats', smoke_type: Optional[str] = None, amount: float = 1, limit: int = 10, scope: str = 'all') -> ToolResultPARAMETERS
self
args
= None
action
str
= 'stats'
smoke_type
Optional[str]
= None
amount
float
= 1
limit
int
= 10
scope
str
= 'all'
tools/tool_router.py · ToolRouter
9 symbols
__init__
No description documented yet.
tools/tool_router.py:16
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
register_tool
No description documented yet.
tools/tool_router.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
register_tool(self, tool: BaseTool)PARAMETERS
self
tool
BaseTool
list_tools
No description documented yet.
tools/tool_router.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
list_tools(self)PARAMETERS
self
describe_tools
Gives the AI a list of available tools.
tools/tool_router.py:28
WHAT IT DOES
Gives the AI a list of available tools.
SIGNATURE
describe_tools(self)PARAMETERS
self
as_ollama_tools
Convert the registered tools into Ollama function-calling schemas.
tools/tool_router.py:41
WHAT IT DOES
Convert the registered tools into Ollama function-calling schemas.
SIGNATURE
as_ollama_tools(self)PARAMETERS
self
call_tool
No description documented yet.
tools/tool_router.py:180
WHAT IT DOES
No description documented yet.
SIGNATURE
call_tool(self, name: str, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
name
str
args
Dict[str, Any]
normalize_smoke_type
Normalize a freeform smoke_type string into a canonical type (pen, vape, cigarette, bong, weed, joint, unknown).
tools/tool_router.py:215
WHAT IT DOES
Normalize a freeform smoke_type string into a canonical type (pen, vape, cigarette, bong, weed, joint, unknown).
SIGNATURE
normalize_smoke_type(self, text: str)PARAMETERS
self
text
str
is_read_only_smoke_query
Return True when the request is asking for counts/stats/history instead of logging.
tools/tool_router.py:244
WHAT IT DOES
Return True when the request is asking for counts/stats/history instead of logging.
SIGNATURE
is_read_only_smoke_query(self, text: str) -> boolPARAMETERS
self
text
str
detect
Detect whether a message requires a tool.
tools/tool_router.py:285
WHAT IT DOES
Detect whether a message requires a tool.
SIGNATURE
detect(self, text: str)PARAMETERS
self
text
str
tools/weather.py · WeatherTool
1 symbols
call
No description documented yet.
tools/weather.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
tools/web_search.py · ResultFilter
2 symbols
__init__
No description documented yet.
tools/web_search.py:837
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
is_bad_result
No description documented yet.
tools/web_search.py:841
WHAT IT DOES
No description documented yet.
SIGNATURE
is_bad_result(self, title: str, body: str, href: str) -> boolPARAMETERS
self
title
str
body
str
href
str
tools/web_search.py · ResultRanker
8 symbols
__init__
No description documented yet.
tools/web_search.py:897
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, intent: SearchIntent)PARAMETERS
self
intent
SearchIntent
rank
No description documented yet.
tools/web_search.py:905
WHAT IT DOES
No description documented yet.
SIGNATURE
rank(self, title: str, body: str, href: str) -> intPARAMETERS
self
title
str
body
str
href
str
score_keywords
No description documented yet.
tools/web_search.py:980
WHAT IT DOES
No description documented yet.
SIGNATURE
score_keywords(title: str, combined: str, keywords: tuple[str, ...], title_weight: int, body_weight: int) -> intPARAMETERS
title
str
combined
str
keywords
tuple[str, ...]
title_weight
int
body_weight
int
DECORATORS
score_negative
No description documented yet.
tools/web_search.py:1002
WHAT IT DOES
No description documented yet.
SIGNATURE
score_negative(self, title: str, combined: str) -> intPARAMETERS
self
title
str
combined
str
output_bonus
No description documented yet.
tools/web_search.py:1022
WHAT IT DOES
No description documented yet.
SIGNATURE
output_bonus(self, title: str) -> intPARAMETERS
self
title
str
store_bonus
No description documented yet.
tools/web_search.py:1065
WHAT IT DOES
No description documented yet.
SIGNATURE
store_bonus(self, href: str) -> intPARAMETERS
self
href
str
domain_bonus
No description documented yet.
tools/web_search.py:1080
WHAT IT DOES
No description documented yet.
SIGNATURE
domain_bonus(href: str) -> intPARAMETERS
href
str
DECORATORS
research_source_bonus
No description documented yet.
tools/web_search.py:1110
WHAT IT DOES
No description documented yet.
SIGNATURE
research_source_bonus(href: str) -> intPARAMETERS
href
str
DECORATORS
tools/web_search.py · WebSearchTool
2 symbols
call
No description documented yet.
tools/web_search.py:1547
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args)PARAMETERS
self
args
format_result
No description documented yet.
tools/web_search.py:1913
WHAT IT DOES
No description documented yet.
SIGNATURE
format_result(title: str, body: str, href: str, score: int = 0, source_type: str = 'unknown') -> strPARAMETERS
title
str
body
str
href
str
score
int
= 0
source_type
str
= 'unknown'
DECORATORS
voice/audio_player.py · AudioPlayer
4 symbols
play
Play a WAV audio file. Args: filepath (str): Path to the WAV file to play Raises: FileNotFoundError: If the audio file doesn't ex…
voice/audio_player.py:18
WHAT IT DOES
Play a WAV audio file. Args: filepath (str): Path to the WAV file to play Raises: FileNotFoundError: If the audio file doesn't exist RuntimeError: If playback fails
SIGNATURE
play(self, filepath)PARAMETERS
self
filepath
_play_windows
Play audio on Windows using PowerShell.
voice/audio_player.py:42
WHAT IT DOES
Play audio on Windows using PowerShell.
SIGNATURE
_play_windows(self, filepath)PARAMETERS
self
filepath
_play_macos
Play audio on macOS using afplay.
voice/audio_player.py:57
WHAT IT DOES
Play audio on macOS using afplay.
SIGNATURE
_play_macos(self, filepath)PARAMETERS
self
filepath
_play_linux
Play audio on Linux using available tools.
voice/audio_player.py:66
WHAT IT DOES
Play audio on Linux using available tools.
SIGNATURE
_play_linux(self, filepath)PARAMETERS
self
filepath
voice/piper_engine.py · PiperTTS
2 symbols
__init__
Initialize PiperTTS with a specific model. Args: model_path (str): Path to the .onnx model file e.g., "models/voices/cyn_normal.o…
voice/piper_engine.py:33
WHAT IT DOES
Initialize PiperTTS with a specific model. Args: model_path (str): Path to the .onnx model file e.g., "models/voices/cyn_normal.onnx" Raises: FileNotFoundError: If the model file doesn't exist
SIGNATURE
__init__(self, model_path)PARAMETERS
self
model_path
generate
Generate speech from text using Piper TTS. Args: text (str): The text to convert to speech output_file (str): Path where the WAV…
voice/piper_engine.py:53
WHAT IT DOES
Generate speech from text using Piper TTS. Args: text (str): The text to convert to speech output_file (str): Path where the WAV file will be saved Returns: str: Path to the generated WAV file Raises: RuntimeError: If Piper subprocess fails or is not installed
SIGNATURE
generate(self, text, output_file = 'cyn_output.wav')PARAMETERS
self
text
output_file
= 'cyn_output.wav'
voice/tts_engine.py · TTSEngine
2 symbols
__init__
No description documented yet.
voice/tts_engine.py:6
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
generate
No description documented yet.
voice/tts_engine.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
generate(self, text, output = 'cyn_output.wav')PARAMETERS
self
text
output
= 'cyn_output.wav'
voice/voice_manager.py · VoiceManager
2 symbols
__init__
Initialize VoiceManager with TTS and playback engines. Args: tts: TTS engine (e.g., PiperTTS) with generate(text) method player:…
voice/voice_manager.py:26
WHAT IT DOES
Initialize VoiceManager with TTS and playback engines. Args: tts: TTS engine (e.g., PiperTTS) with generate(text) method player: Audio player (e.g., AudioPlayer) with play(filepath) method
SIGNATURE
__init__(self, tts, player)PARAMETERS
self
tts
player
speak
Generate speech from text and play it immediately. Args: text (str): The text to speak Raises: Exception: Propagates errors from…
voice/voice_manager.py:37
WHAT IT DOES
Generate speech from text and play it immediately. Args: text (str): The text to speak Raises: Exception: Propagates errors from TTS or playback
SIGNATURE
speak(self, text)PARAMETERS
self
text
06
BARKLY DOCS
Classes
Classes stay collapsed so large projects remain readable.
ChatEngine
No description documented yet.
6 methods
No description documented yet.
__init__
No description documented yet.
ai/chat_engine.py:50
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, ollama_client, prompt_builder, memory_store, tool_router, mode_manager, memory_manager: Optional[MemoryManager] = None, memory_extractor: Optional[MemoryExtractor] = None, context_manager = None, logger_obj = None)PARAMETERS
self
ollama_client
prompt_builder
memory_store
tool_router
mode_manager
memory_manager
Optional[MemoryManager]
= None
memory_extractor
Optional[MemoryExtractor]
= None
context_manager
= None
logger_obj
= None
trim_context
No description documented yet.
ai/chat_engine.py:98
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_context(self, text: str, limit: int) -> strPARAMETERS
self
text
str
limit
int
_estimate_message_tokens
Roughly estimate tokens in an Ollama message. This is intentionally conservative. Actual tokenization is model-dependent, so the…
ai/chat_engine.py:116
WHAT IT DOES
Roughly estimate tokens in an Ollama message. This is intentionally conservative. Actual tokenization is model-dependent, so the final context budget keeps headroom.
SIGNATURE
_estimate_message_tokens(self, message) -> intPARAMETERS
self
message
_trim_ollama_messages
Prevent Ollama requests from exceeding the available context. Priority: 1. System prompt 2. Current user message 3. Tool results…
ai/chat_engine.py:149
WHAT IT DOES
Prevent Ollama requests from exceeding the available context. Priority: 1. System prompt 2. Current user message 3. Tool results required for the current response 4. Newest conversation history 5. Older conversation history The current user message is never intentionally removed.
SIGNATURE
_trim_ollama_messages(self, messages, max_tokens: int = OLLAMA_PROMPT_BUDGET)PARAMETERS
self
messages
max_tokens
int
= OLLAMA_PROMPT_BUDGET
_ollama_tools
No description documented yet.
ai/chat_engine.py:471
WHAT IT DOES
No description documented yet.
SIGNATURE
_ollama_tools(self, user_text: str = '')PARAMETERS
self
user_text
str
= ''
handle_user_message
Process a user message. Flow: 1. Retrieve relevant context 2. Build Cyn prompt 3. Detect tools 4. Execute tools 5. Generate respo…
ai/chat_engine.py:501
WHAT IT DOES
Process a user message. Flow: 1. Retrieve relevant context 2. Build Cyn prompt 3. Detect tools 4. Execute tools 5. Generate response 6. Extract memories 7. Save conversation info
SIGNATURE
handle_user_message(self, user_id: str, text: str, mode: str = 'normal', personality: str = 'normal', request_id: Optional[str] = None) -> strPARAMETERS
self
user_id
str
text
str
mode
str
= 'normal'
personality
str
= 'normal'
request_id
Optional[str]
= None
ContextManager
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
ai/context_manager.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, memory_store, knowledge_store)PARAMETERS
self
memory_store
knowledge_store
build_context
No description documented yet.
ai/context_manager.py:27
WHAT IT DOES
No description documented yet.
SIGNATURE
build_context(self, user_id, user_message)PARAMETERS
self
user_id
user_message
KnowledgeStore
No description documented yet.
4 methods
No description documented yet.
__init__
No description documented yet.
ai/knowledge/store.py:7
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
add
No description documented yet.
ai/knowledge/store.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
add(self, content, title = '', category = 'general', importance = 5, tags = None)PARAMETERS
self
content
title
= ''
category
= 'general'
importance
= 5
tags
= None
search
No description documented yet.
ai/knowledge/store.py:68
WHAT IT DOES
No description documented yet.
SIGNATURE
search(self, query, limit = 5)PARAMETERS
self
query
limit
= 5
recent
No description documented yet.
ai/knowledge/store.py:156
WHAT IT DOES
No description documented yet.
SIGNATURE
recent(self, limit = 10)PARAMETERS
self
limit
= 10
MemoryExtractor
No description documented yet.
10 methods
No description documented yet.
__init__
No description documented yet.
ai/memory_system/extractor.py:30
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, memory_store)PARAMETERS
self
memory_store
extract_and_save
No description documented yet.
ai/memory_system/extractor.py:49
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_and_save(self, user_id: str, user_message: str, assistant_response: str = '') -> List[int]PARAMETERS
self
user_id
str
user_message
str
assistant_response
str
= ''
extract_preferences
No description documented yet.
ai/memory_system/extractor.py:292
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_preferences(self, text)PARAMETERS
self
text
extract_goals
No description documented yet.
ai/memory_system/extractor.py:328
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_goals(self, text)PARAMETERS
self
text
extract_projects
No description documented yet.
ai/memory_system/extractor.py:365
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_projects(self, text)PARAMETERS
self
text
extract_names
No description documented yet.
ai/memory_system/extractor.py:402
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_names(self, text)PARAMETERS
self
text
extract_style
No description documented yet.
ai/memory_system/extractor.py:442
WHAT IT DOES
No description documented yet.
SIGNATURE
extract_style(self, text)PARAMETERS
self
text
match_patterns
No description documented yet.
ai/memory_system/extractor.py:488
WHAT IT DOES
No description documented yet.
SIGNATURE
match_patterns(self, patterns, text, prefix)PARAMETERS
self
patterns
text
prefix
meaningful
No description documented yet.
ai/memory_system/extractor.py:548
WHAT IT DOES
No description documented yet.
SIGNATURE
meaningful(self, text)PARAMETERS
self
text
should_save
No description documented yet.
ai/memory_system/extractor.py:577
WHAT IT DOES
No description documented yet.
SIGNATURE
should_save(self, content)PARAMETERS
self
content
MemoryManager
No description documented yet.
9 methods
No description documented yet.
__init__
No description documented yet.
ai/memory_system/manager.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
remember
No description documented yet.
ai/memory_system/manager.py:62
WHAT IT DOES
No description documented yet.
SIGNATURE
remember(self, user_id, content, category = 'general', importance = 5)PARAMETERS
self
user_id
content
category
= 'general'
importance
= 5
recall
No description documented yet.
ai/memory_system/manager.py:160
WHAT IT DOES
No description documented yet.
SIGNATURE
recall(self, user_id, limit = 5, min_importance = 1, categories = None)PARAMETERS
self
user_id
limit
= 5
min_importance
= 1
categories
= None
search
No description documented yet.
ai/memory_system/manager.py:265
WHAT IT DOES
No description documented yet.
SIGNATURE
search(self, user_id, query, limit = 5)PARAMETERS
self
user_id
query
limit
= 5
get_all_memories
No description documented yet.
ai/memory_system/manager.py:368
WHAT IT DOES
No description documented yet.
SIGNATURE
get_all_memories(self, user_id)PARAMETERS
self
user_id
recent
No description documented yet.
ai/memory_system/manager.py:424
WHAT IT DOES
No description documented yet.
SIGNATURE
recent(self, limit = 10)PARAMETERS
self
limit
= 10
delete_memory
No description documented yet.
ai/memory_system/manager.py:472
WHAT IT DOES
No description documented yet.
SIGNATURE
delete_memory(self, memory_id)PARAMETERS
self
memory_id
update_memory
No description documented yet.
ai/memory_system/manager.py:522
WHAT IT DOES
No description documented yet.
SIGNATURE
update_memory(self, memory_id, importance = None, content = None)PARAMETERS
self
memory_id
importance
= None
content
= None
format_for_prompt
No description documented yet.
ai/memory_system/manager.py:598
WHAT IT DOES
No description documented yet.
SIGNATURE
format_for_prompt(self, memories)PARAMETERS
self
memories
ModeSpec
No description documented yet.
1 methods
No description documented yet.
__init__
No description documented yet.
ai/mode_manager.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, name: str, allowed_tools: List[str] = None, instruction_fragment: str = '')PARAMETERS
self
name
str
allowed_tools
List[str]
= None
instruction_fragment
str
= ''
ModeManager
No description documented yet.
4 methods
No description documented yet.
__init__
No description documented yet.
ai/mode_manager.py:21
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
_init_default_modes
No description documented yet.
ai/mode_manager.py:25
WHAT IT DOES
No description documented yet.
SIGNATURE
_init_default_modes(self)PARAMETERS
self
get_mode
No description documented yet.
ai/mode_manager.py:100
WHAT IT DOES
No description documented yet.
SIGNATURE
get_mode(self, name: str) -> ModeSpecPARAMETERS
self
name
str
allowed_tools_for
No description documented yet.
ai/mode_manager.py:106
WHAT IT DOES
No description documented yet.
SIGNATURE
allowed_tools_for(self, name: str)PARAMETERS
self
name
str
OllamaClient
No description documented yet.
4 methods
No description documented yet.
__init__
No description documented yet.
ai/ollama_client.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, base_url: str = 'http://localhost:11434', model: str = 'cyn-x:latest', timeout: int = 600)PARAMETERS
self
base_url
str
= 'http://localhost:11434'
model
str
= 'cyn-x:latest'
timeout
int
= 600
generate
No description documented yet.
ai/ollama_client.py:30
WHAT IT DOES
No description documented yet.
SIGNATURE
generate(self, prompt: str, max_tokens: int = 512, stream: bool = False, **kwargs) -> Dict[str, Any]PARAMETERS
self
prompt
str
max_tokens
int
= 512
stream
bool
= False
**kwargs
chat
Call Ollama's chat endpoint with optional tools.
ai/ollama_client.py:102
WHAT IT DOES
Call Ollama's chat endpoint with optional tools.
SIGNATURE
chat(self, messages: List[Dict[str, Any]], tools: Optional[List[Dict[str, Any]]] = None, stream: bool = False, **kwargs) -> Dict[str, Any]PARAMETERS
self
messages
List[Dict[str, Any]]
tools
Optional[List[Dict[str, Any]]]
= None
stream
bool
= False
**kwargs
generate_stream
No description documented yet.
ai/ollama_client.py:304
WHAT IT DOES
No description documented yet.
SIGNATURE
generate_stream(self, prompt: str, max_tokens: int = 512, **kwargs) -> Generator[str, None, None]PARAMETERS
self
prompt
str
max_tokens
int
= 512
**kwargs
PromptBuilder
No description documented yet.
12 methods
No description documented yet.
__init__
No description documented yet.
ai/prompt_builder.py:226
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, templates_dir: Optional[str] = None)PARAMETERS
self
templates_dir
Optional[str]
= None
normalize_prompt_layers
No description documented yet.
ai/prompt_builder.py:244
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_prompt_layers(self, prompt_layers: Optional[Dict[str, bool]] = None) -> Dict[str, bool]PARAMETERS
self
prompt_layers
Optional[Dict[str, bool]]
= None
set_prompt_layers
No description documented yet.
ai/prompt_builder.py:266
WHAT IT DOES
No description documented yet.
SIGNATURE
set_prompt_layers(self, prompt_layers: Optional[Dict[str, bool]] = None) -> Dict[str, bool]PARAMETERS
self
prompt_layers
Optional[Dict[str, bool]]
= None
get_prompt_layers
No description documented yet.
ai/prompt_builder.py:282
WHAT IT DOES
No description documented yet.
SIGNATURE
get_prompt_layers(self) -> Dict[str, bool]PARAMETERS
self
apply_prompt_preset
No description documented yet.
ai/prompt_builder.py:291
WHAT IT DOES
No description documented yet.
SIGNATURE
apply_prompt_preset(self, preset: str) -> Dict[str, bool]PARAMETERS
self
preset
str
trim_context
No description documented yet.
ai/prompt_builder.py:311
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_context(self, text: str, limit: int) -> strPARAMETERS
self
text
str
limit
int
should_include_context
No description documented yet.
ai/prompt_builder.py:339
WHAT IT DOES
No description documented yet.
SIGNATURE
should_include_context(self, text: str) -> boolPARAMETERS
self
text
str
score_context
No description documented yet.
ai/prompt_builder.py:360
WHAT IT DOES
No description documented yet.
SIGNATURE
score_context(self, chunk: str, query: str) -> intPARAMETERS
self
chunk
str
query
str
select_context
No description documented yet.
ai/prompt_builder.py:397
WHAT IT DOES
No description documented yet.
SIGNATURE
select_context(self, chunks: List[str], query: str, limit: int) -> strPARAMETERS
self
chunks
List[str]
query
str
limit
int
build_system_prompt
No description documented yet.
ai/prompt_builder.py:472
WHAT IT DOES
No description documented yet.
SIGNATURE
build_system_prompt(self, modes: Optional[List[str]] = None, memory: str = '', context: str = '', prompt_layers: Optional[Dict[str, bool]] = None) -> strPARAMETERS
self
modes
Optional[List[str]]
= None
memory
str
= ''
context
str
= ''
prompt_layers
Optional[Dict[str, bool]]
= None
budget_context
No description documented yet.
ai/prompt_builder.py:551
WHAT IT DOES
No description documented yet.
SIGNATURE
budget_context(self, sections: List[Dict[str, Any]]) -> List[str]PARAMETERS
self
sections
List[Dict[str, Any]]
build_prompt
No description documented yet.
ai/prompt_builder.py:688
WHAT IT DOES
No description documented yet.
SIGNATURE
build_prompt(self, user_input: str, mode_fragment: str = '', personality_fragment: str = '', history: Optional[List[dict]] = None, memory_summary: str = '', knowledge_context: str = '', tools_spec: str = '', intent: str = '', conversation_summary: str = '', prompt_layers: Optional[Dict[str, bool]] = None) -> strPARAMETERS
self
user_input
str
mode_fragment
str
= ''
personality_fragment
str
= ''
history
Optional[List[dict]]
= None
memory_summary
str
= ''
knowledge_context
str
= ''
tools_spec
str
= ''
intent
str
= ''
conversation_summary
str
= ''
prompt_layers
Optional[Dict[str, bool]]
= None
PromptManager
No description documented yet.
10 methods
No description documented yet.
__init__
No description documented yet.
ai/prompt_manager.py:97
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, prompts_dir: Optional[str] = None)PARAMETERS
self
prompts_dir
Optional[str]
= None
normalize_prompt_layers
No description documented yet.
ai/prompt_manager.py:151
WHAT IT DOES
No description documented yet.
SIGNATURE
normalize_prompt_layers(self, enabled_layers = None)PARAMETERS
self
enabled_layers
= None
_load_file
No description documented yet.
ai/prompt_manager.py:182
WHAT IT DOES
No description documented yet.
SIGNATURE
_load_file(self, path: Path)PARAMETERS
self
path
Path
trim_text
No description documented yet.
ai/prompt_manager.py:220
WHAT IT DOES
No description documented yet.
SIGNATURE
trim_text(self, text, limit)PARAMETERS
self
text
limit
load_core_prompts
No description documented yet.
ai/prompt_manager.py:254
WHAT IT DOES
No description documented yet.
SIGNATURE
load_core_prompts(self)PARAMETERS
self
load_personality_matrix
No description documented yet.
ai/prompt_manager.py:364
WHAT IT DOES
No description documented yet.
SIGNATURE
load_personality_matrix(self)PARAMETERS
self
load_optional
No description documented yet.
ai/prompt_manager.py:408
WHAT IT DOES
No description documented yet.
SIGNATURE
load_optional(self, name)PARAMETERS
self
name
load_option
No description documented yet.
ai/prompt_manager.py:441
WHAT IT DOES
No description documented yet.
SIGNATURE
load_option(self, name)PARAMETERS
self
name
load_mode
No description documented yet.
ai/prompt_manager.py:474
WHAT IT DOES
No description documented yet.
SIGNATURE
load_mode(self, mode_name)PARAMETERS
self
mode_name
build_system_prompt
No description documented yet.
ai/prompt_manager.py:519
WHAT IT DOES
No description documented yet.
SIGNATURE
build_system_prompt(self, active_modes = None, active_options = None, memory_summary = '', additional_context = '', include_safety = True, enabled_layers = None)PARAMETERS
self
active_modes
= None
active_options
= None
memory_summary
= ''
additional_context
= ''
include_safety
= True
enabled_layers
= None
CYNXTerminal
No description documented yet.
22 methods
No description documented yet.
__init__
No description documented yet.
ai/terminal_ui/renderer.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
_print_label
No description documented yet.
ai/terminal_ui/renderer.py:40
WHAT IT DOES
No description documented yet.
SIGNATURE
_print_label(self, label, value = None, style, value_style = 'white')PARAMETERS
self
label
value
= None
style
value_style
= 'white'
section
No description documented yet.
ai/terminal_ui/renderer.py:48
WHAT IT DOES
No description documented yet.
SIGNATURE
section(self, title)PARAMETERS
self
title
info
No description documented yet.
ai/terminal_ui/renderer.py:51
WHAT IT DOES
No description documented yet.
SIGNATURE
info(self, message)PARAMETERS
self
message
memory
No description documented yet.
ai/terminal_ui/renderer.py:54
WHAT IT DOES
No description documented yet.
SIGNATURE
memory(self, message)PARAMETERS
self
message
warning
No description documented yet.
ai/terminal_ui/renderer.py:57
WHAT IT DOES
No description documented yet.
SIGNATURE
warning(self, message)PARAMETERS
self
message
error
No description documented yet.
ai/terminal_ui/renderer.py:60
WHAT IT DOES
No description documented yet.
SIGNATURE
error(self, message)PARAMETERS
self
message
dim
No description documented yet.
ai/terminal_ui/renderer.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
dim(self, message)PARAMETERS
self
message
user
No description documented yet.
ai/terminal_ui/renderer.py:66
WHAT IT DOES
No description documented yet.
SIGNATURE
user(self, message)PARAMETERS
self
message
ollama
No description documented yet.
ai/terminal_ui/renderer.py:69
WHAT IT DOES
No description documented yet.
SIGNATURE
ollama(self, label = 'OLLAMA CALL', value = None)PARAMETERS
self
label
= 'OLLAMA CALL'
value
= None
model
No description documented yet.
ai/terminal_ui/renderer.py:72
WHAT IT DOES
No description documented yet.
SIGNATURE
model(self, label = 'MODEL RESPONSE', value = None)PARAMETERS
self
label
= 'MODEL RESPONSE'
value
= None
tool
No description documented yet.
ai/terminal_ui/renderer.py:75
WHAT IT DOES
No description documented yet.
SIGNATURE
tool(self, label = 'TOOL CALL', value = None)PARAMETERS
self
label
= 'TOOL CALL'
value
= None
tool_args
No description documented yet.
ai/terminal_ui/renderer.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
tool_args(self, label = 'TOOL ARGUMENTS', value = None)PARAMETERS
self
label
= 'TOOL ARGUMENTS'
value
= None
execute
No description documented yet.
ai/terminal_ui/renderer.py:81
WHAT IT DOES
No description documented yet.
SIGNATURE
execute(self, label = 'EXECUTING TOOL', value = None)PARAMETERS
self
label
= 'EXECUTING TOOL'
value
= None
result
No description documented yet.
ai/terminal_ui/renderer.py:84
WHAT IT DOES
No description documented yet.
SIGNATURE
result(self, label = 'TOOL RESULT', value = None)PARAMETERS
self
label
= 'TOOL RESULT'
value
= None
prompt
No description documented yet.
ai/terminal_ui/renderer.py:87
WHAT IT DOES
No description documented yet.
SIGNATURE
prompt(self, label = 'PROMPT SECTION', value = None)PARAMETERS
self
label
= 'PROMPT SECTION'
value
= None
final_prompt
No description documented yet.
ai/terminal_ui/renderer.py:90
WHAT IT DOES
No description documented yet.
SIGNATURE
final_prompt(self, label = 'FINAL SYSTEM PROMPT', value = None)PARAMETERS
self
label
= 'FINAL SYSTEM PROMPT'
value
= None
available_tools
No description documented yet.
ai/terminal_ui/renderer.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
available_tools(self, tools)PARAMETERS
self
tools
json
No description documented yet.
ai/terminal_ui/renderer.py:96
WHAT IT DOES
No description documented yet.
SIGNATURE
json(self, payload)PARAMETERS
self
payload
timing
No description documented yet.
ai/terminal_ui/renderer.py:102
WHAT IT DOES
No description documented yet.
SIGNATURE
timing(self, message)PARAMETERS
self
message
memory_error
No description documented yet.
ai/terminal_ui/renderer.py:105
WHAT IT DOES
No description documented yet.
SIGNATURE
memory_error(self, message)PARAMETERS
self
message
blank
No description documented yet.
ai/terminal_ui/renderer.py:108
WHAT IT DOES
No description documented yet.
SIGNATURE
blank(self)PARAMETERS
self
Parameter
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
FunctionInfo
No description documented yet.
2 methods
No description documented yet.
qualified_name
No description documented yet.
barkly_docs.py:146
WHAT IT DOES
No description documented yet.
SIGNATURE
qualified_name(self) -> strPARAMETERS
self
DECORATORS
signature
No description documented yet.
barkly_docs.py:152
WHAT IT DOES
No description documented yet.
SIGNATURE
signature(self) -> strPARAMETERS
self
DECORATORS
ClassInfo
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
EndpointInfo
No description documented yet.
1 methods
No description documented yet.
method_text
No description documented yet.
barkly_docs.py:202
WHAT IT DOES
No description documented yet.
SIGNATURE
method_text(self) -> strPARAMETERS
self
DECORATORS
ModuleInfo
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
PythonScanner
No description documented yet.
7 methods
No description documented yet.
__init__
No description documented yet.
barkly_docs.py:592
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, root: Path)PARAMETERS
self
root
Path
scan
No description documented yet.
barkly_docs.py:600
WHAT IT DOES
No description documented yet.
SIGNATURE
scan(self) -> NonePARAMETERS
self
scan_file
No description documented yet.
barkly_docs.py:607
WHAT IT DOES
No description documented yet.
SIGNATURE
scan_file(self, path: Path) -> NonePARAMETERS
self
path
Path
function_node_for_class_method
No description documented yet.
barkly_docs.py:665
WHAT IT DOES
No description documented yet.
SIGNATURE
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]PARAMETERS
self
class_node
ast.ClassDef
method_name
str
make_function
No description documented yet.
barkly_docs.py:680
WHAT IT DOES
No description documented yet.
SIGNATURE
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfoPARAMETERS
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
make_class
No description documented yet.
barkly_docs.py:699
WHAT IT DOES
No description documented yet.
SIGNATURE
make_class(self, node: ast.ClassDef, file: str) -> ClassInfoPARAMETERS
self
node
ast.ClassDef
file
str
find_endpoints
No description documented yet.
barkly_docs.py:729
WHAT IT DOES
No description documented yet.
SIGNATURE
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> NonePARAMETERS
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
BenchmarkCleaner
No description documented yet.
8 methods
No description documented yet.
__init__
No description documented yet.
benchmark/cleaner.py:99
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, execute: bool = False, remove_temp: bool = False)PARAMETERS
self
execute
bool
= False
remove_temp
bool
= False
show_delete
No description documented yet.
benchmark/cleaner.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
show_delete(self, path: Path)PARAMETERS
self
path
Path
is_protected
No description documented yet.
benchmark/cleaner.py:150
WHAT IT DOES
No description documented yet.
SIGNATURE
is_protected(self, path: Path) -> boolPARAMETERS
self
path
Path
clean_results
No description documented yet.
benchmark/cleaner.py:210
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_results(self)PARAMETERS
self
clean_temp_files
No description documented yet.
benchmark/cleaner.py:255
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_temp_files(self)PARAMETERS
self
clean_empty_directories
No description documented yet.
benchmark/cleaner.py:304
WHAT IT DOES
No description documented yet.
SIGNATURE
clean_empty_directories(self)PARAMETERS
self
print_protected_info
No description documented yet.
benchmark/cleaner.py:361
WHAT IT DOES
No description documented yet.
SIGNATURE
print_protected_info(self)PARAMETERS
self
summary
No description documented yet.
benchmark/cleaner.py:393
WHAT IT DOES
No description documented yet.
SIGNATURE
summary(self)PARAMETERS
self
BenchmarkStorage
No description documented yet.
5 methods
No description documented yet.
__init__
No description documented yet.
benchmark/runner.py:754
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
save_test
No description documented yet.
benchmark/runner.py:775
WHAT IT DOES
No description documented yet.
SIGNATURE
save_test(self, result)PARAMETERS
self
result
add
No description documented yet.
benchmark/runner.py:950
WHAT IT DOES
No description documented yet.
SIGNATURE
add(self, result)PARAMETERS
self
result
save_raw
No description documented yet.
benchmark/runner.py:967
WHAT IT DOES
No description documented yet.
SIGNATURE
save_raw(self)PARAMETERS
self
save_summary
No description documented yet.
benchmark/runner.py:1034
WHAT IT DOES
No description documented yet.
SIGNATURE
save_summary(self)PARAMETERS
self
Config
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
LeproConfig
Stores Lepro devices configured for CYN-X.
6 methods
Stores Lepro devices configured for CYN-X.
__init__
No description documented yet.
hardware/lepro/config.py:11
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, path: Path) -> NonePARAMETERS
self
path
Path
load
No description documented yet.
hardware/lepro/config.py:14
WHAT IT DOES
No description documented yet.
SIGNATURE
load(self) -> dict[str, Any]PARAMETERS
self
save
No description documented yet.
hardware/lepro/config.py:31
WHAT IT DOES
No description documented yet.
SIGNATURE
save(self, data: dict[str, Any]) -> NonePARAMETERS
self
data
dict[str, Any]
add_device
No description documented yet.
hardware/lepro/config.py:42
WHAT IT DOES
No description documented yet.
SIGNATURE
add_device(self, name: str, mac: str, device_type: str = 'lepro', discovered_name: str | None = None) -> dict[str, Any]PARAMETERS
self
name
str
mac
str
device_type
str
= 'lepro'
discovered_name
str | None
= None
get_device
No description documented yet.
hardware/lepro/config.py:68
WHAT IT DOES
No description documented yet.
SIGNATURE
get_device(self, name: str) -> dict[str, Any] | NonePARAMETERS
self
name
str
list_devices
No description documented yet.
hardware/lepro/config.py:75
WHAT IT DOES
No description documented yet.
SIGNATURE
list_devices(self) -> list[dict[str, Any]]PARAMETERS
self
LeproDevice
CYN-X interface for a physical Lepro Bluetooth device.
11 methods
CYN-X interface for a physical Lepro Bluetooth device.
__init__
No description documented yet.
hardware/lepro/devices.py:29
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, name: str, mac: str)PARAMETERS
self
name
str
mac
str
has_credentials
Return True if this device has been bonded.
hardware/lepro/devices.py:37
WHAT IT DOES
Return True if this device has been bonded.
SIGNATURE
has_credentials(self) -> boolPARAMETERS
self
credential_path
Return the path where Lepro stores this device's credentials.
hardware/lepro/devices.py:41
WHAT IT DOES
Return the path where Lepro stores this device's credentials.
SIGNATURE
credential_path(self)PARAMETERS
self
connect
Connect to the physical Lepro device.
hardware/lepro/devices.py:49
WHAT IT DOES
Connect to the physical Lepro device.
SIGNATURE
connect(self)PARAMETERS
self
bond
Bond this device with CYN-X.
hardware/lepro/devices.py:57
WHAT IT DOES
Bond this device with CYN-X.
SIGNATURE
bond(self, force: bool = False) -> AnyPARAMETERS
self
force
bool
= False
_run_control
Send a datapoint control payload to the device.
hardware/lepro/devices.py:80
WHAT IT DOES
Send a datapoint control payload to the device.
SIGNATURE
_run_control(self, payload: dict[str, Any] | list[str]) -> AnyPARAMETERS
self
payload
dict[str, Any] | list[str]
turn_on
Turn the light on.
hardware/lepro/devices.py:114
WHAT IT DOES
Turn the light on.
SIGNATURE
turn_on(self, brightness: int = 1000) -> AnyPARAMETERS
self
brightness
int
= 1000
turn_off
Turn the light off.
hardware/lepro/devices.py:126
WHAT IT DOES
Turn the light off.
SIGNATURE
turn_off(self) -> AnyPARAMETERS
self
set_color_rgb
Set the light color using RGB values.
hardware/lepro/devices.py:137
WHAT IT DOES
Set the light color using RGB values.
SIGNATURE
set_color_rgb(self, red: int, green: int, blue: int, brightness: int = 1000) -> AnyPARAMETERS
self
red
int
green
int
blue
int
brightness
int
= 1000
set_color_hsv
Set the light color using HSV values.
hardware/lepro/devices.py:155
WHAT IT DOES
Set the light color using HSV values.
SIGNATURE
set_color_hsv(self, hue: float, saturation: int = 1000, value: int = 1000, brightness: int = 1000) -> AnyPARAMETERS
self
hue
float
saturation
int
= 1000
value
int
= 1000
brightness
int
= 1000
get_status
Query the current datapoint state of the light. This uses the upstream Lepro protocol directly without modifying the upstream lib…
hardware/lepro/devices.py:177
WHAT IT DOES
Query the current datapoint state of the light. This uses the upstream Lepro protocol directly without modifying the upstream library.
SIGNATURE
get_status(self) -> dict[str, Any]PARAMETERS
self
LeproDiscovery
Find nearby Lepro Bluetooth devices.
2 methods
Find nearby Lepro Bluetooth devices.
__init__
No description documented yet.
hardware/lepro/discovery.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, timeout: float = 15.0)PARAMETERS
self
timeout
float
= 15.0
scan
No description documented yet.
hardware/lepro/discovery.py:18
WHAT IT DOES
No description documented yet.
SIGNATURE
scan(self) -> list[dict[str, Any]]PARAMETERS
self
BondTokens
No description documented yet.
3 methods
No description documented yet.
validate
No description documented yet.
hardware/lepro/lib/lepro/bond.py:50
WHAT IT DOES
No description documented yet.
SIGNATURE
validate(self) -> NonePARAMETERS
self
to_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:57
WHAT IT DOES
No description documented yet.
SIGNATURE
to_dict(self) -> dict[str, str]PARAMETERS
self
from_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:61
WHAT IT DOES
No description documented yet.
SIGNATURE
from_dict(cls, d: dict[str, str]) -> BondTokensPARAMETERS
cls
d
dict[str, str]
DECORATORS
BondCredentials
No description documented yet.
3 methods
No description documented yet.
__post_init__
No description documented yet.
hardware/lepro/lib/lepro/bond.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
__post_init__(self) -> NonePARAMETERS
self
to_json_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:83
WHAT IT DOES
No description documented yet.
SIGNATURE
to_json_dict(self) -> dictPARAMETERS
self
from_json_dict
No description documented yet.
hardware/lepro/lib/lepro/bond.py:92
WHAT IT DOES
No description documented yet.
SIGNATURE
from_json_dict(cls, d: dict) -> BondCredentialsPARAMETERS
cls
d
dict
DECORATORS
BondHarvestError
Bond or token step failed.
0 methods
Bond or token step failed.
No methods discovered.
DeviceConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
LabConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
WifiConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
BridgeConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
LeproLabConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
BytePatch
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
BundleConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
FirmwareProfile
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
PatchProfiles
No description documented yet.
1 methods
No description documented yet.
by_id
No description documented yet.
hardware/lepro/lib/lepro/firmware_profile.py:53
WHAT IT DOES
No description documented yet.
SIGNATURE
by_id(self, profile_id: str) -> FirmwareProfilePARAMETERS
self
profile_id
str
DecryptedFrame
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
RxAssembler
Reassemble fragmented RX packets and optionally decrypt.
8 methods
Reassemble fragmented RX packets and optionally decrypt.
__init__
No description documented yet.
hardware/lepro/lib/lepro/frame.py:76
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, mac: str, session_rand: int | None = None) -> NonePARAMETERS
self
mac
str
session_rand
int | None
= None
set_session_rand
Update key after 0x1000 hello reveals bleInit rand() in ctx1.
hardware/lepro/lib/lepro/frame.py:90
WHAT IT DOES
Update key after 0x1000 hello reveals bleInit rand() in ctx1.
SIGNATURE
set_session_rand(self, session_rand: int) -> NonePARAMETERS
self
session_rand
int
feed
No description documented yet.
hardware/lepro/lib/lepro/frame.py:95
WHAT IT DOES
No description documented yet.
SIGNATURE
feed(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_reset_fragment
No description documented yet.
hardware/lepro/lib/lepro/frame.py:111
WHAT IT DOES
No description documented yet.
SIGNATURE
_reset_fragment(self) -> NonePARAMETERS
self
_feed_fragment
No description documented yet.
hardware/lepro/lib/lepro/frame.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
_feed_fragment(self, raw: bytes, magic2: int) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
magic2
int
_dispatch_single
No description documented yet.
hardware/lepro/lib/lepro/frame.py:176
WHAT IT DOES
No description documented yet.
SIGNATURE
_dispatch_single(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_maybe_decrypt
No description documented yet.
hardware/lepro/lib/lepro/frame.py:188
WHAT IT DOES
No description documented yet.
SIGNATURE
_maybe_decrypt(self, frame: DecryptedFrame) -> DecryptedFramePARAMETERS
self
frame
DecryptedFrame
_synthetic_body
No description documented yet.
hardware/lepro/lib/lepro/frame.py:206
WHAT IT DOES
No description documented yet.
SIGNATURE
_synthetic_body(seq: int, magic2: int, ptype: int, subtype: int, payload: bytes) -> bytesPARAMETERS
seq
int
magic2
int
ptype
int
subtype
int
payload
bytes
DECORATORS
OtaStartResponse
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
OtaDataResponse
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
ModeSpec
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
OtaTransferResult
Outcome of the BLE OTA data phase.
2 methods
Outcome of the BLE OTA data phase.
finalize_code
No description documented yet.
hardware/lepro/lib/lepro/ota.py:113
WHAT IT DOES
No description documented yet.
SIGNATURE
finalize_code(self) -> int | NonePARAMETERS
self
DECORATORS
transfer_complete
No description documented yet.
hardware/lepro/lib/lepro/ota.py:117
WHAT IT DOES
No description documented yet.
SIGNATURE
transfer_complete(self) -> boolPARAMETERS
self
DECORATORS
OtaConfirmVerdict
Post-reboot discovery verdict.
0 methods
Post-reboot discovery verdict.
No methods discovered.
OtaLog
Timestamped, flushed stdout logging for long OTA runs.
3 methods
Timestamped, flushed stdout logging for long OTA runs.
info
No description documented yet.
hardware/lepro/lib/lepro/ota.py:138
WHAT IT DOES
No description documented yet.
SIGNATURE
info(self, msg: str) -> NonePARAMETERS
self
msg
str
phase
No description documented yet.
hardware/lepro/lib/lepro/ota.py:144
WHAT IT DOES
No description documented yet.
SIGNATURE
phase(self, name: str) -> NonePARAMETERS
self
name
str
wait
No description documented yet.
hardware/lepro/lib/lepro/ota.py:147
WHAT IT DOES
No description documented yet.
SIGNATURE
wait(self, msg: str, timeout: float) -> NonePARAMETERS
self
msg
str
timeout
float
OtaTransport
BLE transport with compact or full TX/RX logging.
2 methods
BLE transport with compact or full TX/RX logging.
on_notify
No description documented yet.
hardware/lepro/lib/lepro/ota.py:159
WHAT IT DOES
No description documented yet.
SIGNATURE
on_notify(self, _sender: object, data: bytearray) -> NonePARAMETERS
self
_sender
object
data
bytearray
send
No description documented yet.
hardware/lepro/lib/lepro/ota.py:165
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
BleOtaSession
Discovery + auth + chunked OTA transfer.
2 methods
Discovery + auth + chunked OTA transfer.
__init__
No description documented yet.
hardware/lepro/lib/lepro/ota.py:954
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, session: LeproSession, firmware: Path, image: bytes, log: OtaLog) -> NonePARAMETERS
self
session
LeproSession
firmware
Path
image
bytes
log
OtaLog
run
No description documented yet.
hardware/lepro/lib/lepro/ota.py:966
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self, json_bytes: bytes, chunk_size: int = 4096, max_retries: int = 3, dry_run: bool = False) -> OtaTransferResultPARAMETERS
self
json_bytes
bytes
chunk_size
int
= 4096
max_retries
int
= 3
dry_run
bool
= False
BundleLayout
No description documented yet.
1 methods
No description documented yet.
record_len
No description documented yet.
hardware/lepro/lib/lepro/patch_cdn.py:78
WHAT IT DOES
No description documented yet.
SIGNATURE
record_len(self) -> intPARAMETERS
self
DECORATORS
PatchResult
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
PacketHeader
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
SessionConfig
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
DeviceInfo
No description documented yet.
3 methods
No description documented yet.
prov_state
OTA/provisioning state-machine value (device-info byte[1] = ota_ctx+0x10).
hardware/lepro/lib/lepro/session.py:71
WHAT IT DOES
OTA/provisioning state-machine value (device-info byte[1] = ota_ctx+0x10).
SIGNATURE
prov_state(self) -> int | NonePARAMETERS
self
DECORATORS
prov_slot
Retained provisioning flag (device-info byte[2], from ota_ctx slot 0x42000b3c). Verified in ZB1 v2.3.18 build_device_info_reply:…
hardware/lepro/lib/lepro/session.py:76
WHAT IT DOES
Retained provisioning flag (device-info byte[2], from ota_ctx slot 0x42000b3c). Verified in ZB1 v2.3.18 build_device_info_reply: 6 = addable/onboarding (slot unset or factory), 7 = provisioned. NOTE: a power-cycle reset re-enters onboarding via the reboot counter WITHOUT clearing this slot, so a 7 here does NOT prove the CDN cert fetch is disabled — it is only conclusive when 6.
SIGNATURE
prov_slot(self) -> int | NonePARAMETERS
self
DECORATORS
provisioning_summary
One-line human-readable provisioning/cert-fetch status for CLI output.
hardware/lepro/lib/lepro/session.py:87
WHAT IT DOES
One-line human-readable provisioning/cert-fetch status for CLI output.
SIGNATURE
provisioning_summary(self) -> strPARAMETERS
self
Transport
No description documented yet.
3 methods
No description documented yet.
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:105
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:106
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:107
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
DryRunTransport
Collect TX packets without BLE.
3 methods
Collect TX packets without BLE.
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:116
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:119
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:122
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
BleakTransport
No description documented yet.
4 methods
No description documented yet.
on_notify
No description documented yet.
hardware/lepro/lib/lepro/session.py:134
WHAT IT DOES
No description documented yet.
SIGNATURE
on_notify(self, _sender: object, data: bytearray) -> NonePARAMETERS
self
_sender
object
data
bytearray
send
No description documented yet.
hardware/lepro/lib/lepro/session.py:140
WHAT IT DOES
No description documented yet.
SIGNATURE
send(self, data: bytes, label: str = '') -> NonePARAMETERS
self
data
bytes
label
str
= ''
recv
No description documented yet.
hardware/lepro/lib/lepro/session.py:145
WHAT IT DOES
No description documented yet.
SIGNATURE
recv(self, timeout: float) -> bytes | NonePARAMETERS
self
timeout
float
drain
No description documented yet.
hardware/lepro/lib/lepro/session.py:151
WHAT IT DOES
No description documented yet.
SIGNATURE
drain(self, timeout: float) -> list[bytes]PARAMETERS
self
timeout
float
LeproSession
No description documented yet.
18 methods
No description documented yet.
__init__
No description documented yet.
hardware/lepro/lib/lepro/session.py:167
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, mac: str, transport: Transport, config: SessionConfig | None = None) -> NonePARAMETERS
self
mac
str
transport
Transport
config
SessionConfig | None
= None
_require_session_rand
No description documented yet.
hardware/lepro/lib/lepro/session.py:183
WHAT IT DOES
No description documented yet.
SIGNATURE
_require_session_rand(self) -> intPARAMETERS
self
_send
No description documented yet.
hardware/lepro/lib/lepro/session.py:188
WHAT IT DOES
No description documented yet.
SIGNATURE
_send(self, pkt: bytes, label: str = '') -> NonePARAMETERS
self
pkt
bytes
label
str
= ''
_next_seq
No description documented yet.
hardware/lepro/lib/lepro/session.py:192
WHAT IT DOES
No description documented yet.
SIGNATURE
_next_seq(self) -> intPARAMETERS
self
_ingest_rx
No description documented yet.
hardware/lepro/lib/lepro/session.py:197
WHAT IT DOES
No description documented yet.
SIGNATURE
_ingest_rx(self, raw: bytes) -> list[DecryptedFrame]PARAMETERS
self
raw
bytes
_wait_opcode
No description documented yet.
hardware/lepro/lib/lepro/session.py:203
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_opcode(self, opcode: int, timeout: float | None = None) -> DecryptedFramePARAMETERS
self
opcode
int
timeout
float | None
= None
_wait_any
No description documented yet.
hardware/lepro/lib/lepro/session.py:217
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_any(self, opcodes: set[int], timeout: float) -> DecryptedFramePARAMETERS
self
opcodes
set[int]
timeout
float
run_phase_discovery
No description documented yet.
hardware/lepro/lib/lepro/session.py:231
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_discovery(self) -> DeviceInfoPARAMETERS
self
_wait_new_auth_resp
No description documented yet.
hardware/lepro/lib/lepro/session.py:269
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_new_auth_resp(self, after_count: int, timeout: float) -> DecryptedFramePARAMETERS
self
after_count
int
timeout
float
_request_bond
No description documented yet.
hardware/lepro/lib/lepro/session.py:285
WHAT IT DOES
No description documented yet.
SIGNATURE
_request_bond(self, payload: bytes, label: str) -> DecryptedFramePARAMETERS
self
payload
bytes
label
str
run_phase_bond
No description documented yet.
hardware/lepro/lib/lepro/session.py:290
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_bond(self, fallback_hs: bytes | None = None) -> BondTokensPARAMETERS
self
fallback_hs
bytes | None
= None
_wait_auth_resp
No description documented yet.
hardware/lepro/lib/lepro/session.py:321
WHAT IT DOES
No description documented yet.
SIGNATURE
_wait_auth_resp(self, timeout: float | None = None) -> DecryptedFramePARAMETERS
self
timeout
float | None
= None
run_phase_auth
No description documented yet.
hardware/lepro/lib/lepro/session.py:324
WHAT IT DOES
No description documented yet.
SIGNATURE
run_phase_auth(self, creds: BondCredentials) -> NonePARAMETERS
self
creds
BondCredentials
send_dp_ciphertext
No description documented yet.
hardware/lepro/lib/lepro/session.py:339
WHAT IT DOES
No description documented yet.
SIGNATURE
send_dp_ciphertext(self, ciphertext: bytes) -> NonePARAMETERS
self
ciphertext
bytes
send_dp_payload
No description documented yet.
hardware/lepro/lib/lepro/session.py:345
WHAT IT DOES
No description documented yet.
SIGNATURE
send_dp_payload(self, payload: DpPayload) -> NonePARAMETERS
self
payload
DpPayload
send_get_dp_state
No description documented yet.
hardware/lepro/lib/lepro/session.py:353
WHAT IT DOES
No description documented yet.
SIGNATURE
send_get_dp_state(self, payload: DpPayload) -> DecryptedFramePARAMETERS
self
payload
DpPayload
commit_control
No description documented yet.
hardware/lepro/lib/lepro/session.py:360
WHAT IT DOES
No description documented yet.
SIGNATURE
commit_control(self, creds: BondCredentials) -> NonePARAMETERS
self
creds
BondCredentials
run_control
Full control session. pre_bulk_pages is only for large scene uploads (capture 11:17 colour).
hardware/lepro/lib/lepro/session.py:379
WHAT IT DOES
Full control session. pre_bulk_pages is only for large scene uploads (capture 11:17 colour).
SIGNATURE
run_control(self, creds: BondCredentials, dp_payload: DpPayload, pre_bulk_pages: list[bytes] | None = None) -> NonePARAMETERS
self
creds
BondCredentials
dp_payload
DpPayload
pre_bulk_pages
list[bytes] | None
= None
Segment
No description documented yet.
2 methods
No description documented yet.
p_flags
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:48
WHAT IT DOES
No description documented yet.
SIGNATURE
p_flags(self) -> intPARAMETERS
self
DECORATORS
sh_flags
No description documented yet.
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py:63
WHAT IT DOES
No description documented yet.
SIGNATURE
sh_flags(self) -> intPARAMETERS
self
DECORATORS
Elf32
No description documented yet.
5 methods
No description documented yet.
__init__
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:123
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, data: bytes) -> NonePARAMETERS
self
data
bytes
u32
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:131
WHAT IT DOES
No description documented yet.
SIGNATURE
u32(self, off: int) -> intPARAMETERS
self
off
int
vma_to_offset
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:134
WHAT IT DOES
No description documented yet.
SIGNATURE
vma_to_offset(self, vma: int) -> int | NonePARAMETERS
self
vma
int
read_cstr
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:146
WHAT IT DOES
No description documented yet.
SIGNATURE
read_cstr(self, vma: int) -> str | NonePARAMETERS
self
vma
int
pool_strings
No description documented yet.
hardware/lepro/lib/lepro/tools/validate_ota_parser.py:153
WHAT IT DOES
No description documented yet.
SIGNATURE
pool_strings(self, pool_vma: int, count: int) -> list[tuple[int, int, str | None]]PARAMETERS
self
pool_vma
int
count
int
LeproSetup
Interactive setup process for Lepro devices.
3 methods
Interactive setup process for Lepro devices.
__init__
No description documented yet.
hardware/lepro/setup.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, base_dir: Path | None = None)PARAMETERS
self
base_dir
Path | None
= None
run
No description documented yet.
hardware/lepro/setup.py:28
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self) -> dict[str, Any]PARAMETERS
self
fail
No description documented yet.
hardware/lepro/setup.py:254
WHAT IT DOES
No description documented yet.
SIGNATURE
fail(stage: str, message: str) -> dict[str, Any]PARAMETERS
stage
str
message
str
DECORATORS
DiscordAdapter
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
interfaces/discord_bot.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
start
No description documented yet.
interfaces/discord_bot.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
start(self)PARAMETERS
self
TerminalAdapter
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
interfaces/terminal.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
run
No description documented yet.
interfaces/terminal.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
run(self)PARAMETERS
self
WebUIAdapter
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
interfaces/web_ui.py:6
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, chat_engine, logger = None)PARAMETERS
self
chat_engine
logger
= None
start
No description documented yet.
interfaces/web_ui.py:10
WHAT IT DOES
No description documented yet.
SIGNATURE
start(self, host = '127.0.0.1', port = 8000)PARAMETERS
self
host
= '127.0.0.1'
port
= 8000
EmbeddingsProvider
No description documented yet.
4 methods
No description documented yet.
__init__
No description documented yet.
memory/embeddings.py:9
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
embed
No description documented yet.
memory/embeddings.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
embed(self, texts: List[str]) -> List[List[float]]PARAMETERS
self
texts
List[str]
store_embeddings
No description documented yet.
memory/embeddings.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
store_embeddings(self, ids: List[int], vectors: List[List[float]])PARAMETERS
self
ids
List[int]
vectors
List[List[float]]
query
No description documented yet.
memory/embeddings.py:18
WHAT IT DOES
No description documented yet.
SIGNATURE
query(self, vector: List[float], top_k: int = 5)PARAMETERS
self
vector
List[float]
top_k
int
= 5
MemoryManager
No description documented yet.
1 methods
No description documented yet.
__init__
No description documented yet.
memory/memory.py:23
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, conn)PARAMETERS
self
conn
ToolResult
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
BaseTool
No description documented yet.
1 methods
No description documented yet.
call
No description documented yet.
tools/base.py:19
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
CalculatorTool
No description documented yet.
2 methods
No description documented yet.
_safe_eval
No description documented yet.
tools/calculator.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
_safe_eval(self, expr: str) -> floatPARAMETERS
self
expr
str
call
No description documented yet.
tools/calculator.py:23
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
ChartTool
General-purpose CYN-X visualization tool. The output is a structured object intended for the frontend.
18 methods
General-purpose CYN-X visualization tool.
The output is a structured object intended for the frontend.
call
Main BaseTool entry point. ToolRouter calls: tool.call(args) and expects a ToolResult.
tools/chart_tool.py:68
WHAT IT DOES
Main BaseTool entry point. ToolRouter calls: tool.call(args) and expects a ToolResult.
SIGNATURE
call(self, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
args
Dict[str, Any]
create_chart
Create one complete chart specification.
tools/chart_tool.py:140
WHAT IT DOES
Create one complete chart specification.
SIGNATURE
create_chart(self, chart_type: str, title: str, data: List[Dict[str, Any]], x_key: str | None = None, series: List[Dict[str, Any]] | None = None, description: str | None = None, footer: str | None = None, x_axis_label: str | None = None, x_axis_scale: str | None = None, y_axis_min: float | None = None, y_axis_max: float | None = None, layout: str | None = None, name_key: str | None = None, value_key: str | None = None) -> Dict[str, Any]PARAMETERS
self
chart_type
str
title
str
data
List[Dict[str, Any]]
x_key
str | None
= None
series
List[Dict[str, Any]] | None
= None
description
str | None
= None
footer
str | None
= None
x_axis_label
str | None
= None
x_axis_scale
str | None
= None
y_axis_min
float | None
= None
y_axis_max
float | None
= None
layout
str | None
= None
name_key
str | None
= None
value_key
str | None
= None
bar
No description documented yet.
tools/chart_tool.py:291
WHAT IT DOES
No description documented yet.
SIGNATURE
bar(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
line
No description documented yet.
tools/chart_tool.py:309
WHAT IT DOES
No description documented yet.
SIGNATURE
line(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
pie
No description documented yet.
tools/chart_tool.py:327
WHAT IT DOES
No description documented yet.
SIGNATURE
pie(self, title: str, data: List[Dict[str, Any]], name_key: str, value_key: str, series: List[Dict[str, Any]] | None = None, **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
name_key
str
value_key
str
series
List[Dict[str, Any]] | None
= None
**kwargs
Any
scatter
No description documented yet.
tools/chart_tool.py:347
WHAT IT DOES
No description documented yet.
SIGNATURE
scatter(self, title: str, data: List[Dict[str, Any]], x_key: str, series: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]PARAMETERS
self
title
str
data
List[Dict[str, Any]]
x_key
str
series
List[Dict[str, Any]]
**kwargs
Any
make_series
Build a series definition. Example: ChartTool.make_series( data_key="cigarettes", label="Cigarettes", axis_label="Cigarettes", va…
tools/chart_tool.py:370
WHAT IT DOES
Build a series definition. Example: ChartTool.make_series( data_key="cigarettes", label="Cigarettes", axis_label="Cigarettes", value_format="integer", )
SIGNATURE
make_series(data_key: str, label: str | None = None, axis_label: str | None = None, value_format: str | None = None, value_prefix: str | None = None, value_suffix: str | None = None, stack: str | None = None) -> Dict[str, Any]PARAMETERS
data_key
str
label
str | None
= None
axis_label
str | None
= None
value_format
str | None
= None
value_prefix
str | None
= None
value_suffix
str | None
= None
stack
str | None
= None
DECORATORS
_normalize_chart_type
No description documented yet.
tools/chart_tool.py:447
WHAT IT DOES
No description documented yet.
SIGNATURE
_normalize_chart_type(chart_type: str) -> strPARAMETERS
chart_type
str
DECORATORS
_normalize_series
No description documented yet.
tools/chart_tool.py:459
WHAT IT DOES
No description documented yet.
SIGNATURE
_normalize_series(cls, series: List[Dict[str, Any]]) -> List[Dict[str, Any]]PARAMETERS
cls
series
List[Dict[str, Any]]
DECORATORS
_validate_chart_type
No description documented yet.
tools/chart_tool.py:554
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_chart_type(self, chart_type: str) -> NonePARAMETERS
self
chart_type
str
_validate_title
No description documented yet.
tools/chart_tool.py:570
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_title(title: str) -> NonePARAMETERS
title
str
DECORATORS
_validate_data
No description documented yet.
tools/chart_tool.py:585
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_data(data: List[Dict[str, Any]]) -> NonePARAMETERS
data
List[Dict[str, Any]]
DECORATORS
_validate_cartesian_chart
No description documented yet.
tools/chart_tool.py:607
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_cartesian_chart(chart_type: str, data: List[Dict[str, Any]], x_key: str | None, series: List[Dict[str, Any]]) -> NonePARAMETERS
chart_type
str
data
List[Dict[str, Any]]
x_key
str | None
series
List[Dict[str, Any]]
DECORATORS
_validate_pie_chart
No description documented yet.
tools/chart_tool.py:648
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_pie_chart(data: List[Dict[str, Any]], name_key: str | None, value_key: str | None) -> NonePARAMETERS
data
List[Dict[str, Any]]
name_key
str | None
value_key
str | None
DECORATORS
_validate_x_axis_scale
No description documented yet.
tools/chart_tool.py:705
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_x_axis_scale(chart_type: str, x_axis_scale: str, data: List[Dict[str, Any]], x_key: str | None) -> NonePARAMETERS
chart_type
str
x_axis_scale
str
data
List[Dict[str, Any]]
x_key
str | None
DECORATORS
_validate_layout
No description documented yet.
tools/chart_tool.py:742
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_layout(layout: str) -> NonePARAMETERS
layout
str
DECORATORS
_validate_y_axis
No description documented yet.
tools/chart_tool.py:752
WHAT IT DOES
No description documented yet.
SIGNATURE
_validate_y_axis(y_axis_min: float | None, y_axis_max: float | None) -> NonePARAMETERS
y_axis_min
float | None
y_axis_max
float | None
DECORATORS
_format_output
Serialize the chart specification for ToolResult.output. ChatEngine can then parse/recognize the structured chart object rather t…
tools/chart_tool.py:792
WHAT IT DOES
Serialize the chart specification for ToolResult.output. ChatEngine can then parse/recognize the structured chart object rather than treating it as ordinary prose.
SIGNATURE
_format_output(chart: Dict[str, Any]) -> strPARAMETERS
chart
Dict[str, Any]
DECORATORS
ChartTool
No description documented yet.
3 methods
No description documented yet.
_ensure_db
No description documented yet.
tools/ChartTool.py:22
WHAT IT DOES
No description documented yet.
SIGNATURE
_ensure_db(self)PARAMETERS
self
_smoke_data
No description documented yet.
tools/ChartTool.py:35
WHAT IT DOES
No description documented yet.
SIGNATURE
_smoke_data(self, scope: str = '7d', smoke_type: str | None = None)PARAMETERS
self
scope
str
= '7d'
smoke_type
str | None
= None
call
No description documented yet.
tools/ChartTool.py:93
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
args
Dict[str, Any]
FilesystemTool
No description documented yet.
1 methods
No description documented yet.
call
No description documented yet.
tools/filesystem.py:15
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
LeproLightsTool
CYN-X tool for controlling Lepro lights.
3 methods
CYN-X tool for controlling Lepro lights.
__init__
No description documented yet.
tools/lepro_lights.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, device_name: str, mac: str)PARAMETERS
self
device_name
str
mac
str
schema
Return the tool schema exposed to CYN.
tools/lepro_lights.py:30
WHAT IT DOES
Return the tool schema exposed to CYN.
SIGNATURE
schema(self) -> dict[str, Any]PARAMETERS
self
execute
Execute a light-control request.
tools/lepro_lights.py:86
WHAT IT DOES
Execute a light-control request.
SIGNATURE
execute(self, arguments: dict[str, Any]) -> ToolResultPARAMETERS
self
arguments
dict[str, Any]
LeproLightsTool
CYN-X tool for controlling Lepro lights.
3 methods
CYN-X tool for controlling Lepro lights.
__init__
No description documented yet.
tools/LeproLightsTool.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, device_name: str, mac: str)PARAMETERS
self
device_name
str
mac
str
schema
Return the tool schema exposed to CYN.
tools/LeproLightsTool.py:30
WHAT IT DOES
Return the tool schema exposed to CYN.
SIGNATURE
schema(self) -> dict[str, Any]PARAMETERS
self
execute
Execute a light-control request.
tools/LeproLightsTool.py:86
WHAT IT DOES
Execute a light-control request.
SIGNATURE
execute(self, arguments: dict[str, Any]) -> ToolResultPARAMETERS
self
arguments
dict[str, Any]
SmokeCounterTool
Conversational smoke counter for CYN Studio. This class intentionally does NOT use input() or print(). CYN can call it…
1 methods
Conversational smoke counter for CYN Studio.
This class intentionally does NOT use input() or print().
CYN can call it directly and receive structured data.
call
Flexible call interface: - If args is a dict (tool_router), use it. - Otherwise accept keyword args for backward compatibility. R…
tools/SmokeCounterTool.py:611
WHAT IT DOES
Flexible call interface: - If args is a dict (tool_router), use it. - Otherwise accept keyword args for backward compatibility. Returns a ToolResult with a human-readable output and metadata containing the raw result dict.
SIGNATURE
call(self, args = None, action: str = 'stats', smoke_type: Optional[str] = None, amount: float = 1, limit: int = 10, scope: str = 'all') -> ToolResultPARAMETERS
self
args
= None
action
str
= 'stats'
smoke_type
Optional[str]
= None
amount
float
= 1
limit
int
= 10
scope
str
= 'all'
ToolRouter
No description documented yet.
9 methods
No description documented yet.
__init__
No description documented yet.
tools/tool_router.py:16
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
register_tool
No description documented yet.
tools/tool_router.py:20
WHAT IT DOES
No description documented yet.
SIGNATURE
register_tool(self, tool: BaseTool)PARAMETERS
self
tool
BaseTool
list_tools
No description documented yet.
tools/tool_router.py:24
WHAT IT DOES
No description documented yet.
SIGNATURE
list_tools(self)PARAMETERS
self
describe_tools
Gives the AI a list of available tools.
tools/tool_router.py:28
WHAT IT DOES
Gives the AI a list of available tools.
SIGNATURE
describe_tools(self)PARAMETERS
self
as_ollama_tools
Convert the registered tools into Ollama function-calling schemas.
tools/tool_router.py:41
WHAT IT DOES
Convert the registered tools into Ollama function-calling schemas.
SIGNATURE
as_ollama_tools(self)PARAMETERS
self
call_tool
No description documented yet.
tools/tool_router.py:180
WHAT IT DOES
No description documented yet.
SIGNATURE
call_tool(self, name: str, args: Dict[str, Any]) -> ToolResultPARAMETERS
self
name
str
args
Dict[str, Any]
normalize_smoke_type
Normalize a freeform smoke_type string into a canonical type (pen, vape, cigarette, bong, weed, joint, unknown).
tools/tool_router.py:215
WHAT IT DOES
Normalize a freeform smoke_type string into a canonical type (pen, vape, cigarette, bong, weed, joint, unknown).
SIGNATURE
normalize_smoke_type(self, text: str)PARAMETERS
self
text
str
is_read_only_smoke_query
Return True when the request is asking for counts/stats/history instead of logging.
tools/tool_router.py:244
WHAT IT DOES
Return True when the request is asking for counts/stats/history instead of logging.
SIGNATURE
is_read_only_smoke_query(self, text: str) -> boolPARAMETERS
self
text
str
detect
Detect whether a message requires a tool.
tools/tool_router.py:285
WHAT IT DOES
Detect whether a message requires a tool.
SIGNATURE
detect(self, text: str)PARAMETERS
self
text
str
WeatherTool
No description documented yet.
1 methods
No description documented yet.
call
No description documented yet.
tools/weather.py:12
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args: Dict) -> ToolResultPARAMETERS
self
args
Dict
OutputMode
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
RankingProfile
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
SearchIntent
No description documented yet.
0 methods
No description documented yet.
No methods discovered.
ResultFilter
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
tools/web_search.py:837
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
is_bad_result
No description documented yet.
tools/web_search.py:841
WHAT IT DOES
No description documented yet.
SIGNATURE
is_bad_result(self, title: str, body: str, href: str) -> boolPARAMETERS
self
title
str
body
str
href
str
ResultRanker
No description documented yet.
8 methods
No description documented yet.
__init__
No description documented yet.
tools/web_search.py:897
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self, intent: SearchIntent)PARAMETERS
self
intent
SearchIntent
rank
No description documented yet.
tools/web_search.py:905
WHAT IT DOES
No description documented yet.
SIGNATURE
rank(self, title: str, body: str, href: str) -> intPARAMETERS
self
title
str
body
str
href
str
score_keywords
No description documented yet.
tools/web_search.py:980
WHAT IT DOES
No description documented yet.
SIGNATURE
score_keywords(title: str, combined: str, keywords: tuple[str, ...], title_weight: int, body_weight: int) -> intPARAMETERS
title
str
combined
str
keywords
tuple[str, ...]
title_weight
int
body_weight
int
DECORATORS
score_negative
No description documented yet.
tools/web_search.py:1002
WHAT IT DOES
No description documented yet.
SIGNATURE
score_negative(self, title: str, combined: str) -> intPARAMETERS
self
title
str
combined
str
output_bonus
No description documented yet.
tools/web_search.py:1022
WHAT IT DOES
No description documented yet.
SIGNATURE
output_bonus(self, title: str) -> intPARAMETERS
self
title
str
store_bonus
No description documented yet.
tools/web_search.py:1065
WHAT IT DOES
No description documented yet.
SIGNATURE
store_bonus(self, href: str) -> intPARAMETERS
self
href
str
domain_bonus
No description documented yet.
tools/web_search.py:1080
WHAT IT DOES
No description documented yet.
SIGNATURE
domain_bonus(href: str) -> intPARAMETERS
href
str
DECORATORS
research_source_bonus
No description documented yet.
tools/web_search.py:1110
WHAT IT DOES
No description documented yet.
SIGNATURE
research_source_bonus(href: str) -> intPARAMETERS
href
str
DECORATORS
WebSearchTool
No description documented yet.
2 methods
No description documented yet.
call
No description documented yet.
tools/web_search.py:1547
WHAT IT DOES
No description documented yet.
SIGNATURE
call(self, args)PARAMETERS
self
args
format_result
No description documented yet.
tools/web_search.py:1913
WHAT IT DOES
No description documented yet.
SIGNATURE
format_result(title: str, body: str, href: str, score: int = 0, source_type: str = 'unknown') -> strPARAMETERS
title
str
body
str
href
str
score
int
= 0
source_type
str
= 'unknown'
DECORATORS
AudioPlayer
Platform-aware audio playback. Uses native system audio players: - Windows: winsound (built-in) or powershell - macOS:…
4 methods
Platform-aware audio playback.
Uses native system audio players:
- Windows: winsound (built-in) or powershell
- macOS: afplay (built-in)
- Linux: paplay or aplay (ALSA)
This keeps dependencies minimal and avoids pygame for Python 3.14 compatibility.
play
Play a WAV audio file. Args: filepath (str): Path to the WAV file to play Raises: FileNotFoundError: If the audio file doesn't ex…
voice/audio_player.py:18
WHAT IT DOES
Play a WAV audio file. Args: filepath (str): Path to the WAV file to play Raises: FileNotFoundError: If the audio file doesn't exist RuntimeError: If playback fails
SIGNATURE
play(self, filepath)PARAMETERS
self
filepath
_play_windows
Play audio on Windows using PowerShell.
voice/audio_player.py:42
WHAT IT DOES
Play audio on Windows using PowerShell.
SIGNATURE
_play_windows(self, filepath)PARAMETERS
self
filepath
_play_macos
Play audio on macOS using afplay.
voice/audio_player.py:57
WHAT IT DOES
Play audio on macOS using afplay.
SIGNATURE
_play_macos(self, filepath)PARAMETERS
self
filepath
_play_linux
Play audio on Linux using available tools.
voice/audio_player.py:66
WHAT IT DOES
Play audio on Linux using available tools.
SIGNATURE
_play_linux(self, filepath)PARAMETERS
self
filepath
PiperTTS
Local Piper TTS engine for converting text to speech. Piper is a lightweight, fast, on-device Text-to-Speech (TTS) syst…
2 methods
Local Piper TTS engine for converting text to speech.
Piper is a lightweight, fast, on-device Text-to-Speech (TTS) system.
Models are ONNX-based and run locally without cloud dependencies.
Directory structure for models:
models/
└── voices/
├── cyn_normal.onnx # Default personality voice
├── cyn_glitch.onnx # Glitchy/error personality
├── cyn_soft.onnx # Soft/empathetic personality
└── [add more .onnx files here for different voices]
To add new voices:
1. Download a Piper ONNX model from https://huggingface.co/rhasspy/piper-voices
2. Place the .onnx file in models/voices/ with a descriptive name
3. Reference it in PiperTTS initialization or voice switching logic
Future enhancement: VoiceManager can switch voices based on personality modes:
- mode_manager.current_mode == "glitch" -> use cyn_glitch.onnx
- mode_manager.current_mode == "normal" -> use cyn_normal.onnx
- etc.
__init__
Initialize PiperTTS with a specific model. Args: model_path (str): Path to the .onnx model file e.g., "models/voices/cyn_normal.o…
voice/piper_engine.py:33
WHAT IT DOES
Initialize PiperTTS with a specific model. Args: model_path (str): Path to the .onnx model file e.g., "models/voices/cyn_normal.onnx" Raises: FileNotFoundError: If the model file doesn't exist
SIGNATURE
__init__(self, model_path)PARAMETERS
self
model_path
generate
Generate speech from text using Piper TTS. Args: text (str): The text to convert to speech output_file (str): Path where the WAV…
voice/piper_engine.py:53
WHAT IT DOES
Generate speech from text using Piper TTS. Args: text (str): The text to convert to speech output_file (str): Path where the WAV file will be saved Returns: str: Path to the generated WAV file Raises: RuntimeError: If Piper subprocess fails or is not installed
SIGNATURE
generate(self, text, output_file = 'cyn_output.wav')PARAMETERS
self
text
output_file
= 'cyn_output.wav'
TTSEngine
No description documented yet.
2 methods
No description documented yet.
__init__
No description documented yet.
voice/tts_engine.py:6
WHAT IT DOES
No description documented yet.
SIGNATURE
__init__(self)PARAMETERS
self
generate
No description documented yet.
voice/tts_engine.py:13
WHAT IT DOES
No description documented yet.
SIGNATURE
generate(self, text, output = 'cyn_output.wav')PARAMETERS
self
text
output
= 'cyn_output.wav'
VoiceManager
Decoupled voice synthesis coordinator. Architecture: Text Response (from ChatEngine) | v VoiceManager.speak(text) | +--…
2 methods
Decoupled voice synthesis coordinator.
Architecture:
Text Response (from ChatEngine)
|
v
VoiceManager.speak(text)
|
+---> PiperTTS.generate(text) -> WAV file
|
+---> AudioPlayer.play(wav_file)
This design allows:
- Independent TTS engine implementations
- Independent audio playback implementations
- Easy testing with mock objects
- No direct dependency on ChatEngine
Future: Dynamic voice switching based on personality modes
- Switch between cyn_normal.onnx, cyn_glitch.onnx, etc.
- Based on mode_manager.current_mode
__init__
Initialize VoiceManager with TTS and playback engines. Args: tts: TTS engine (e.g., PiperTTS) with generate(text) method player:…
voice/voice_manager.py:26
WHAT IT DOES
Initialize VoiceManager with TTS and playback engines. Args: tts: TTS engine (e.g., PiperTTS) with generate(text) method player: Audio player (e.g., AudioPlayer) with play(filepath) method
SIGNATURE
__init__(self, tts, player)PARAMETERS
self
tts
player
speak
Generate speech from text and play it immediately. Args: text (str): The text to speak Raises: Exception: Propagates errors from…
voice/voice_manager.py:37
WHAT IT DOES
Generate speech from text and play it immediately. Args: text (str): The text to speak Raises: Exception: Propagates errors from TTS or playback
SIGNATURE
speak(self, text)PARAMETERS
self
text
07
BARKLY DOCS
Modules
A lightweight map of source files and their discovered contents.
ai/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
ai/chat_engine.py
7 symbols
7 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
7
IMPORTS
ai/context_manager.py
3 symbols
0 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
0
ai/knowledge/store.py
5 symbols
1 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
1
IMPORTS
ai/memory_system/__init__.py
0 symbols
2 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
2
IMPORTS
ai/memory_system/extractor.py
11 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
ai/memory_system/manager.py
10 symbols
1 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
1
IMPORTS
ai/mode_manager.py
7 symbols
1 imports
FUNCTIONS
0
CLASSES
2
IMPORTS
1
IMPORTS
ai/ollama_client.py
5 symbols
5 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
5
IMPORTS
ai/personality.py
11 symbols
3 imports
FUNCTIONS
11
CLASSES
0
IMPORTS
3
IMPORTS
ai/prompt_builder.py
13 symbols
2 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
2
IMPORTS
ai/prompt_manager.py
11 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
ai/terminal_ui/__init__.py
0 symbols
1 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
1
IMPORTS
ai/terminal_ui/colors.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
ai/terminal_ui/renderer.py
23 symbols
6 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
6
IMPORTS
barkly_docs.py
66 symbols
10 imports
FUNCTIONS
50
CLASSES
6
IMPORTS
10
IMPORTS
benchmark/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
benchmark/analyzer.py
5 symbols
2 imports
FUNCTIONS
5
CLASSES
0
IMPORTS
2
IMPORTS
benchmark/cleaner.py
10 symbols
3 imports
FUNCTIONS
1
CLASSES
1
IMPORTS
3
IMPORTS
benchmark/cli.py
1 symbols
1 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
1
IMPORTS
benchmark/formatter.py
1 symbols
1 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
1
IMPORTS
benchmark/modes.py
2 symbols
1 imports
FUNCTIONS
2
CLASSES
0
IMPORTS
1
IMPORTS
benchmark/runner.py
26 symbols
25 imports
FUNCTIONS
20
CLASSES
1
IMPORTS
25
IMPORTS
benchmark/visualize.py
4 symbols
7 imports
FUNCTIONS
4
CLASSES
0
IMPORTS
7
IMPORTS
clean_cyn.py
2 symbols
1 imports
FUNCTIONS
2
CLASSES
0
IMPORTS
1
IMPORTS
config.py
3 symbols
5 imports
FUNCTIONS
2
CLASSES
1
IMPORTS
5
IMPORTS
count_results.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
cyndiscord.py
2 symbols
16 imports
FUNCTIONS
2
CLASSES
0
IMPORTS
16
IMPORTS
hardware/lepro/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
hardware/lepro/config.py
7 symbols
4 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
4
IMPORTS
hardware/lepro/devices.py
12 symbols
7 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
7
IMPORTS
hardware/lepro/discovery.py
4 symbols
3 imports
FUNCTIONS
1
CLASSES
1
IMPORTS
3
IMPORTS
hardware/lepro/lib/lepro/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
hardware/lepro/lib/lepro/apk_analysis.py
0 symbols
1 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
1
IMPORTS
hardware/lepro/lib/lepro/bond.py
24 symbols
11 imports
FUNCTIONS
15
CLASSES
3
IMPORTS
11
IMPORTS
hardware/lepro/lib/lepro/cli/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
hardware/lepro/lib/lepro/cli/_common.py
5 symbols
8 imports
FUNCTIONS
5
CLASSES
0
IMPORTS
8
IMPORTS
hardware/lepro/lib/lepro/cli/bond.py
3 symbols
10 imports
FUNCTIONS
3
CLASSES
0
IMPORTS
10
IMPORTS
hardware/lepro/lib/lepro/cli/ctl.py
2 symbols
9 imports
FUNCTIONS
2
CLASSES
0
IMPORTS
9
IMPORTS
hardware/lepro/lib/lepro/cli/firmware.py
5 symbols
10 imports
FUNCTIONS
5
CLASSES
0
IMPORTS
10
IMPORTS
hardware/lepro/lib/lepro/cli/ota.py
1 symbols
5 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
5
IMPORTS
hardware/lepro/lib/lepro/cli/provision.py
2 symbols
6 imports
FUNCTIONS
2
CLASSES
0
IMPORTS
6
IMPORTS
hardware/lepro/lib/lepro/cli/status.py
1 symbols
5 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
5
IMPORTS
hardware/lepro/lib/lepro/commands.py
11 symbols
6 imports
FUNCTIONS
11
CLASSES
0
IMPORTS
6
IMPORTS
hardware/lepro/lib/lepro/config.py
7 symbols
6 imports
FUNCTIONS
2
CLASSES
5
IMPORTS
6
IMPORTS
hardware/lepro/lib/lepro/crypto.py
13 symbols
4 imports
FUNCTIONS
13
CLASSES
0
IMPORTS
4
IMPORTS
hardware/lepro/lib/lepro/firmware_profile.py
12 symbols
7 imports
FUNCTIONS
7
CLASSES
4
IMPORTS
7
IMPORTS
hardware/lepro/lib/lepro/frame.py
18 symbols
5 imports
FUNCTIONS
6
CLASSES
4
IMPORTS
5
IMPORTS
hardware/lepro/lib/lepro/modes.py
24 symbols
10 imports
FUNCTIONS
23
CLASSES
1
IMPORTS
10
IMPORTS
hardware/lepro/lib/lepro/ota.py
55 symbols
18 imports
FUNCTIONS
41
CLASSES
5
IMPORTS
18
IMPORTS
hardware/lepro/lib/lepro/patch_cdn.py
23 symbols
15 imports
FUNCTIONS
20
CLASSES
2
IMPORTS
15
IMPORTS
hardware/lepro/lib/lepro/paths.py
1 symbols
2 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
2
IMPORTS
hardware/lepro/lib/lepro/protocol.py
12 symbols
3 imports
FUNCTIONS
11
CLASSES
1
IMPORTS
3
IMPORTS
hardware/lepro/lib/lepro/provision.py
11 symbols
12 imports
FUNCTIONS
11
CLASSES
0
IMPORTS
12
IMPORTS
hardware/lepro/lib/lepro/session.py
38 symbols
13 imports
FUNCTIONS
1
CLASSES
6
IMPORTS
13
IMPORTS
hardware/lepro/lib/lepro/tools/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
hardware/lepro/lib/lepro/tools/debug_hijack.py
10 symbols
14 imports
FUNCTIONS
10
CLASSES
0
IMPORTS
14
IMPORTS
hardware/lepro/lib/lepro/tools/decrypt_capture.py
3 symbols
8 imports
FUNCTIONS
3
CLASSES
0
IMPORTS
8
IMPORTS
hardware/lepro/lib/lepro/tools/esp_idf_bin_to_elf.py
9 symbols
6 imports
FUNCTIONS
6
CLASSES
1
IMPORTS
6
IMPORTS
hardware/lepro/lib/lepro/tools/mqtt_ca_dump.py
7 symbols
10 imports
FUNCTIONS
7
CLASSES
0
IMPORTS
10
IMPORTS
hardware/lepro/lib/lepro/tools/replay.py
1 symbols
5 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
5
IMPORTS
hardware/lepro/lib/lepro/tools/validate_ota_parser.py
9 symbols
8 imports
FUNCTIONS
3
CLASSES
1
IMPORTS
8
IMPORTS
hardware/lepro/setup.py
5 symbols
7 imports
FUNCTIONS
1
CLASSES
1
IMPORTS
7
IMPORTS
hardware/web/app.py
3 symbols
22 imports
FUNCTIONS
3
CLASSES
0
IMPORTS
22
IMPORTS
interfaces/discord_bot.py
3 symbols
1 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
1
IMPORTS
interfaces/terminal.py
3 symbols
2 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
2
IMPORTS
interfaces/web/app.py
3 symbols
22 imports
FUNCTIONS
3
CLASSES
0
IMPORTS
22
IMPORTS
interfaces/web_ui.py
3 symbols
0 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
0
main.py
1 symbols
17 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
17
IMPORTS
memory/embeddings.py
5 symbols
1 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
1
IMPORTS
memory/memory.py
3 symbols
1 imports
FUNCTIONS
1
CLASSES
1
IMPORTS
1
IMPORTS
memory/sqlite.py
3 symbols
2 imports
FUNCTIONS
3
CLASSES
0
IMPORTS
2
IMPORTS
memory/test_memory.py
0 symbols
2 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
2
IMPORTS
run_30_after_fix.py
0 symbols
5 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
5
IMPORTS
scripts/test_tool_pipeline.py
0 symbols
2 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
2
IMPORTS
test_refactor.py
8 symbols
2 imports
FUNCTIONS
8
CLASSES
0
IMPORTS
2
IMPORTS
tests/__init__.py
0 symbols
0 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
0
tests/auto_promt_test.py
5 symbols
6 imports
FUNCTIONS
5
CLASSES
0
IMPORTS
6
IMPORTS
tests/integration_check.py
0 symbols
9 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
9
IMPORTS
tests/parse_temp_output.py
0 symbols
1 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
1
IMPORTS
tests/test_memory_system.py
1 symbols
6 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
6
IMPORTS
tests/test_prompt_builder.py
1 symbols
1 imports
FUNCTIONS
1
CLASSES
0
IMPORTS
1
IMPORTS
tests/test_smoke_pipeline.py
0 symbols
16 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
16
IMPORTS
tests/verify_refactoring.py
9 symbols
5 imports
FUNCTIONS
9
CLASSES
0
IMPORTS
5
IMPORTS
tools/base.py
3 symbols
2 imports
FUNCTIONS
0
CLASSES
2
IMPORTS
2
IMPORTS
tools/calculator.py
3 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
tools/chart_tool.py
19 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
tools/ChartTool.py
4 symbols
5 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
5
IMPORTS
tools/filesystem.py
2 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
tools/lepro_lights.py
4 symbols
4 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
4
IMPORTS
tools/LeproLightsTool.py
4 symbols
4 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
4
IMPORTS
tools/SmokeCounterTool.py
15 symbols
10 imports
FUNCTIONS
13
CLASSES
1
IMPORTS
10
IMPORTS
tools/tool_router.py
10 symbols
2 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
2
IMPORTS
tools/weather.py
2 symbols
2 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
2
IMPORTS
tools/web_search.py
29 symbols
8 imports
FUNCTIONS
11
CLASSES
6
IMPORTS
8
IMPORTS
voice/__init__.py
0 symbols
3 imports
FUNCTIONS
0
CLASSES
0
IMPORTS
3
IMPORTS
voice/audio_player.py
5 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
voice/piper_engine.py
3 symbols
3 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
3
IMPORTS
voice/tts_engine.py
3 symbols
1 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
1
IMPORTS
voice/voice_manager.py
3 symbols
0 imports
FUNCTIONS
0
CLASSES
1
IMPORTS
0
08
BARKLY DOCS
Imports
Dependencies discovered from Python import statements.
DISCOVERED
115
SOURCE FILES
100
09
BARKLY DOCS
Lifecycle
The development path used by the project.
01
Idea
02
Research
03
Experiment
04
Prototype
05
Community Testing
06
Engineering
07
Productization
08
Release
09
Feedback
10
Continued Development
10
BARKLY DOCS
Git
Repository state and recent development history.
BRANCH
main
COMMIT
49f400b
NEW FUNCTIONS
0
CHANGED FUNCTIONS
0
NEW CLASSES
0
CHANGED CLASSES
0
NEW ENDPOINTS
0
CHANGED ENDPOINTS
0
RECENT COMMITS
49f400b|2026-09-26|fixed barkly docs to be more usefull
c7eb7b8|2026-09-26|added barkly docs
a0b3c48|2026-09-14|woring on getting sutff orking
9fe7724|2026-09-14|fixed runner
46cc3a8|2026-09-14|added more content to more of the context md
efebbb3|2026-09-14|added more content to more of the context md
2c3bff1|2026-09-14|added more content to more of the context md
0235a13|2026-09-14|added more content to more of the context md
11
BARKLY DOCS
Changelog
What BARKLY DOCS noticed changed between documentation generations.
DOCUMENTATION RUN
#1
Persistent documentation snapshot.
NEW FUNCTIONS
0
Detected since the previous documentation run.
CHANGED FUNCTIONS
0
Signatures, decorators, or documentation changed.
NEW CLASSES
0
Detected since the previous documentation run.
NEW ENDPOINTS
0
Detected since the previous documentation run.
How change detection works
BARKLY DOCS stores a small local snapshot of discovered symbols and compares the next scan against it. The scanner uses static Python AST analysis and never imports or executes the project.
On the first generation, the existing project becomes the baseline. Later generations can identify newly discovered and changed functions, methods, classes, and API endpoints.