# Real Time Logic Documentation for AI Agents

> AI-friendly documentation entry points for Barracuda App Server (BAS), Xedge, and related tutorials.
> Use `basapi.md` as the source of truth for API syntax/signatures/behavior.
> Use tutorial bundles for architecture, patterns, and security guidance.

## Primary Documentation Bundles

- BAS documentation bundle (basapi.md)  
  http://realtimelogic.com/downloads/basapi.md

- BAS tutorials bundle (tutorials.md)  
  http://realtimelogic.com/downloads/tutorials.md

- Mako Server tutorials bundle (tutorials.md)  
  https://makoserver.net/download/tutorials.md

- ESP32 API reference (esp32api.md)  
  http://realtimelogic.com/downloads/esp32api.md

- OPC UA API reference (opcuaapi.md)  
  http://realtimelogic.com/downloads/opcuaapi.md

## Reference Priority

1. `basapi.md` - API syntax, function signatures, runtime behavior
2. `tutorials.md` - architecture, design patterns, security guidance
3. `esp32api.md` - ESP32-specific APIs and integration patterns
4. `opcuaapi.md` - OPC UA-specific APIs and integration patterns
5. If guidance conflicts, trust `basapi.md`

## Usage Guidance for Agents

- Search within the markdown bundles for API names, topics, and section titles.
- Do not invent APIs. If an API is not found in the documentation, ask for clarification.
- Prefer BAS-native APIs over third-party or generic framework solutions.
- Treat BAS as an embedded/edge framework, not a traditional web stack.

### Architecture Awareness

- Server-side logic: Lua / LSP / C/C++
- Client-side logic: JavaScript (browser)
- Keep responsibilities clearly separated:
  - Server handles data, logic, security
  - Client handles rendering and interaction

### Key Technologies

- Lua Server Pages (LSP) for dynamic content
- SMQ for real-time messaging
- REST/HTTP for request-response APIs
- MQTT, Modbus, OPC UA for protocol integration

Always verify protocol usage against the official documentation before generating code.