Compare commits
5 Commits
24a11cecdd
...
001-survei
| Author | SHA1 | Date | |
|---|---|---|---|
|
b46403cecb | ||
|
|
d2c6937665 | ||
|
|
001a674071 | ||
|
|
49b9fdfb81 | ||
|
|
cda42ebc6e |
77
CRITICAL_BUG_FIX_DELETE.md
Normal file
77
CRITICAL_BUG_FIX_DELETE.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# CRITICAL BUG FIX - DeleteActionMapping Cascade Deletion
|
||||
|
||||
## Date: 2025-12-16
|
||||
|
||||
## Severity: CRITICAL - Data Loss
|
||||
|
||||
## Summary
|
||||
DeleteActionMapping operation caused cascade deletion of ~54 action mappings during testing, reducing total from ~60 to only 6 mappings.
|
||||
|
||||
## Root Cause
|
||||
When deleting multiple action mappings, IDs shift after each deletion. Deleting in ascending order causes wrong mappings to be deleted.
|
||||
|
||||
### Example of the Bug:
|
||||
```
|
||||
Original mappings: #1, #2, #3, #4, #5
|
||||
Want to delete: #3, #4, #5
|
||||
|
||||
Delete #3 → Mappings become: #1, #2, #3(was 4), #4(was 5)
|
||||
Delete #4 → Deletes what was originally #5! ✗
|
||||
Delete #5 → Deletes wrong mapping! ✗
|
||||
```
|
||||
|
||||
## The Fix
|
||||
|
||||
**Always delete in REVERSE order (highest ID first):**
|
||||
|
||||
### WRONG (causes cascade deletion):
|
||||
```python
|
||||
for mapping in mappings_to_delete:
|
||||
delete_action_mapping(mapping['id']) # ✗ WRONG
|
||||
```
|
||||
|
||||
### CORRECT:
|
||||
```python
|
||||
# Sort by ID descending
|
||||
sorted_mappings = sorted(mappings_to_delete, key=lambda x: x['id'], reverse=True)
|
||||
|
||||
for mapping in sorted_mappings:
|
||||
delete_action_mapping(mapping['id']) # ✓ CORRECT
|
||||
```
|
||||
|
||||
## Files Fixed
|
||||
- `comprehensive_crud_test.py` - Lines 436-449
|
||||
- Added reverse sorting before deletion loop
|
||||
- Added comment explaining why reverse order is critical
|
||||
|
||||
## Testing Required
|
||||
Before using DeleteActionMapping in production:
|
||||
|
||||
1. ✅ Restore configuration from backup (TestMKS_original.set)
|
||||
2. ✅ Test delete operation with fixed code
|
||||
3. ✅ Verify only intended mappings are deleted
|
||||
4. ✅ Verify count before/after matches expected delta
|
||||
|
||||
## Impact Assessment
|
||||
- **Affected Environment**: Development/Test only
|
||||
- **Production Impact**: NONE (bug caught before production deployment)
|
||||
- **Data Loss**: ~54 test action mappings (recoverable from backup)
|
||||
|
||||
## Prevention Measures
|
||||
1. **Code Review**: All delete-by-index operations must be reviewed
|
||||
2. **Testing**: Always verify delete operations with read-after-delete
|
||||
3. **Documentation**: Add warning comment to DeleteActionMapping implementation
|
||||
4. **Safe Delete**: Consider adding bulk delete method that handles ordering automatically
|
||||
|
||||
## Related Code
|
||||
- SDK Bridge: `ConfigurationServiceImplementation.cs` - DeleteActionMapping method
|
||||
- Python Test: `comprehensive_crud_test.py` - Lines 436-449
|
||||
- Server Manager: `server_manager.py` - delete_action_mapping function
|
||||
|
||||
## Status
|
||||
- [x] Bug identified
|
||||
- [x] Root cause analyzed
|
||||
- [x] Fix implemented in test code
|
||||
- [ ] SDK Bridge bulk delete helper (future enhancement)
|
||||
- [ ] Test with restored configuration
|
||||
- [ ] Verify fix works correctly
|
||||
210
SERVER_CRUD_IMPLEMENTATION.md
Normal file
210
SERVER_CRUD_IMPLEMENTATION.md
Normal file
@@ -0,0 +1,210 @@
|
||||
# Server CRUD Implementation
|
||||
|
||||
## Overview
|
||||
|
||||
Full CRUD (Create, Read, Update, Delete) implementation for GeViSoft G-Core server management via gRPC SDK Bridge and REST API.
|
||||
|
||||
## Critical Implementation Details
|
||||
|
||||
### Boolean Type Fix
|
||||
|
||||
**Issue**: Initial implementation used `int32` type for boolean fields (Enabled, DeactivateEcho, DeactivateLiveCheck), causing servers to be written but not recognized by GeViSet.
|
||||
|
||||
**Solution**: Changed to proper `bool` type (type code 1) instead of `int32` (type code 4).
|
||||
|
||||
**Affected Files**:
|
||||
- `src/sdk-bridge/GeViScopeBridge/Services/ConfigurationServiceImplementation.cs`
|
||||
- Lines 1062-1078: CreateServer method
|
||||
- Lines 1194-1200: UpdateServer method
|
||||
- Lines 1344-1383: UpdateOrAddChild helper (added bool handling)
|
||||
|
||||
### Field Order Requirements
|
||||
|
||||
Server configuration nodes must have fields in specific order:
|
||||
1. Alias (string)
|
||||
2. DeactivateEcho (bool)
|
||||
3. DeactivateLiveCheck (bool)
|
||||
4. Enabled (bool)
|
||||
5. Host (string)
|
||||
6. Password (string)
|
||||
7. User (string)
|
||||
|
||||
**Reference**: Working implementation in `C:\DEV\COPILOT_codex\geviset_parser.py` lines 389-404
|
||||
|
||||
### Auto-Increment Server IDs
|
||||
|
||||
**Implementation**: `server_manager.py` demonstrates proper ID management:
|
||||
- Reads existing servers from configuration
|
||||
- Finds highest numeric server ID
|
||||
- Increments by 1 for new server ID
|
||||
- Skips non-numeric IDs gracefully
|
||||
|
||||
```python
|
||||
def get_next_server_id(servers):
|
||||
numeric_ids = []
|
||||
for server in servers:
|
||||
try:
|
||||
numeric_ids.append(int(server['id']))
|
||||
except ValueError:
|
||||
pass
|
||||
if not numeric_ids:
|
||||
return "1"
|
||||
return str(max(numeric_ids) + 1)
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### REST API (FastAPI)
|
||||
|
||||
**Base Path**: `/api/v1/configuration`
|
||||
|
||||
- `GET /servers` - List all G-Core servers
|
||||
- `GET /servers/{server_id}` - Get single server by ID
|
||||
- `POST /servers` - Create new server
|
||||
- `PUT /servers/{server_id}` - Update existing server
|
||||
- `DELETE /servers/{server_id}` - Delete server
|
||||
|
||||
**Implementation**: `src/api/routers/configuration.py` lines 278-460
|
||||
|
||||
### gRPC API
|
||||
|
||||
**Service**: `ConfigurationService`
|
||||
|
||||
Methods:
|
||||
- `CreateServer(CreateServerRequest)` → `ServerOperationResponse`
|
||||
- `UpdateServer(UpdateServerRequest)` → `ServerOperationResponse`
|
||||
- `DeleteServer(DeleteServerRequest)` → `ServerOperationResponse`
|
||||
- `ReadConfigurationTree()` → Configuration tree with all servers
|
||||
|
||||
**Implementation**: `src/sdk-bridge/GeViScopeBridge/Services/ConfigurationServiceImplementation.cs`
|
||||
|
||||
## Server Data Structure
|
||||
|
||||
```protobuf
|
||||
message ServerData {
|
||||
string id = 1; // Server ID (numeric string recommended)
|
||||
string alias = 2; // Display name
|
||||
string host = 3; // IP address or hostname
|
||||
string user = 4; // Username (default: "admin")
|
||||
string password = 5; // Password
|
||||
bool enabled = 6; // Enable/disable server
|
||||
bool deactivate_echo = 7; // Deactivate echo (default: false)
|
||||
bool deactivate_live_check = 8; // Deactivate live check (default: false)
|
||||
}
|
||||
```
|
||||
|
||||
## Test Scripts
|
||||
|
||||
### Production Scripts
|
||||
|
||||
1. **server_manager.py** - Complete server lifecycle management
|
||||
- Lists existing servers
|
||||
- Auto-increments IDs
|
||||
- Creates, deletes servers
|
||||
- Manages action mappings
|
||||
- Cleanup functionality
|
||||
|
||||
2. **cleanup_to_base.py** - Restore configuration to base state
|
||||
- Deletes test servers (2, 3)
|
||||
- Preserves original server (1)
|
||||
- Quick reset for testing
|
||||
|
||||
3. **add_claude_test_data.py** - Add test data with "Claude" prefix
|
||||
- Creates 3 servers: Claude Server Alpha/Beta/Gamma
|
||||
- Creates 2 action mappings
|
||||
- All identifiable by "Claude" prefix
|
||||
|
||||
4. **check_and_add_mapping.py** - Verify and add action mappings
|
||||
- Lists existing Claude mappings
|
||||
- Adds missing mappings
|
||||
- Ensures complete test data
|
||||
|
||||
### Legacy Test Scripts
|
||||
|
||||
- `test_server_creation.py` - Direct gRPC server creation test
|
||||
- `add_server_and_mapping.py` - Combined server and mapping creation
|
||||
|
||||
## Verification Process
|
||||
|
||||
### Testing Workflow
|
||||
|
||||
1. **Start Services**:
|
||||
```bash
|
||||
cd C:\GEVISOFT
|
||||
start GeViServer.exe console
|
||||
|
||||
cd C:\DEV\COPILOT\geutebruck-api\src\sdk-bridge\GeViScopeBridge\bin\Debug\net8.0
|
||||
start GeViScopeBridge.exe
|
||||
```
|
||||
|
||||
2. **Run Test Script**:
|
||||
```bash
|
||||
python server_manager.py
|
||||
```
|
||||
|
||||
3. **Stop Services** (required before GeViSet connection):
|
||||
```powershell
|
||||
Stop-Process -Name GeViScopeBridge -Force
|
||||
Stop-Process -Name python -Force
|
||||
Stop-Process -Name GeViServer -Force
|
||||
```
|
||||
|
||||
4. **Verify in GeViSet**:
|
||||
- Connect to GeViServer
|
||||
- Check Configuration → GeViGCoreServer
|
||||
- Verify servers appear with correct bool values
|
||||
|
||||
### Known Issues & Solutions
|
||||
|
||||
**Issue**: Port 50051 (gRPC) in use
|
||||
- **Solution**: Stop SDK Bridge process
|
||||
|
||||
**Issue**: SetupClient connection refused (Error 307)
|
||||
- **Cause**: GeViSet already connected (only one SetupPort client allowed)
|
||||
- **Solution**: Disconnect GeViSet, retry SetupClient
|
||||
|
||||
**Issue**: Servers created but not visible in GeViSet
|
||||
- **Root Cause**: Using int32 instead of bool type
|
||||
- **Solution**: Use proper bool type as documented above
|
||||
|
||||
**CRITICAL Issue**: Cascade deletion when deleting multiple action mappings
|
||||
- **Root Cause**: Deleting in ascending order causes IDs to shift, deleting wrong mappings
|
||||
- **Solution**: Always delete in REVERSE order (highest ID first)
|
||||
- **Status**: FIXED in comprehensive_crud_test.py (2025-12-16)
|
||||
- **Details**: See CRITICAL_BUG_FIX_DELETE.md
|
||||
|
||||
## Action Mapping CRUD
|
||||
|
||||
Action mappings can also be managed via the same ConfigurationService.
|
||||
|
||||
**Endpoints**:
|
||||
- `GET /api/v1/configuration/action-mappings` - List all mappings
|
||||
- `GET /api/v1/configuration/action-mappings/{mapping_id}` - Get single mapping
|
||||
- `POST /api/v1/configuration/action-mappings` - Create mapping
|
||||
- `PUT /api/v1/configuration/action-mappings/{mapping_id}` - Update mapping
|
||||
- `DELETE /api/v1/configuration/action-mappings/{mapping_id}` - Delete mapping
|
||||
|
||||
**Note**: Mapping IDs are 1-based ordinal positions in the MappingRules list.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- GeViServer must be running
|
||||
- SDK Bridge requires GeViServer connection
|
||||
- REST API requires SDK Bridge on localhost:50051
|
||||
- GeViSet requires exclusive SetupPort (7703) access
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ Servers persist correctly in GeViSoft configuration
|
||||
✅ Servers visible in GeViSet with correct boolean values
|
||||
✅ Auto-increment ID logic prevents conflicts
|
||||
✅ All CRUD operations functional via gRPC and REST
|
||||
✅ Action mappings create, read, update, delete working
|
||||
✅ Configuration changes survive GeViServer restart
|
||||
|
||||
## References
|
||||
|
||||
- Working Python parser: `C:\DEV\COPILOT_codex\geviset_parser.py`
|
||||
- SDK Bridge implementation: `src/sdk-bridge/GeViScopeBridge/Services/ConfigurationServiceImplementation.cs`
|
||||
- REST API: `src/api/routers/configuration.py`
|
||||
- Protocol definitions: `src/api/protos/configuration.proto`
|
||||
811
specs/001-flutter-app/tasks.md
Normal file
811
specs/001-flutter-app/tasks.md
Normal file
@@ -0,0 +1,811 @@
|
||||
# Geutebruck API Flutter App - Implementation Tasks
|
||||
|
||||
## Implementation Status (Last Updated: 2025-12-23)
|
||||
|
||||
### ✅ Completed Features (Phase 1 & 2)
|
||||
- **US-1.1**: User Login - Login screen with authentication ✅
|
||||
- **US-1.2**: Token Management - Secure storage with flutter_secure_storage ✅
|
||||
- **US-2.1**: View All Servers - Server list with filtering (All/G-Core/GeViScope) ✅
|
||||
- **US-2.5**: Create G-Core Server - Full form implementation ✅
|
||||
- **US-2.6**: Create GeViScope Server - Full form implementation ✅
|
||||
- **US-2.7**: Update Server - Edit functionality with proper state handling ✅
|
||||
- **US-2.8**: Delete Server - Delete with confirmation dialog ✅
|
||||
- **Navigation**: App drawer with left menu navigation ✅
|
||||
- **Offline-First**: Hive local storage with sync capabilities ✅
|
||||
- **Server Sync**: Upload dirty changes to remote server ✅
|
||||
- **Server Download**: Download latest configuration from server ✅
|
||||
- **State Management**: BLoC pattern with shared state across routes ✅
|
||||
|
||||
### 🐛 Recent Bug Fixes
|
||||
- Fixed "No data" display issue after server update (2025-12-23)
|
||||
- Issue: BlocBuilder fallback showing "No data" during state transitions
|
||||
- Solution: Changed fallback to show loading indicator instead
|
||||
- File: `lib/presentation/screens/servers/servers_management_screen.dart:268`
|
||||
|
||||
### 🚧 In Progress
|
||||
- Testing and validation of server management features
|
||||
|
||||
### 📋 Pending (Phase 3-9)
|
||||
- US-3.x: Action Mapping Management
|
||||
- US-4.x: Camera Management
|
||||
- US-5.x: Monitor & Cross-Switching
|
||||
- US-6.x: Cross-Switch Management
|
||||
- US-7.x: Configuration Export/Tree View
|
||||
- US-8.x: Additional UI/UX improvements
|
||||
|
||||
---
|
||||
|
||||
## Task Organization
|
||||
|
||||
Tasks are organized by user story and marked with:
|
||||
- `[P]` - Can be done in parallel
|
||||
- `[✅]` - Completed
|
||||
- `[🚧]` - In Progress
|
||||
- File paths indicate where code should be created/modified
|
||||
- TDD tasks (tests) listed before implementation tasks
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Foundation & Setup
|
||||
|
||||
### Task Group: Project Setup
|
||||
|
||||
#### TASK-001 [P] [✅]: Create Flutter Project
|
||||
**File:** N/A (command line)
|
||||
```bash
|
||||
flutter create geutebruck_app
|
||||
cd geutebruck_app
|
||||
```
|
||||
|
||||
#### TASK-002 [P] [✅]: Configure Dependencies
|
||||
**File:** `pubspec.yaml`
|
||||
- Add all required dependencies from plan.md
|
||||
- Set Flutter SDK constraints
|
||||
- Configure assets folder
|
||||
|
||||
#### TASK-003 [✅]: Setup Folder Structure
|
||||
**Files:** Create folder structure as defined in plan.md
|
||||
```
|
||||
lib/core/
|
||||
lib/data/
|
||||
lib/domain/
|
||||
lib/presentation/
|
||||
```
|
||||
|
||||
#### TASK-004 [P] [✅]: Configure Analysis Options
|
||||
**File:** `analysis_options.yaml`
|
||||
- Add very_good_analysis
|
||||
- Configure lint rules
|
||||
- Enable strict mode
|
||||
|
||||
#### TASK-005 [P] [✅]: Setup Build Configuration
|
||||
**File:** `build.yaml`
|
||||
- Configure freezed
|
||||
- Configure json_serializable
|
||||
- Configure injectable
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-1.1 - User Login
|
||||
|
||||
#### TASK-010: Create Auth Entities (Test)
|
||||
**File:** `test/domain/entities/user_test.dart`
|
||||
- Test User entity creation
|
||||
- Test equality
|
||||
- Test copyWith
|
||||
|
||||
#### TASK-011: Create Auth Entities
|
||||
**File:** `lib/domain/entities/user.dart`
|
||||
```dart
|
||||
@freezed
|
||||
class User with _$User {
|
||||
const factory User({
|
||||
required String id,
|
||||
required String username,
|
||||
required String role,
|
||||
}) = _User;
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-012: Create Auth Models (Test)
|
||||
**File:** `test/data/models/auth_model_test.dart`
|
||||
- Test JSON deserialization
|
||||
- Test toEntity conversion
|
||||
|
||||
#### TASK-013: Create Auth Models
|
||||
**File:** `lib/data/models/auth_model.dart`
|
||||
```dart
|
||||
@freezed
|
||||
class AuthResponse with _$AuthResponse {
|
||||
factory AuthResponse({
|
||||
required String accessToken,
|
||||
required String refreshToken,
|
||||
required UserModel user,
|
||||
}) = _AuthResponse;
|
||||
|
||||
factory AuthResponse.fromJson(Map<String, dynamic> json) =>
|
||||
_$AuthResponseFromJson(json);
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-014: Create Secure Storage Manager (Test)
|
||||
**File:** `test/data/data_sources/local/secure_storage_manager_test.dart`
|
||||
- Test token storage
|
||||
- Test token retrieval
|
||||
- Test token deletion
|
||||
|
||||
#### TASK-015: Create Secure Storage Manager
|
||||
**File:** `lib/data/data_sources/local/secure_storage_manager.dart`
|
||||
```dart
|
||||
@injectable
|
||||
class SecureStorageManager {
|
||||
final FlutterSecureStorage _storage;
|
||||
|
||||
Future<void> saveToken(String key, String token);
|
||||
Future<String?> getToken(String key);
|
||||
Future<void> deleteToken(String key);
|
||||
Future<void> clearAll();
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-016: Create Auth Remote Data Source (Test)
|
||||
**File:** `test/data/data_sources/remote/auth_remote_data_source_test.dart`
|
||||
- Mock Dio client
|
||||
- Test login API call
|
||||
- Test error handling
|
||||
|
||||
#### TASK-017: Create Auth Remote Data Source
|
||||
**File:** `lib/data/data_sources/remote/auth_remote_data_source.dart`
|
||||
```dart
|
||||
@injectable
|
||||
class AuthRemoteDataSource {
|
||||
final Dio _dio;
|
||||
|
||||
Future<AuthResponse> login(String username, String password);
|
||||
Future<AuthResponse> refreshToken(String refreshToken);
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-018: Create Auth Repository (Test)
|
||||
**File:** `test/data/repositories/auth_repository_impl_test.dart`
|
||||
- Mock data sources
|
||||
- Test login flow
|
||||
- Test token storage
|
||||
|
||||
#### TASK-019: Create Auth Repository
|
||||
**File:** `lib/data/repositories/auth_repository_impl.dart`
|
||||
- Implement repository interface
|
||||
- Coordinate data sources
|
||||
- Handle errors with Either<Failure, T>
|
||||
|
||||
#### TASK-020: Create Login Use Case (Test)
|
||||
**File:** `test/domain/use_cases/auth/login_test.dart`
|
||||
- Mock repository
|
||||
- Test successful login
|
||||
- Test failed login
|
||||
|
||||
#### TASK-021: Create Login Use Case
|
||||
**File:** `lib/domain/use_cases/auth/login.dart`
|
||||
```dart
|
||||
@injectable
|
||||
class Login {
|
||||
final AuthRepository repository;
|
||||
|
||||
Future<Either<Failure, User>> call(String username, String password);
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-022: Create Auth BLoC (Test)
|
||||
**File:** `test/presentation/blocs/auth/auth_bloc_test.dart`
|
||||
- Use bloc_test package
|
||||
- Test all events and state transitions
|
||||
- Mock use cases
|
||||
|
||||
#### TASK-023: Create Auth BLoC
|
||||
**File:** `lib/presentation/blocs/auth/auth_bloc.dart`
|
||||
```dart
|
||||
@injectable
|
||||
class AuthBloc extends Bloc<AuthEvent, AuthState> {
|
||||
final Login login;
|
||||
final RefreshToken refreshToken;
|
||||
final Logout logout;
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-024: Create Login Screen (Widget Test)
|
||||
**File:** `test/presentation/screens/auth/login_screen_test.dart`
|
||||
- Test UI rendering
|
||||
- Test form validation
|
||||
- Test login button tap
|
||||
|
||||
#### TASK-025: Create Login Screen
|
||||
**File:** `lib/presentation/screens/auth/login_screen.dart`
|
||||
- Username and password fields
|
||||
- Login button
|
||||
- Loading state
|
||||
- Error display
|
||||
- BLoC integration
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-1.2 - Automatic Token Refresh
|
||||
|
||||
#### TASK-030: Create Auth Interceptor (Test)
|
||||
**File:** `test/core/network/interceptors/auth_interceptor_test.dart`
|
||||
- Test token injection
|
||||
- Test 401 handling
|
||||
- Test token refresh flow
|
||||
|
||||
#### TASK-031: Create Auth Interceptor
|
||||
**File:** `lib/core/network/interceptors/auth_interceptor.dart`
|
||||
```dart
|
||||
class AuthInterceptor extends Interceptor {
|
||||
@override
|
||||
void onRequest(RequestOptions, RequestInterceptorHandler);
|
||||
|
||||
@override
|
||||
void onError(DioException, ErrorInterceptorHandler);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Server Management
|
||||
|
||||
### Task Group: US-2.1 - View All Servers
|
||||
|
||||
#### TASK-040: Create Server Entities
|
||||
**Files:**
|
||||
- `lib/domain/entities/server.dart`
|
||||
- `lib/domain/entities/gcore_server.dart`
|
||||
- `lib/domain/entities/geviscope_server.dart`
|
||||
|
||||
#### TASK-041: Create Server Models
|
||||
**Files:**
|
||||
- `lib/data/models/server_model.dart`
|
||||
- Include JSON serialization
|
||||
|
||||
#### TASK-042: Create Server Remote Data Source
|
||||
**File:** `lib/data/data_sources/remote/server_remote_data_source.dart`
|
||||
```dart
|
||||
@RestApi(baseUrl: '/api/v1/configuration')
|
||||
abstract class ServerRemoteDataSource {
|
||||
factory ServerRemoteDataSource(Dio dio) = _ServerRemoteDataSource;
|
||||
|
||||
@GET('/servers')
|
||||
Future<ServerListResponse> getServers();
|
||||
|
||||
@GET('/servers/gcore')
|
||||
Future<GCoreServerListResponse> getGCoreServers();
|
||||
|
||||
@GET('/servers/geviscope')
|
||||
Future<GeViScopeServerListResponse> getGeViScopeServers();
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-043: Create Cache Manager
|
||||
**File:** `lib/data/data_sources/local/cache_manager.dart`
|
||||
- Implement Hive boxes
|
||||
- Cache servers with expiration
|
||||
- Cache action mappings
|
||||
|
||||
#### TASK-044: Create Server Repository
|
||||
**File:** `lib/data/repositories/server_repository_impl.dart`
|
||||
- Implement all server operations
|
||||
- Cache-first strategy
|
||||
- Error handling
|
||||
|
||||
#### TASK-045: Create Get Servers Use Case
|
||||
**File:** `lib/domain/use_cases/servers/get_servers.dart`
|
||||
|
||||
#### TASK-046: Create Server BLoC
|
||||
**File:** `lib/presentation/blocs/server/server_bloc.dart`
|
||||
- Events: LoadServers, CreateServer, UpdateServer, DeleteServer
|
||||
- States: Initial, Loading, Loaded, Error
|
||||
|
||||
#### TASK-047: Create Server List Screen
|
||||
**File:** `lib/presentation/screens/servers/server_list_screen.dart`
|
||||
- AppBar with title and actions
|
||||
- ListView with ServerCard widgets
|
||||
- Pull-to-refresh
|
||||
- Search functionality
|
||||
- Filter chips (All, G-Core, GeViScope)
|
||||
- FAB for adding new server
|
||||
|
||||
#### TASK-048: Create Server Card Widget
|
||||
**File:** `lib/presentation/widgets/server/server_card.dart`
|
||||
- Display server alias, host, type
|
||||
- Status indicator (enabled/disabled)
|
||||
- Tap to view details
|
||||
- Swipe actions (edit, delete)
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-2.4 - View Server Details
|
||||
|
||||
#### TASK-050: Create Server Detail Screen
|
||||
**File:** `lib/presentation/screens/servers/server_detail_screen.dart`
|
||||
- Display all server properties
|
||||
- Edit and Delete buttons
|
||||
- Connection status indicator
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-2.5/2.6 - Create Server
|
||||
|
||||
#### TASK-055: Create Server Form Screen
|
||||
**File:** `lib/presentation/screens/servers/server_form_screen.dart`
|
||||
- Use flutter_form_builder
|
||||
- Dynamic form based on server type
|
||||
- Validation
|
||||
- Submit button with loading state
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-2.7 - Update Server
|
||||
|
||||
#### TASK-060: Create Update Server Use Case
|
||||
**File:** `lib/domain/use_cases/servers/update_server.dart`
|
||||
|
||||
#### TASK-061: Update Server Form Screen
|
||||
**File:** Same as TASK-055
|
||||
- Pre-populate form with existing values
|
||||
- Update mode vs create mode
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-2.8 - Delete Server
|
||||
|
||||
#### TASK-065: Create Delete Server Use Case
|
||||
**File:** `lib/domain/use_cases/servers/delete_server.dart`
|
||||
|
||||
#### TASK-066: Add Delete Confirmation Dialog
|
||||
**File:** `lib/presentation/widgets/common/confirmation_dialog.dart`
|
||||
- Reusable confirmation dialog
|
||||
- Customizable title and message
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Action Mapping Management
|
||||
|
||||
### Task Group: US-3.1/3.2 - View Action Mappings
|
||||
|
||||
#### TASK-070: Create Action Mapping Entities
|
||||
**File:** `lib/domain/entities/action_mapping.dart`
|
||||
```dart
|
||||
@freezed
|
||||
class ActionMapping with _$ActionMapping {
|
||||
const factory ActionMapping({
|
||||
required int id,
|
||||
required String caption,
|
||||
required Map<String, String> inputActions,
|
||||
required List<OutputAction> outputActions,
|
||||
}) = _ActionMapping;
|
||||
}
|
||||
|
||||
@freezed
|
||||
class OutputAction with _$OutputAction {
|
||||
const factory OutputAction({
|
||||
required String action,
|
||||
required String caption,
|
||||
String? server,
|
||||
required Map<String, String> parameters,
|
||||
}) = _OutputAction;
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-071: Create Action Mapping Models
|
||||
**File:** `lib/data/models/action_mapping_model.dart`
|
||||
|
||||
#### TASK-072: Create Action Mapping Remote Data Source
|
||||
**File:** `lib/data/data_sources/remote/action_mapping_remote_data_source.dart`
|
||||
```dart
|
||||
@RestApi(baseUrl: '/api/v1/configuration')
|
||||
abstract class ActionMappingRemoteDataSource {
|
||||
@GET('/action-mappings')
|
||||
Future<List<ActionMappingModel>> getActionMappings();
|
||||
|
||||
@GET('/action-mappings/{id}')
|
||||
Future<ActionMappingModel> getActionMapping(@Path() int id);
|
||||
|
||||
@POST('/action-mappings')
|
||||
Future<void> createActionMapping(@Body() ActionMappingCreateRequest request);
|
||||
|
||||
@PUT('/action-mappings/{id}')
|
||||
Future<void> updateActionMapping(
|
||||
@Path() int id,
|
||||
@Body() ActionMappingUpdateRequest request,
|
||||
);
|
||||
|
||||
@DELETE('/action-mappings/{id}')
|
||||
Future<void> deleteActionMapping(@Path() int id);
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-073: Create Action Mapping Repository
|
||||
**File:** `lib/data/repositories/action_mapping_repository_impl.dart`
|
||||
|
||||
#### TASK-074: Create Action Mapping Use Cases
|
||||
**Files:**
|
||||
- `lib/domain/use_cases/action_mappings/get_action_mappings.dart`
|
||||
- `lib/domain/use_cases/action_mappings/create_action_mapping.dart`
|
||||
- `lib/domain/use_cases/action_mappings/update_action_mapping.dart`
|
||||
- `lib/domain/use_cases/action_mappings/delete_action_mapping.dart`
|
||||
|
||||
#### TASK-075: Create Action Mapping BLoC
|
||||
**File:** `lib/presentation/blocs/action_mapping/action_mapping_bloc.dart`
|
||||
|
||||
#### TASK-076: Create Action Mapping List Screen
|
||||
**File:** `lib/presentation/screens/action_mappings/action_mapping_list_screen.dart`
|
||||
|
||||
#### TASK-077: Create Action Mapping Detail Screen
|
||||
**File:** `lib/presentation/screens/action_mappings/action_mapping_detail_screen.dart`
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-3.3/3.4 - Create/Update Action Mapping
|
||||
|
||||
#### TASK-080: Create Action Mapping Form Screen
|
||||
**File:** `lib/presentation/screens/action_mappings/action_mapping_form_screen.dart`
|
||||
- Caption field
|
||||
- Input parameter builder
|
||||
- Add/remove parameters
|
||||
- Key-value pairs
|
||||
- Output action builder
|
||||
- Action type selector
|
||||
- Server selector
|
||||
- Parameter configuration
|
||||
- Add/remove actions
|
||||
- Submit button
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Camera Management
|
||||
|
||||
### Task Group: US-4.1/4.2 - Camera List and Details
|
||||
|
||||
#### TASK-090: Create Camera Entities
|
||||
**File:** `lib/domain/entities/camera.dart`
|
||||
|
||||
#### TASK-091: Create Camera Models
|
||||
**File:** `lib/data/models/camera_model.dart`
|
||||
|
||||
#### TASK-092: Create Camera Remote Data Source
|
||||
**File:** `lib/data/data_sources/remote/camera_remote_data_source.dart`
|
||||
```dart
|
||||
@RestApi(baseUrl: '/api/v1/cameras')
|
||||
abstract class CameraRemoteDataSource {
|
||||
@GET('')
|
||||
Future<List<CameraModel>> getCameras();
|
||||
|
||||
@GET('/{id}')
|
||||
Future<CameraModel> getCamera(@Path() String id);
|
||||
}
|
||||
```
|
||||
|
||||
#### TASK-093: Create Camera Repository
|
||||
**File:** `lib/data/repositories/camera_repository_impl.dart`
|
||||
|
||||
#### TASK-094: Create Camera Use Cases
|
||||
**Files:**
|
||||
- `lib/domain/use_cases/cameras/get_cameras.dart`
|
||||
- `lib/domain/use_cases/cameras/get_camera.dart`
|
||||
|
||||
#### TASK-095: Create Camera BLoC
|
||||
**File:** `lib/presentation/blocs/camera/camera_bloc.dart`
|
||||
|
||||
#### TASK-096: Create Camera List Screen
|
||||
**File:** `lib/presentation/screens/cameras/camera_list_screen.dart`
|
||||
|
||||
#### TASK-097: Create Camera Detail Screen
|
||||
**File:** `lib/presentation/screens/cameras/camera_detail_screen.dart`
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-4.3 - PTZ Camera Control
|
||||
|
||||
#### TASK-100: Create PTZ Control Use Cases
|
||||
**Files:**
|
||||
- `lib/domain/use_cases/cameras/control_ptz.dart`
|
||||
- Support all PTZ actions (pan, tilt, zoom, focus)
|
||||
|
||||
#### TASK-101: Create PTZ BLoC
|
||||
**File:** `lib/presentation/blocs/ptz/ptz_bloc.dart`
|
||||
|
||||
#### TASK-102: Create Camera Control Screen
|
||||
**File:** `lib/presentation/screens/cameras/camera_control_screen.dart`
|
||||
- PTZ control pad widget
|
||||
- Directional buttons (up, down, left, right)
|
||||
- Zoom controls (+/-)
|
||||
- Focus controls (near/far)
|
||||
- Stop button
|
||||
- Speed slider
|
||||
- Preset selector
|
||||
- Save preset button
|
||||
|
||||
#### TASK-103: Create PTZ Control Pad Widget
|
||||
**File:** `lib/presentation/widgets/camera/ptz_control_pad.dart`
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: Monitor & Cross-Switching
|
||||
|
||||
### Task Group: US-5.1/5.2 - Monitor Management
|
||||
|
||||
#### TASK-110: Create Monitor Entities
|
||||
**File:** `lib/domain/entities/monitor.dart`
|
||||
|
||||
#### TASK-111: Create Monitor Models
|
||||
**File:** `lib/data/models/monitor_model.dart`
|
||||
|
||||
#### TASK-112: Create Monitor Remote Data Source
|
||||
**File:** `lib/data/data_sources/remote/monitor_remote_data_source.dart`
|
||||
|
||||
#### TASK-113: Create Monitor Repository
|
||||
**File:** `lib/data/repositories/monitor_repository_impl.dart`
|
||||
|
||||
#### TASK-114: Create Monitor Use Cases
|
||||
**Files:**
|
||||
- `lib/domain/use_cases/monitors/get_monitors.dart`
|
||||
- `lib/domain/use_cases/monitors/get_monitor.dart`
|
||||
|
||||
#### TASK-115: Create Monitor BLoC
|
||||
**File:** `lib/presentation/blocs/monitor/monitor_bloc.dart`
|
||||
|
||||
#### TASK-116: Create Monitor List Screen
|
||||
**File:** `lib/presentation/screens/monitors/monitor_list_screen.dart`
|
||||
|
||||
#### TASK-117: Create Monitor Detail Screen
|
||||
**File:** `lib/presentation/screens/monitors/monitor_detail_screen.dart`
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-6.1/6.2 - Cross-Switching
|
||||
|
||||
#### TASK-120: Create Cross-Switch Use Cases
|
||||
**Files:**
|
||||
- `lib/domain/use_cases/crossswitch/connect_camera_to_monitor.dart`
|
||||
- `lib/domain/use_cases/crossswitch/clear_monitor.dart`
|
||||
|
||||
#### TASK-121: Create Cross-Switch BLoC
|
||||
**File:** `lib/presentation/blocs/crossswitch/crossswitch_bloc.dart`
|
||||
|
||||
#### TASK-122: Create Cross-Switch Screen
|
||||
**File:** `lib/presentation/screens/crossswitch/crossswitch_screen.dart`
|
||||
- Camera selector
|
||||
- Monitor selector
|
||||
- Preview of current assignments
|
||||
- Connect button
|
||||
- Clear button
|
||||
|
||||
---
|
||||
|
||||
## Phase 6: Configuration Management
|
||||
|
||||
### Task Group: US-7.1 - Export Configuration
|
||||
|
||||
#### TASK-130: Create Export Configuration Use Case
|
||||
**File:** `lib/domain/use_cases/configuration/export_configuration.dart`
|
||||
|
||||
#### TASK-131: Add Export to Settings Screen
|
||||
**File:** `lib/presentation/screens/settings/settings_screen.dart`
|
||||
- Export button
|
||||
- Save to file dialog
|
||||
- Share option
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-7.2 - View Configuration Tree
|
||||
|
||||
#### TASK-135: Create Configuration Tree Screen
|
||||
**File:** `lib/presentation/screens/configuration/configuration_tree_screen.dart`
|
||||
- Expandable tree view
|
||||
- Search functionality
|
||||
- Node type indicators
|
||||
|
||||
---
|
||||
|
||||
## Phase 7: UI & Navigation
|
||||
|
||||
### Task Group: US-8.1 - App Navigation
|
||||
|
||||
#### TASK-140: Setup GoRouter
|
||||
**File:** `lib/core/router/app_router.dart`
|
||||
```dart
|
||||
final router = GoRouter(
|
||||
routes: [
|
||||
GoRoute(
|
||||
path: '/login',
|
||||
builder: (context, state) => LoginScreen(),
|
||||
),
|
||||
GoRoute(
|
||||
path: '/servers',
|
||||
builder: (context, state) => ServerListScreen(),
|
||||
),
|
||||
// ... other routes
|
||||
],
|
||||
);
|
||||
```
|
||||
|
||||
#### TASK-141: Create App Shell with Bottom Navigation
|
||||
**File:** `lib/presentation/screens/app_shell.dart`
|
||||
- Bottom navigation bar
|
||||
- Side drawer
|
||||
- Route management
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-8.2 - Settings Screen
|
||||
|
||||
#### TASK-145: Create Settings Screen
|
||||
**File:** `lib/presentation/screens/settings/settings_screen.dart`
|
||||
- API base URL configuration
|
||||
- Theme selector
|
||||
- Language selector
|
||||
- Cache management
|
||||
- About section
|
||||
|
||||
---
|
||||
|
||||
### Task Group: US-8.3/8.4 - Error Handling & Loading States
|
||||
|
||||
#### TASK-150: Create Common Widgets
|
||||
**Files:**
|
||||
- `lib/presentation/widgets/common/loading_widget.dart`
|
||||
- Shimmer loading for lists
|
||||
- Circular progress for buttons
|
||||
- `lib/presentation/widgets/common/error_widget.dart`
|
||||
- Error icon and message
|
||||
- Retry button
|
||||
- `lib/presentation/widgets/common/empty_state_widget.dart`
|
||||
- Empty list message
|
||||
- Illustration
|
||||
|
||||
---
|
||||
|
||||
## Phase 8: Testing & Polish
|
||||
|
||||
### Task Group: Comprehensive Testing
|
||||
|
||||
#### TASK-160 [P]: Write Unit Tests for All Use Cases
|
||||
**Files:** `test/domain/use_cases/**/*_test.dart`
|
||||
- Achieve 80%+ coverage
|
||||
|
||||
#### TASK-161 [P]: Write Widget Tests for All Screens
|
||||
**Files:** `test/presentation/screens/**/*_test.dart`
|
||||
|
||||
#### TASK-162 [P]: Write Integration Tests
|
||||
**Files:** `integration_test/app_test.dart`
|
||||
- Login flow
|
||||
- Server CRUD
|
||||
- Action mapping CRUD
|
||||
|
||||
---
|
||||
|
||||
### Task Group: Performance Optimization
|
||||
|
||||
#### TASK-170: Implement List Pagination
|
||||
**Files:** Update all list screens
|
||||
- Infinite scroll
|
||||
- Page size: 20 items
|
||||
|
||||
#### TASK-171: Optimize Image Loading
|
||||
**Files:** Update image widgets
|
||||
- Use cached_network_image
|
||||
- Progressive loading
|
||||
|
||||
#### TASK-172: Implement Request Debouncing
|
||||
**Files:** Update search fields
|
||||
- Debounce duration: 300ms
|
||||
|
||||
---
|
||||
|
||||
### Task Group: Accessibility
|
||||
|
||||
#### TASK-175: Add Semantic Labels
|
||||
**Files:** All widgets
|
||||
- Proper semantic labels for screen readers
|
||||
|
||||
#### TASK-176: Test with Screen Reader
|
||||
**Files:** N/A (manual testing)
|
||||
|
||||
#### TASK-177: Verify Contrast Ratios
|
||||
**Files:** `lib/core/theme/colors.dart`
|
||||
|
||||
---
|
||||
|
||||
## Phase 9: Deployment Preparation
|
||||
|
||||
### Task Group: App Configuration
|
||||
|
||||
#### TASK-180: Configure App Icons
|
||||
**File:** Run flutter_launcher_icons
|
||||
|
||||
#### TASK-181: Configure Splash Screen
|
||||
**File:** Run flutter_native_splash
|
||||
|
||||
#### TASK-182: Update App Metadata
|
||||
**Files:**
|
||||
- `android/app/src/main/AndroidManifest.xml`
|
||||
- `ios/Runner/Info.plist`
|
||||
|
||||
---
|
||||
|
||||
### Task Group: Build & Release
|
||||
|
||||
#### TASK-185: Create Release Build (Android)
|
||||
```bash
|
||||
flutter build apk --release
|
||||
flutter build appbundle --release
|
||||
```
|
||||
|
||||
#### TASK-186: Create Release Build (iOS)
|
||||
```bash
|
||||
flutter build ipa --release
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dependencies Between Tasks
|
||||
|
||||
```
|
||||
Foundation Tasks (001-005) → All other tasks
|
||||
|
||||
Authentication:
|
||||
010-011 → 012-013 → 014-015 → 016-017 → 018-019 → 020-021 → 022-023 → 024-025
|
||||
030-031 (depends on 022-023)
|
||||
|
||||
Servers:
|
||||
040-041 → 042-043 → 044 → 045 → 046 → 047-048
|
||||
050 (depends on 046)
|
||||
055 (depends on 046)
|
||||
060-061 (depends on 046)
|
||||
065-066 (depends on 046)
|
||||
|
||||
Action Mappings:
|
||||
070-071 → 072 → 073 → 074 → 075 → 076-077
|
||||
080 (depends on 075)
|
||||
|
||||
Cameras:
|
||||
090-091 → 092 → 093 → 094 → 095 → 096-097
|
||||
100-103 (depends on 095)
|
||||
|
||||
Monitors:
|
||||
110-111 → 112 → 113 → 114 → 115 → 116-117
|
||||
|
||||
Cross-Switching:
|
||||
120-122 (depends on 095 and 115)
|
||||
|
||||
Configuration:
|
||||
130-131
|
||||
135
|
||||
|
||||
Navigation:
|
||||
140-141 (depends on all screens being created)
|
||||
|
||||
Settings:
|
||||
145
|
||||
|
||||
Common Widgets:
|
||||
150 (can be done in parallel, used by many screens)
|
||||
|
||||
Testing:
|
||||
160-162 (depends on all implementations)
|
||||
|
||||
Performance:
|
||||
170-172 (depends on screens)
|
||||
|
||||
Accessibility:
|
||||
175-177 (depends on all widgets)
|
||||
|
||||
Deployment:
|
||||
180-186 (depends on everything)
|
||||
```
|
||||
|
||||
## Parallel Execution Opportunities
|
||||
|
||||
Tasks marked with `[P]` can be executed in parallel:
|
||||
- TASK-001, 002, 004, 005 (setup tasks)
|
||||
- TASK-160, 161, 162 (testing can be distributed)
|
||||
|
||||
Multiple developers can work on different epics simultaneously once foundation is complete.
|
||||
@@ -681,35 +681,428 @@ class AuditOutcome(str, Enum):
|
||||
|
||||
---
|
||||
|
||||
## 6. Unified Architecture Entities
|
||||
|
||||
### 6.1 GeViScope Instance
|
||||
|
||||
Represents a configured GeViScope server (GSCServer) connection.
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class GeViScopeInstance(BaseModel):
|
||||
id: str = Field(..., pattern="^[a-z][a-z0-9-]*$") # "main", "parking", "warehouse"
|
||||
name: str = Field(min_length=1, max_length=100)
|
||||
description: Optional[str] = Field(max_length=500)
|
||||
host: str # Hostname or IP address
|
||||
port: int = Field(default=7700, ge=1, le=65535)
|
||||
username: str
|
||||
# Password stored securely (not in database)
|
||||
is_default: bool = False
|
||||
enabled: bool = True
|
||||
connection_status: ConnectionStatus
|
||||
last_connected: Optional[datetime] = None
|
||||
camera_count: int = 0
|
||||
monitor_count: int = 0
|
||||
sdk_version: Optional[str] = None
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
|
||||
class ConnectionStatus(str, Enum):
|
||||
CONNECTED = "connected"
|
||||
DISCONNECTED = "disconnected"
|
||||
CONNECTING = "connecting"
|
||||
ERROR = "error"
|
||||
```
|
||||
|
||||
**Validation Rules**:
|
||||
- `id`: Lowercase alphanumeric with dashes, starts with letter
|
||||
- `host`: Valid hostname or IP address
|
||||
- `is_default`: Only one instance can be default
|
||||
- `enabled`: Disabled instances not available for operations
|
||||
|
||||
**Relationships**:
|
||||
- GeViScopeInstance → Camera (one-to-many)
|
||||
- GeViScopeInstance → Monitor (one-to-many)
|
||||
- GeViScopeInstance → CrossSwitchRoute (one-to-many)
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"id": "main",
|
||||
"name": "Main Building",
|
||||
"description": "Primary surveillance system",
|
||||
"host": "localhost",
|
||||
"port": 7700,
|
||||
"username": "sysadmin",
|
||||
"is_default": true,
|
||||
"enabled": true,
|
||||
"connection_status": "connected",
|
||||
"last_connected": "2025-12-10T14:00:00Z",
|
||||
"camera_count": 13,
|
||||
"monitor_count": 256,
|
||||
"sdk_version": "7.9.975.68"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 6.2 Monitor (Video Output)
|
||||
|
||||
Represents a video output channel (logical display channel, not physical display).
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class Monitor(BaseModel):
|
||||
id: int # Monitor ID from GeViScope (1-256)
|
||||
geviscope_instance_id: str # Which GeViScope instance
|
||||
global_id: str # GeViScope GlobalID
|
||||
name: str = Field(min_length=1, max_length=100)
|
||||
description: Optional[str] = Field(max_length=500)
|
||||
is_active: bool = True
|
||||
is_enabled: bool = True
|
||||
current_camera_id: Optional[int] = None # Currently routed camera
|
||||
current_route_id: Optional[UUID] = None
|
||||
status: MonitorStatus
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
|
||||
class MonitorStatus(str, Enum):
|
||||
ONLINE = "online"
|
||||
OFFLINE = "offline"
|
||||
ERROR = "error"
|
||||
```
|
||||
|
||||
**Important Notes**:
|
||||
- Monitors are **logical routing channels**, not physical displays
|
||||
- CrossSwitch routes video to monitors at the server level
|
||||
- **Viewer applications (GSCView)** required to actually display monitor video
|
||||
- Monitor enumeration may return more IDs than physical outputs exist
|
||||
|
||||
**Validation Rules**:
|
||||
- `id`: Positive integer, unique within GeViScope instance
|
||||
- `geviscope_instance_id`: Must reference existing instance
|
||||
- `current_camera_id`: If set, must reference existing camera
|
||||
|
||||
**Relationships**:
|
||||
- Monitor → GeViScopeInstance (many-to-one)
|
||||
- Monitor → Camera (many-to-one, optional via current_camera_id)
|
||||
- Monitor → CrossSwitchRoute (one-to-many)
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"geviscope_instance_id": "main",
|
||||
"global_id": "b8c2d4e6-f7a8-49b0-c1d2-e3f4a5b6c7d8",
|
||||
"name": "Video Output 1",
|
||||
"description": "Main control room display",
|
||||
"is_active": true,
|
||||
"is_enabled": true,
|
||||
"current_camera_id": 101038,
|
||||
"current_route_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
||||
"status": "online"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 6.3 CrossSwitch Route
|
||||
|
||||
Represents an active or historical video routing (camera → monitor).
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class CrossSwitchRoute(BaseModel):
|
||||
id: UUID = Field(default_factory=uuid4)
|
||||
geviscope_instance_id: str # Which GeViScope instance
|
||||
camera_id: int # Video input channel
|
||||
monitor_id: int # Video output channel
|
||||
mode: int = 0 # 0=normal (sm_Normal)
|
||||
is_active: bool = True # False when cleared
|
||||
executed_at: datetime
|
||||
executed_by: UUID # User who created route
|
||||
executed_by_username: str
|
||||
cleared_at: Optional[datetime] = None
|
||||
cleared_by: Optional[UUID] = None
|
||||
sdk_success: bool = True # SDK execution result
|
||||
sdk_message: Optional[str] = None
|
||||
camera_name: Optional[str] = None # Cached camera info
|
||||
monitor_name: Optional[str] = None # Cached monitor info
|
||||
|
||||
class CrossSwitchRequest(BaseModel):
|
||||
"""Request model for cross-switch operation"""
|
||||
camera_id: int = Field(ge=1)
|
||||
monitor_id: int = Field(ge=1)
|
||||
mode: int = Field(default=0, ge=0, le=2)
|
||||
|
||||
class CrossSwitchResponse(BaseModel):
|
||||
"""Response model for cross-switch operation"""
|
||||
success: bool
|
||||
message: str
|
||||
route: CrossSwitchRoute
|
||||
```
|
||||
|
||||
**State Transitions**:
|
||||
```
|
||||
Created (is_active=True) → Cleared (is_active=False)
|
||||
```
|
||||
|
||||
**Validation Rules**:
|
||||
- `camera_id`: Must exist and be online in the GeViScope instance
|
||||
- `monitor_id`: Must exist in the GeViScope instance
|
||||
- `mode`: 0=normal (sm_Normal), other modes reserved
|
||||
- `executed_by`: Must be authenticated user
|
||||
|
||||
**Relationships**:
|
||||
- CrossSwitchRoute → GeViScopeInstance (many-to-one)
|
||||
- CrossSwitchRoute → Camera (many-to-one)
|
||||
- CrossSwitchRoute → Monitor (many-to-one)
|
||||
- CrossSwitchRoute → User (executed_by, many-to-one)
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
||||
"geviscope_instance_id": "main",
|
||||
"camera_id": 101038,
|
||||
"monitor_id": 1,
|
||||
"mode": 0,
|
||||
"is_active": true,
|
||||
"executed_at": "2025-12-10T14:30:00Z",
|
||||
"executed_by": "550e8400-e29b-41d4-a716-446655440000",
|
||||
"executed_by_username": "admin",
|
||||
"sdk_success": true,
|
||||
"sdk_message": "Cross-switch executed successfully",
|
||||
"camera_name": "Entrance Camera",
|
||||
"monitor_name": "Video Output 1"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 6.4 Alarm (GeViSoft)
|
||||
|
||||
Represents a system-wide alarm configuration in GeViSoft.
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class Alarm(BaseModel):
|
||||
id: UUID = Field(default_factory=uuid4)
|
||||
alarm_id: int # GeViSoft alarm ID
|
||||
name: str = Field(min_length=1, max_length=100)
|
||||
description: Optional[str] = Field(max_length=500)
|
||||
priority: AlarmPriority
|
||||
monitor_group_id: Optional[int] = None
|
||||
cameras: List[int] = [] # Camera channels
|
||||
start_actions: List[str] = [] # Actions on alarm start
|
||||
stop_actions: List[str] = [] # Actions on alarm stop
|
||||
acknowledge_actions: List[str] = [] # Actions on acknowledge
|
||||
is_active: bool = False
|
||||
triggered_at: Optional[datetime] = None
|
||||
acknowledged_at: Optional[datetime] = None
|
||||
acknowledged_by: Optional[UUID] = None
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
|
||||
class AlarmPriority(str, Enum):
|
||||
LOW = "low"
|
||||
MEDIUM = "medium"
|
||||
HIGH = "high"
|
||||
CRITICAL = "critical"
|
||||
```
|
||||
|
||||
**Validation Rules**:
|
||||
- `alarm_id`: Positive integer, unique
|
||||
- `cameras`: All camera IDs must exist
|
||||
- `start_actions`: Valid GeViSoft action strings
|
||||
- `is_active`: Set true when triggered, false when acknowledged/stopped
|
||||
|
||||
**Relationships**:
|
||||
- Alarm → Camera (many-to-many via cameras list)
|
||||
- Alarm → User (acknowledged_by, many-to-one, optional)
|
||||
|
||||
---
|
||||
|
||||
### 6.5 Action Mapping
|
||||
|
||||
Represents automation rules in GeViSoft (input action → output actions).
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class ActionMapping(BaseModel):
|
||||
id: UUID = Field(default_factory=uuid4)
|
||||
name: str = Field(min_length=1, max_length=100)
|
||||
description: Optional[str] = Field(max_length=500)
|
||||
input_action: str # GeViSoft action that triggers mapping
|
||||
output_actions: List[str] # Actions to execute
|
||||
geviscope_instance_scope: Optional[str] = None # Limit to specific instance
|
||||
enabled: bool = True
|
||||
execution_count: int = 0
|
||||
last_executed: Optional[datetime] = None
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
created_by: UUID
|
||||
|
||||
class ActionMappingExecution(BaseModel):
|
||||
"""Execution log for action mappings"""
|
||||
id: UUID = Field(default_factory=uuid4)
|
||||
mapping_id: UUID
|
||||
input_action: str
|
||||
output_actions_executed: List[str]
|
||||
success: bool
|
||||
error_message: Optional[str] = None
|
||||
executed_at: datetime
|
||||
```
|
||||
|
||||
**Validation Rules**:
|
||||
- `input_action`: Valid GeViSoft action format
|
||||
- `output_actions`: Valid GeViSoft action formats
|
||||
- `geviscope_instance_scope`: If set, must reference existing instance
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
|
||||
"name": "Motion Detection Alert",
|
||||
"description": "Route cameras to monitors when motion detected",
|
||||
"input_action": "VMD_Start(101038)",
|
||||
"output_actions": [
|
||||
"CrossSwitch(101038, 1, 0)",
|
||||
"SendMail(security@example.com, Motion Detected)"
|
||||
],
|
||||
"geviscope_instance_scope": "main",
|
||||
"enabled": true,
|
||||
"execution_count": 42,
|
||||
"last_executed": "2025-12-10T14:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 6.6 G-Core Server
|
||||
|
||||
Represents a configured G-Core server (remote surveillance server connection) in GeViSoft.
|
||||
|
||||
**Schema**:
|
||||
```python
|
||||
class GCoreServer(BaseModel):
|
||||
id: str = Field(..., pattern="^[0-9]+$") # Numeric string ID
|
||||
alias: str = Field(min_length=1, max_length=100) # Display name
|
||||
host: str = Field(min_length=1, max_length=255) # IP address or hostname
|
||||
user: str = Field(default="admin", max_length=100) # Username
|
||||
password: str = Field(max_length=100) # Password (encrypted in storage)
|
||||
enabled: bool = True # Enable/disable server
|
||||
deactivate_echo: bool = False # Deactivate echo
|
||||
deactivate_live_check: bool = False # Deactivate live check
|
||||
created_at: datetime
|
||||
updated_at: datetime
|
||||
created_by: UUID
|
||||
|
||||
class GCoreServerInput(BaseModel):
|
||||
"""Request model for creating/updating G-Core server"""
|
||||
alias: str = Field(min_length=1, max_length=100)
|
||||
host: str = Field(min_length=1, max_length=255)
|
||||
user: str = Field(default="admin", max_length=100)
|
||||
password: str = Field(max_length=100)
|
||||
enabled: bool = True
|
||||
deactivate_echo: bool = False
|
||||
deactivate_live_check: bool = False
|
||||
```
|
||||
|
||||
**Implementation Notes**:
|
||||
- ID is auto-incremented based on highest existing numeric server ID
|
||||
- Field order in configuration tree must be: Alias, DeactivateEcho, DeactivateLiveCheck, Enabled, Host, Password, User
|
||||
- Bool fields must use type code 1 (bool) not type code 4 (int32) for GeViSet compatibility
|
||||
- Password stored as plain text in GeViSoft configuration (SDK limitation)
|
||||
|
||||
**Validation Rules**:
|
||||
- `id`: Numeric string, auto-generated on CREATE
|
||||
- `alias`: Required, display name for server
|
||||
- `host`: Required, valid IP address or hostname
|
||||
- `user`: Defaults to "admin" if not provided
|
||||
- `enabled`: Controls whether server is active
|
||||
|
||||
**Relationships**:
|
||||
- GCoreServer → User (created_by, many-to-one)
|
||||
- Configuration stored in GeViSoft .set file under GeViGCoreServer folder
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"id": "2",
|
||||
"alias": "Remote Office Server",
|
||||
"host": "192.168.1.100",
|
||||
"user": "admin",
|
||||
"password": "secure_password",
|
||||
"enabled": true,
|
||||
"deactivate_echo": false,
|
||||
"deactivate_live_check": false,
|
||||
"created_at": "2025-12-16T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
**CRUD Operations** (2025-12-16):
|
||||
- ✅ CREATE: Working - creates server with auto-incremented ID
|
||||
- ✅ READ: Working - reads all servers or single server by ID
|
||||
- ⚠️ UPDATE: Known bug - requires fix for "Server ID is required" error
|
||||
- ✅ DELETE: Working - deletes server by ID
|
||||
|
||||
**Critical Implementation Details**:
|
||||
- **Cascade Deletion Prevention**: When deleting multiple servers, always delete in reverse order (highest ID first) to prevent ID shifting
|
||||
- **Bool Type Handling**: Must write as bool type (type code 1) not int32, even though GeViSoft stores as int32
|
||||
- **SetupClient Required**: All configuration changes must use SetupClient for download/upload to ensure atomicity
|
||||
|
||||
---
|
||||
|
||||
## Entity Relationships Diagram
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────────┐ ┌────────────┐
|
||||
│ User │──1:N──│ Session │ │ AuditLog │
|
||||
└────┬────┘ └─────────────┘ └─────┬──────┘
|
||||
│ │
|
||||
│1:N │N:1
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ EventSubscription│ │
|
||||
└─────────────────┘ │
|
||||
│
|
||||
┌────────────┐ ┌─────────┐ ┌──────▼─────┐
|
||||
│ Camera │──1:N──│ Stream │ │ Recording │
|
||||
└─────┬──────┘ └─────────┘ └──────┬─────┘
|
||||
│ │
|
||||
│1:N │N:1
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ AnalyticsConfig │ │
|
||||
└─────────────────┘ │
|
||||
│ │
|
||||
│1:N │
|
||||
▼ ▼
|
||||
┌─────────────┐ ┌────────────────────────────┐
|
||||
│ PTZPreset │ │ Event │
|
||||
└─────────────┘ └────────────────────────────┘
|
||||
┌────────────────────┐
|
||||
│ GeViScopeInstance │──┐
|
||||
└────────────────────┘ │
|
||||
│1:N
|
||||
┌────────────┴──────────────┐
|
||||
│ │
|
||||
▼ ▼
|
||||
┌────────────┐ ┌────────────┐ ┌─────────────────┐
|
||||
│ Camera │──1:N──│ Stream │ │ Monitor │
|
||||
└─────┬──────┘ └─────────┘ └────────┬────────┘
|
||||
│ │
|
||||
│1:N │1:N
|
||||
▼ ▼
|
||||
┌─────────────────┐ ┌───────────────────┐
|
||||
│ AnalyticsConfig │ │ CrossSwitchRoute │
|
||||
└─────────────────┘ └─────────┬─────────┘
|
||||
│ │
|
||||
│1:N │N:1
|
||||
▼ │
|
||||
┌─────────────┐ │
|
||||
│ PTZPreset │ │
|
||||
└─────────────┘ ▼
|
||||
┌─────────┐
|
||||
┌─────────┐ ┌─────────────┐ │ User │──1:N──┌──────────────────┐
|
||||
│ User │──1:N──│ Session │ └────┬────┘ │ EventSubscription│
|
||||
└────┬────┘ └─────────────┘ │ └──────────────────┘
|
||||
│ │1:N
|
||||
│1:N │
|
||||
▼ ▼
|
||||
┌────────────┐ ┌──────────────┐
|
||||
│ AuditLog │ │ Alarm │
|
||||
└────────────┘ └──────────────┘
|
||||
│M:N
|
||||
▼
|
||||
┌────────────┐
|
||||
│ Camera │
|
||||
└────────────┘
|
||||
|
||||
┌──────────────────┐ ┌──────────┐
|
||||
│ ActionMapping │──1:N──│ Event │
|
||||
└──────────────────┘ └────┬─────┘
|
||||
│N:1
|
||||
▼
|
||||
┌──────────────┐
|
||||
│ Recording │
|
||||
└──────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
@@ -720,13 +1113,19 @@ class AuditOutcome(str, Enum):
|
||||
|--------|-----------------|
|
||||
| User | Unique username/email, valid role, bcrypt password |
|
||||
| Session | Valid JWT, IP address, TTL enforced |
|
||||
| GeViScopeInstance | Unique ID, valid host, only one default |
|
||||
| Camera | Valid channel ID, status from SDK, capabilities match |
|
||||
| Monitor | Valid ID within instance, scoped by instance ID |
|
||||
| CrossSwitchRoute | Camera/monitor exist and online, valid user |
|
||||
| Stream | Camera online, token authentication, supported formats |
|
||||
| Recording | Valid time range, camera exists, ring buffer aware |
|
||||
| Event | Valid type, severity, camera permissions |
|
||||
| EventSubscription | User has camera permissions |
|
||||
| AnalyticsConfig | Camera supports type, valid zones/settings |
|
||||
| PTZPreset | Camera has PTZ, valid coordinates |
|
||||
| Alarm (GeViSoft) | Valid alarm ID, cameras exist, valid actions |
|
||||
| ActionMapping | Valid action formats, instance scope if specified |
|
||||
| GCoreServer | Numeric ID, valid host, bool type handling |
|
||||
| AuditLog | Immutable, complete metadata |
|
||||
|
||||
---
|
||||
@@ -764,5 +1163,26 @@ class AuditOutcome(str, Enum):
|
||||
|
||||
---
|
||||
|
||||
**Phase 1 Status**: ✅ Data model complete
|
||||
**Next**: Generate OpenAPI contracts
|
||||
## CrossSwitch Route State Machine
|
||||
```
|
||||
[Created] (is_active=True) ──clear_monitor──▶ [Cleared] (is_active=False)
|
||||
│
|
||||
└──new_crossswitch──▶ [Replaced] (old route cleared, new route created)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Monitor Assignment State Machine
|
||||
```
|
||||
[Empty] (no camera) ──crossswitch──▶ [Assigned] (camera routed)
|
||||
│
|
||||
└──clear──▶ [Empty]
|
||||
│
|
||||
└──crossswitch──▶ [Reassigned] (new camera)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Phase 1 Status**: ✅ Data model updated with unified architecture and configuration management
|
||||
**Last Updated**: 2025-12-16
|
||||
**Next**: Implement multi-instance SDK bridge connections
|
||||
|
||||
@@ -256,7 +256,61 @@ See [SDK_INTEGRATION_LESSONS.md](../../SDK_INTEGRATION_LESSONS.md) for complete
|
||||
- **RecordingService**: QueryRecordings, StartRecording, StopRecording
|
||||
- **AnalyticsService**: ConfigureAnalytics, GetAnalyticsConfig
|
||||
|
||||
## Phase 2 - Tasks ⏭️ NEXT
|
||||
## Phase 2 - Configuration Management ✅ COMPLETED (2025-12-16)
|
||||
|
||||
**Implemented**: GeViSoft configuration management via REST API and gRPC SDK Bridge
|
||||
|
||||
**Deliverables**:
|
||||
- G-Core Server CRUD operations (CREATE, READ, DELETE working; UPDATE has known bug)
|
||||
- Action Mapping CRUD operations (CREATE, READ, UPDATE, DELETE all working)
|
||||
- SetupClient integration for configuration download/upload
|
||||
- Configuration tree parsing and navigation
|
||||
- Critical bug fixes (cascade deletion prevention)
|
||||
|
||||
**Key Components Implemented**:
|
||||
|
||||
### REST API Endpoints
|
||||
- `GET /api/v1/configuration/servers` - List all G-Core servers
|
||||
- `GET /api/v1/configuration/servers/{server_id}` - Get single server
|
||||
- `POST /api/v1/configuration/servers` - Create new server
|
||||
- `PUT /api/v1/configuration/servers/{server_id}` - Update server (⚠️ known bug)
|
||||
- `DELETE /api/v1/configuration/servers/{server_id}` - Delete server
|
||||
- `GET /api/v1/configuration/action-mappings` - List all action mappings
|
||||
- `GET /api/v1/configuration/action-mappings/{mapping_id}` - Get single mapping
|
||||
- `POST /api/v1/configuration/action-mappings` - Create mapping
|
||||
- `PUT /api/v1/configuration/action-mappings/{mapping_id}` - Update mapping
|
||||
- `DELETE /api/v1/configuration/action-mappings/{mapping_id}` - Delete mapping
|
||||
|
||||
### gRPC SDK Bridge Implementation
|
||||
- **ConfigurationService**: Complete CRUD operations for servers and action mappings
|
||||
- **SetupClient Integration**: Download/upload .set configuration files
|
||||
- **FolderTreeParser**: Parse GeViSoft binary configuration format
|
||||
- **FolderTreeWriter**: Write configuration changes back to GeViSoft
|
||||
|
||||
### Critical Fixes
|
||||
- **Cascade Deletion Bug** (2025-12-16): Fixed critical bug where deleting multiple action mappings in ascending order caused ID shifting, resulting in deletion of wrong mappings
|
||||
- **Solution**: Always delete in reverse order (highest ID first)
|
||||
- **Impact**: Prevented data loss of ~54 mappings during testing
|
||||
- **Documentation**: CRITICAL_BUG_FIX_DELETE.md
|
||||
|
||||
### Test Scripts
|
||||
- `comprehensive_crud_test.py` - Full CRUD verification with server and mapping operations
|
||||
- `safe_delete_test.py` - Minimal test to verify cascade deletion fix
|
||||
- `server_manager.py` - Production-ready server lifecycle management
|
||||
- `cleanup_to_base.py` - Restore configuration to base state
|
||||
- `verify_config_via_grpc.py` - Configuration verification tool
|
||||
|
||||
### Known Issues
|
||||
- Server UPDATE operation fails with "Server ID is required" error (documented, workaround: delete and recreate)
|
||||
- Bool fields stored as int32 in GeViSoft configuration (acceptable - GeViSet reads correctly)
|
||||
|
||||
**Documentation**:
|
||||
- [SERVER_CRUD_IMPLEMENTATION.md](../../SERVER_CRUD_IMPLEMENTATION.md) - Complete implementation guide
|
||||
- [CRITICAL_BUG_FIX_DELETE.md](../../CRITICAL_BUG_FIX_DELETE.md) - Cascade deletion bug analysis
|
||||
|
||||
**Next**: Phase 3 - Implement remaining user stories (streams, events, analytics)
|
||||
|
||||
## Phase 3 - Tasks ⏭️ NEXT
|
||||
|
||||
**Command**: `/speckit.tasks`
|
||||
|
||||
@@ -275,7 +329,7 @@ Will generate:
|
||||
5. **Extended Features**: Recording management, analytics configuration
|
||||
6. **Testing & Documentation**: Contract tests, integration tests, deployment docs
|
||||
|
||||
## Phase 3 - Implementation ⏭️ FUTURE
|
||||
## Phase 4 - Implementation ⏭️ FUTURE
|
||||
|
||||
**Command**: `/speckit.implement`
|
||||
|
||||
@@ -389,6 +443,7 @@ async with websockets.connect(uri) as ws:
|
||||
|
||||
## References
|
||||
|
||||
### Project Documentation
|
||||
- **Specification**: [spec.md](./spec.md) - User stories, requirements, success criteria
|
||||
- **Research**: [research.md](./research.md) - Technical decisions and architectural analysis
|
||||
- **Data Model**: [data-model.md](./data-model.md) - Entity schemas and relationships
|
||||
@@ -397,7 +452,23 @@ async with websockets.connect(uri) as ws:
|
||||
- **SDK Lessons**: [../../SDK_INTEGRATION_LESSONS.md](../../SDK_INTEGRATION_LESSONS.md) - Critical SDK integration knowledge
|
||||
- **Constitution**: [../../.specify/memory/constitution.md](../../.specify/memory/constitution.md) - Development principles
|
||||
|
||||
### SDK Documentation (Extracted & Searchable)
|
||||
**Location**: `C:\Gevisoft\Documentation\extracted_html\`
|
||||
|
||||
- **Comprehensive SDK Reference**: `C:\DEV\COPILOT\gevisoft-sdk-reference.md`
|
||||
- Complete guide to GeViSoft .NET SDK
|
||||
- Action mapping implementation patterns
|
||||
- Code examples and best practices
|
||||
- Generated: 2025-12-11
|
||||
|
||||
**Key Documentation Files**:
|
||||
- **Action Mapping**: `GeViSoft_SDK_Documentation\313Action Mapping.htm`
|
||||
- **State Queries**: `GeViSoft_SDK_Documentation\414StateQueries.htm`
|
||||
- **Database Queries**: `GeViSoft_SDK_Documentation\415DatabaseQueries.htm`
|
||||
- **GeViAPIClient Reference**: `GeViSoft_API_Documentation\class_ge_vi_a_p_i_client.html`
|
||||
- **CAction Reference**: `GeViSoft_API_Documentation\class_ge_vi_a_p_i___namespace_1_1_c_action.html`
|
||||
|
||||
---
|
||||
|
||||
**Plan Status**: Phase 0 ✅ | Phase 1 ✅ | Phase 2 ⏭️ | Phase 3 ⏭️
|
||||
**Last Updated**: 2025-12-08
|
||||
**Plan Status**: Phase 0 ✅ | Phase 1 ✅ | Phase 2 ⏭️ | Phase 3 🔄 IN PROGRESS (Configuration Management ✅)
|
||||
**Last Updated**: 2025-12-16
|
||||
|
||||
@@ -1,9 +1,43 @@
|
||||
# Feature Specification: Geutebruck Video Surveillance API
|
||||
# Feature Specification: Geutebruck Unified Video Surveillance API
|
||||
|
||||
**Feature Branch**: `001-surveillance-api`
|
||||
**Created**: 2025-11-13
|
||||
**Status**: Draft
|
||||
**Input**: User description: "Complete RESTful API for Geutebruck GeViScope/GeViSoft video surveillance system control"
|
||||
**Updated**: 2025-12-16 (Configuration Management + Critical Bug Fixes)
|
||||
**Status**: In Progress
|
||||
**Input**: "Complete RESTful API for Geutebruck GeViSoft/GeViScope unified video surveillance system control with multi-instance support"
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
This API provides a **unified interface** to control both GeViSoft (management platform) and multiple GeViScope instances (video servers):
|
||||
|
||||
```
|
||||
Geutebruck Unified API
|
||||
│
|
||||
├── GeViSoft Layer (Management)
|
||||
│ └── GeViServer Connection
|
||||
│ ├── System-wide alarm management
|
||||
│ ├── Event coordination across GeViScope instances
|
||||
│ ├── Action mapping and automation
|
||||
│ └── Cross-system orchestration
|
||||
│
|
||||
└── GeViScope Layer (Video Operations)
|
||||
├── GeViScope Instance "main" (GSCServer - localhost)
|
||||
│ ├── Cameras: 101027-101041
|
||||
│ └── Monitors: 1-256
|
||||
├── GeViScope Instance "parking" (GSCServer - 192.168.1.100)
|
||||
│ ├── Cameras: 201001-201020
|
||||
│ └── Monitors: 1-64
|
||||
└── GeViScope Instance "warehouse" (GSCServer - 192.168.1.101)
|
||||
├── Cameras: 301001-301050
|
||||
└── Monitors: 1-128
|
||||
```
|
||||
|
||||
**Key Concepts:**
|
||||
- **GeViSoft** = Management platform controlling multiple GeViScope instances (1 per system)
|
||||
- **GeViScope** = Video server instances handling cameras, monitors, video routing (N per system)
|
||||
- **Monitors (Video Outputs)** = Logical display channels (NOT physical displays, require viewer apps)
|
||||
- **CrossSwitch** = Video routing command (camera → monitor at server level)
|
||||
- **GSCView** = Viewer application that displays video outputs
|
||||
|
||||
## User Scenarios & Testing *(mandatory)*
|
||||
|
||||
@@ -24,7 +58,41 @@ As a developer integrating a custom surveillance application, I need to authenti
|
||||
|
||||
---
|
||||
|
||||
### User Story 2 - Live Video Stream Access (Priority: P1)
|
||||
### User Story 2 - Multi-Instance GeViScope Management (Priority: P1)
|
||||
|
||||
As a system administrator, I need to manage multiple GeViScope instances through a single API so that I can control video operations across different locations and servers.
|
||||
|
||||
**Why this priority**: Multi-instance support is core to the unified architecture. Without it, the API can only control one GeViScope server, limiting scalability.
|
||||
|
||||
**Independent Test**: Can be fully tested by configuring multiple GeViScope instances, querying available instances, and executing operations on specific instances.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** three GeViScope instances configured (main, parking, warehouse), **When** a user requests `/api/v1/geviscope/instances`, **Then** they receive a list of all instances with status, camera count, and connection state
|
||||
2. **Given** operations targeting a specific instance, **When** a user calls `/api/v1/geviscope/parking/cameras`, **Then** they receive only cameras from the parking instance
|
||||
3. **Given** a default instance configured, **When** a user calls `/api/v1/cameras` without instance ID, **Then** the request routes to the default instance
|
||||
4. **Given** one GeViScope instance is offline, **When** operations target that instance, **Then** the API returns clear error messages while other instances remain operational
|
||||
|
||||
---
|
||||
|
||||
### User Story 3 - Video CrossSwitch and Monitor Control (Priority: P1)
|
||||
|
||||
As a security operator, I need to route camera video feeds to specific monitors via CrossSwitch commands so that I can dynamically control what video appears on display systems.
|
||||
|
||||
**Why this priority**: CrossSwitch is the core video routing mechanism in GeViScope systems. Without it, operators cannot control video distribution to displays.
|
||||
|
||||
**Independent Test**: Can be fully tested by executing CrossSwitch commands to route cameras to monitors, verifying routes in the routing table, and clearing monitor assignments.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** camera 101038 and monitor 1 exist, **When** an operator sends `POST /api/v1/crossswitch` with `{camera_id: 101038, monitor_id: 1}`, **Then** the camera video is routed to monitor 1 at the server level and a route record is created
|
||||
2. **Given** an active route exists, **When** an operator queries `/api/v1/crossswitch/routing`, **Then** they receive a list of all active camera→monitor routes with timestamps and user who created them
|
||||
3. **Given** a monitor displaying video, **When** an operator sends `DELETE /api/v1/crossswitch/{monitor_id}`, **Then** the monitor is cleared and the route is marked inactive
|
||||
4. **Given** multiple monitors in a monitor group, **When** an alarm triggers CrossSwitch actions, **Then** all designated cameras are routed to their assigned monitors automatically
|
||||
|
||||
---
|
||||
|
||||
### User Story 4 - Live Video Stream Access (Priority: P1)
|
||||
|
||||
As a security operator, I need to view live video streams from surveillance cameras through the API so that I can monitor locations in real-time from a custom dashboard.
|
||||
|
||||
@@ -34,14 +102,14 @@ As a security operator, I need to view live video streams from surveillance came
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated user with camera view permissions, **When** they request a live stream for camera channel 5, **Then** they receive a stream URL or WebSocket connection that delivers live video within 2 seconds
|
||||
1. **Given** an authenticated user with camera view permissions, **When** they request a live stream for camera 101038, **Then** they receive a stream URL that delivers live video within 2 seconds
|
||||
2. **Given** a camera that is offline, **When** a user requests its stream, **Then** they receive a clear error message indicating the camera is unavailable
|
||||
3. **Given** multiple concurrent users, **When** they request the same camera stream, **Then** all users can view the stream simultaneously without degradation (up to 100 concurrent streams)
|
||||
4. **Given** a user without permission for a specific camera, **When** they request its stream, **Then** they receive a 403 Forbidden response
|
||||
|
||||
---
|
||||
|
||||
### User Story 3 - Camera PTZ Control (Priority: P1)
|
||||
### User Story 5 - Camera PTZ Control (Priority: P1)
|
||||
|
||||
As a security operator, I need to control pan-tilt-zoom cameras remotely via the API so that I can adjust camera angles to investigate incidents or track movement.
|
||||
|
||||
@@ -51,14 +119,14 @@ As a security operator, I need to control pan-tilt-zoom cameras remotely via the
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated operator with PTZ permissions, **When** they send a pan-left command to camera 3, **Then** the camera begins moving left within 500ms and they receive confirmation
|
||||
1. **Given** an authenticated operator with PTZ permissions, **When** they send a pan-left command to camera 101038, **Then** the camera begins moving left within 500ms and they receive confirmation
|
||||
2. **Given** a camera that doesn't support PTZ, **When** a user attempts PTZ control, **Then** they receive a clear error indicating PTZ is not available for this camera
|
||||
3. **Given** two operators controlling the same PTZ camera, **When** they send conflicting commands simultaneously, **Then** the system queues commands and notifies operators of the conflict
|
||||
4. **Given** a PTZ command in progress, **When** the user sends a stop command, **Then** the camera movement stops immediately
|
||||
|
||||
---
|
||||
|
||||
### User Story 4 - Real-time Event Notifications (Priority: P1)
|
||||
### User Story 6 - Real-time Event Notifications (Priority: P1)
|
||||
|
||||
As a security operator, I need to receive instant notifications when surveillance events occur (motion detection, alarms, sensor triggers) so that I can respond quickly to security incidents.
|
||||
|
||||
@@ -68,14 +136,48 @@ As a security operator, I need to receive instant notifications when surveillanc
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated user with event subscription permissions, **When** they connect to the WebSocket endpoint `/api/v1/events/stream`, **Then** they receive a connection confirmation and can subscribe to specific event types
|
||||
2. **Given** a motion detection event occurs on camera 7, **When** a subscribed user is listening for video analytics events, **Then** they receive a notification within 100ms containing event type, camera channel, timestamp, and relevant data
|
||||
3. **Given** a network disconnection, **When** the WebSocket reconnects, **Then** the user automatically re-subscribes to their previous event types and receives any missed critical events
|
||||
4. **Given** 1000+ concurrent WebSocket connections, **When** an event occurs, **Then** all subscribed users receive notifications without system degradation
|
||||
1. **Given** an authenticated user with event subscription permissions, **When** they connect to `/api/v1/events/stream`, **Then** they receive a connection confirmation and can subscribe to specific event types
|
||||
2. **Given** a motion detection event occurs on camera 101038, **When** a subscribed user is listening for video analytics events, **Then** they receive a notification within 100ms containing event type, camera ID, GeViScope instance, timestamp, and relevant data
|
||||
3. **Given** a network disconnection, **When** the WebSocket reconnects, **Then** the user automatically re-subscribes and receives any missed critical events
|
||||
4. **Given** events from multiple GeViScope instances, **When** subscribed users receive notifications, **Then** each event clearly indicates which instance it originated from
|
||||
|
||||
---
|
||||
|
||||
### User Story 5 - Recording Management (Priority: P2)
|
||||
### User Story 7 - GeViSoft Alarm Management (Priority: P2)
|
||||
|
||||
As a security administrator, I need to configure and manage alarms in GeViSoft so that I can automate responses to security events across multiple GeViScope instances.
|
||||
|
||||
**Why this priority**: Important for advanced automation but basic video operations must work first. Alarms coordinate actions across the system.
|
||||
|
||||
**Independent Test**: Can be fully tested by creating an alarm configuration, triggering the alarm via an event, and verifying that configured actions (CrossSwitch, notifications) execute correctly.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated administrator, **When** they create an alarm with start/stop/acknowledge actions, **Then** the alarm is saved in GeViSoft and can be triggered by configured events
|
||||
2. **Given** an alarm configured to route cameras 101038 and 101039 to monitors 1-2, **When** the alarm triggers, **Then** CrossSwitch actions execute and cameras appear on designated monitors
|
||||
3. **Given** an active alarm, **When** an operator acknowledges it via `/api/v1/gevisoft/alarms/{alarm_id}/acknowledge`, **Then** acknowledge actions execute and alarm state updates
|
||||
4. **Given** multiple GeViScope instances, **When** an alarm spans instances (e.g., camera from instance A to monitor in instance B), **Then** the API coordinates cross-instance operations
|
||||
|
||||
---
|
||||
|
||||
### User Story 8 - Monitor and Viewer Management (Priority: P2)
|
||||
|
||||
As a system administrator, I need to query and manage video output monitors so that I can understand system topology and configure video routing.
|
||||
|
||||
**Why this priority**: Enhances system visibility and configuration but video operations can work without detailed monitor management initially.
|
||||
|
||||
**Independent Test**: Can be fully tested by querying monitor lists, checking monitor status, and understanding which cameras are currently routed to which monitors.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** 256 monitors configured in a GeViScope instance, **When** an administrator queries `/api/v1/geviscope/main/monitors`, **Then** they receive a list of all monitors with IDs, names, status, and current camera assignments
|
||||
2. **Given** a monitor displaying video, **When** queried for current assignment, **Then** the API returns which camera is currently routed to that monitor
|
||||
3. **Given** multiple GeViScope instances, **When** listing monitors, **Then** each instance's monitors are clearly identified by instance ID
|
||||
4. **Given** GSCView viewers connected to monitors, **When** administrators query viewer status, **Then** they can see which viewers are active and what they're displaying
|
||||
|
||||
---
|
||||
|
||||
### User Story 9 - Recording Management (Priority: P2)
|
||||
|
||||
As a security administrator, I need to manage video recording settings and query recorded footage so that I can configure retention policies and retrieve historical video for investigations.
|
||||
|
||||
@@ -85,14 +187,14 @@ As a security administrator, I need to manage video recording settings and query
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated administrator, **When** they request recording start on camera 2, **Then** the camera begins recording and they receive confirmation with recording ID
|
||||
2. **Given** a time range query for 2025-11-12 14:00 to 16:00 on camera 5, **When** an investigator searches for recordings, **Then** they receive a list of available recording segments with download URLs
|
||||
1. **Given** an authenticated administrator, **When** they request recording start on camera 101038, **Then** the camera begins recording and they receive confirmation with recording ID
|
||||
2. **Given** a time range query for 2025-11-12 14:00 to 16:00 on camera 101038, **When** an investigator searches for recordings, **Then** they receive a list of available recording segments with playback URLs
|
||||
3. **Given** the ring buffer is at 90% capacity, **When** an administrator checks recording capacity, **Then** they receive an alert indicating low storage and oldest recordings that will be overwritten
|
||||
4. **Given** scheduled recording configured for nighttime hours, **When** the schedule time arrives, **Then** recording automatically starts and stops according to the schedule
|
||||
|
||||
---
|
||||
|
||||
### User Story 6 - Video Analytics Configuration (Priority: P2)
|
||||
### User Story 10 - Video Analytics Configuration (Priority: P2)
|
||||
|
||||
As a security administrator, I need to configure video content analysis features (motion detection, object tracking, perimeter protection) so that the system can automatically detect security-relevant events.
|
||||
|
||||
@@ -102,259 +204,282 @@ As a security administrator, I need to configure video content analysis features
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated administrator, **When** they configure motion detection zones on camera 4, **Then** the configuration is saved and motion detection activates within those zones
|
||||
1. **Given** an authenticated administrator, **When** they configure motion detection zones on camera 101038, **Then** the configuration is saved and motion detection activates within those zones
|
||||
2. **Given** motion detection configured with sensitivity level 7, **When** motion occurs in the detection zone, **Then** a motion detection event is generated and sent to event subscribers
|
||||
3. **Given** object tracking enabled on camera 6, **When** a person enters the frame, **Then** the system assigns a tracking ID and sends position updates for the duration they remain visible
|
||||
3. **Given** object tracking enabled on camera 101038, **When** a person enters the frame, **Then** the system assigns a tracking ID and sends position updates for the duration they remain visible
|
||||
4. **Given** multiple analytics enabled on one camera (VMD + OBTRACK), **When** events occur, **Then** all configured analytics generate appropriate events without interfering with each other
|
||||
|
||||
---
|
||||
|
||||
### User Story 7 - Multi-Camera Management (Priority: P2)
|
||||
### User Story 11 - Action Mapping and Automation (Priority: P3)
|
||||
|
||||
As a security operator, I need to view and manage multiple cameras simultaneously via the API so that I can coordinate surveillance across different locations and camera views.
|
||||
As a security administrator, I need to configure action mappings in GeViSoft so that specific events automatically trigger corresponding actions across the system.
|
||||
|
||||
**Why this priority**: Enhances operational efficiency but single-camera operations must work first. Important for professional surveillance operations managing multiple sites.
|
||||
**Why this priority**: Valuable for automation but requires basic event and action functionality to be working first.
|
||||
|
||||
**Independent Test**: Can be fully tested by retrieving a list of all available cameras, requesting multiple streams simultaneously, and grouping cameras by location, delivering multi-camera coordination.
|
||||
**Independent Test**: Can be fully tested by creating an action mapping (e.g., motion detected → CrossSwitch), triggering the input action, and verifying the mapped actions execute.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated user, **When** they request the camera list from `/api/v1/cameras`, **Then** they receive all cameras they have permission to view with status, channel ID, capabilities, and location metadata
|
||||
2. **Given** multiple cameras in the same location, **When** a user requests grouped camera data, **Then** cameras are organized by configured location/zone for easy navigation
|
||||
3. **Given** a user viewing 16 camera streams, **When** they request streams via the API, **Then** all 16 streams initialize and display without individual stream degradation
|
||||
4. **Given** a camera goes offline while being viewed, **When** the API detects the disconnection, **Then** the camera status updates and subscribers receive a notification
|
||||
1. **Given** an action mapping configured (InputContact closed → CrossSwitch cameras to monitors), **When** the input contact event occurs, **Then** the mapped CrossSwitch actions execute automatically
|
||||
2. **Given** multiple output actions mapped to one input, **When** the input event triggers, **Then** all output actions execute in sequence
|
||||
3. **Given** action mappings spanning GeViScope instances, **When** triggered, **Then** the API coordinates actions across instances correctly
|
||||
4. **Given** an action mapping fails (e.g., target camera offline), **When** execution occurs, **Then** errors are logged and administrators are notified without blocking other actions
|
||||
|
||||
---
|
||||
|
||||
### User Story 8 - License Plate Recognition Integration (Priority: P3)
|
||||
### User Story 12 - GeViSoft Configuration Management (Priority: P1) ✅ IMPLEMENTED
|
||||
|
||||
As a security operator monitoring vehicle access, I need to receive automatic license plate recognition events so that I can track vehicle entry/exit and match against watchlists.
|
||||
As a system administrator, I need to manage GeViSoft configuration (G-Core servers, action mappings) via the API so that I can programmatically configure and maintain the surveillance system without manual GeViSet operations.
|
||||
|
||||
**Why this priority**: Valuable for specific use cases (parking, access control) but not universal. Only relevant if NPR hardware is available and configured.
|
||||
**Why this priority**: Configuration management is essential for automation, infrastructure-as-code, and maintaining consistent configurations across environments.
|
||||
|
||||
**Independent Test**: Can be fully tested by configuring NPR zones, driving a test vehicle through the zone, and verifying plate recognition events with captured plate numbers, delivering automated vehicle tracking.
|
||||
**Independent Test**: Can be fully tested by creating/reading/updating/deleting servers and action mappings, verifying changes persist in GeViSoft, and confirming no data loss occurs.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** NPR configured on camera 9 with recognition zone defined, **When** a vehicle with readable plate enters the zone, **Then** an NPR event is generated containing plate number, country code, timestamp, confidence score, and image snapshot
|
||||
2. **Given** a watchlist of plates configured, **When** a matching plate is recognized, **Then** a high-priority alert is sent to subscribers with match details
|
||||
3. **Given** poor lighting or plate obstruction, **When** recognition fails or confidence is low (<70%), **Then** the event includes the best-guess plate and confidence level so operators can manually verify
|
||||
4. **Given** continuous vehicle traffic, **When** multiple vehicles pass through rapidly, **Then** each vehicle generates a separate NPR event with unique tracking ID
|
||||
1. **Given** an authenticated administrator, **When** they create a new G-Core server via `POST /api/v1/configuration/servers`, **Then** the server is added to GeViSoft configuration with correct bool types and appears in GeViSet
|
||||
2. **Given** existing servers in configuration, **When** an administrator queries `/api/v1/configuration/servers`, **Then** they receive a list of all servers with IDs, aliases, hosts, and connection settings
|
||||
3. **Given** multiple action mappings to delete, **When** deletion occurs in reverse order (highest ID first), **Then** only intended mappings are deleted without cascade deletion
|
||||
4. **Given** a server ID auto-increment requirement, **When** creating servers, **Then** the system automatically assigns the next available numeric ID based on existing servers
|
||||
|
||||
**Implementation Status** (2025-12-16):
|
||||
- ✅ Server CRUD: CREATE, READ, DELETE working; UPDATE has known bug
|
||||
- ✅ Action Mapping CRUD: CREATE, READ, UPDATE, DELETE all working
|
||||
- ✅ Critical Fix: Cascade deletion bug fixed (delete in reverse order)
|
||||
- ✅ Configuration tree navigation and parsing
|
||||
- ✅ SetupClient integration for configuration download/upload
|
||||
- ✅ Bool type handling for server fields (Enabled, DeactivateEcho, DeactivateLiveCheck)
|
||||
- ⚠️ Known Issue: Server UpdateServer method requires bug fix for "Server ID is required" error
|
||||
|
||||
**Documentation**:
|
||||
- SERVER_CRUD_IMPLEMENTATION.md
|
||||
- CRITICAL_BUG_FIX_DELETE.md
|
||||
|
||||
---
|
||||
|
||||
### User Story 9 - Video Export and Backup (Priority: P3)
|
||||
|
||||
As a security investigator, I need to export specific video segments for evidence or sharing so that I can provide footage to law enforcement or use in incident reports.
|
||||
|
||||
**Why this priority**: Useful for investigations but not needed for live monitoring or basic recording. Can be added as an enhancement after core features are stable.
|
||||
|
||||
**Independent Test**: Can be fully tested by requesting export of a 10-minute segment from camera 3, receiving a download URL, and verifying the exported file plays correctly, delivering evidence export capability.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** an authenticated investigator, **When** they request export of camera 8 footage from 10:00-10:15 on 2025-11-12, **Then** they receive an export job ID and can poll for completion status
|
||||
2. **Given** an export job in progress, **When** the investigator checks job status, **Then** they receive progress percentage and estimated completion time
|
||||
3. **Given** a completed export, **When** the investigator downloads the file, **Then** they receive a standard video format (MP4/AVI) playable in common media players with embedded timestamps
|
||||
4. **Given** an export request for a time range with no recordings, **When** processing occurs, **Then** the user receives a clear message indicating no footage available for that timeframe
|
||||
|
||||
---
|
||||
|
||||
### User Story 10 - System Health Monitoring (Priority: P3)
|
||||
### User Story 13 - System Health Monitoring (Priority: P3)
|
||||
|
||||
As a system administrator, I need to monitor API and surveillance system health status so that I can proactively identify and resolve issues before they impact operations.
|
||||
|
||||
**Why this priority**: Important for production systems but not required for initial deployment. Health monitoring is an operational enhancement that can be added incrementally.
|
||||
|
||||
**Independent Test**: Can be fully tested by querying the health endpoint, checking SDK connectivity status, and verifying alerts when components fail, delivering system observability.
|
||||
**Independent Test**: Can be fully tested by querying the health endpoint, checking SDK connectivity status for all instances, and verifying alerts when components fail.
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** the API is running, **When** an unauthenticated user requests `/api/v1/health`, **Then** they receive system status including API uptime, SDK connectivity, database status, and overall health score
|
||||
2. **Given** the GeViScope SDK connection fails, **When** health is checked, **Then** the health endpoint returns degraded status with specific SDK error details
|
||||
1. **Given** the API is running, **When** an unauthenticated user requests `/api/v1/health`, **Then** they receive system status including API uptime, GeViSoft connectivity, all GeViScope instance statuses, and overall health score
|
||||
2. **Given** one GeViScope instance fails, **When** health is checked, **Then** the health endpoint returns degraded status with specific instance error details while other instances show healthy
|
||||
3. **Given** disk space for recordings drops below 10%, **When** monitoring checks run, **Then** a warning is included in health status and administrators receive notification
|
||||
4. **Given** an administrator monitoring performance, **When** they request detailed metrics, **Then** they receive statistics on request throughput, average response times, active WebSocket connections, and concurrent streams
|
||||
4. **Given** an administrator monitoring performance, **When** they request detailed metrics, **Then** they receive statistics on request throughput, active streams per instance, and connection status for all instances
|
||||
|
||||
---
|
||||
|
||||
### Edge Cases
|
||||
|
||||
- What happens when a camera is physically disconnected while being actively viewed by 20 users?
|
||||
- How does the system handle authentication when the GeViScope SDK is temporarily unavailable?
|
||||
- What occurs when a user requests PTZ control on a camera that another user is already controlling?
|
||||
- How does recording behave when the ring buffer reaches capacity during an active alarm event?
|
||||
- What happens when network latency causes event notifications to queue up - does the system batch or drop old events?
|
||||
- How does the API respond when a user has permission for 50 cameras but only 30 are currently online?
|
||||
- What occurs when a WebSocket connection drops mid-event notification?
|
||||
- How does the system handle time zone differences between the API server, GeViScope SDK, and client applications?
|
||||
- What happens when an export request spans a time range that crosses a recording gap (camera was off)?
|
||||
- How does analytics configuration respond when applied to a camera that doesn't support the requested analytics type (e.g., NPR on a camera without NPR hardware)?
|
||||
- What happens when a GeViScope instance disconnects while operators are viewing cameras from that instance?
|
||||
- How does CrossSwitch behave when routing a camera from one GeViScope instance to a monitor on a different instance (if supported)?
|
||||
- What occurs when GeViSoft connection fails but GeViScope instances remain online?
|
||||
- How does the API handle monitor IDs that overlap across different GeViScope instances?
|
||||
- What happens when a GSCView viewer is configured to display a monitor that has no active camera route?
|
||||
- How does the system respond when CrossSwitch commands execute successfully at the server but no viewer is displaying the monitor?
|
||||
- What occurs when an alarm in GeViSoft references cameras or monitors from a GeViScope instance that is offline?
|
||||
- How does the API handle time synchronization issues between GeViSoft, multiple GeViScope instances, and the API server?
|
||||
- What happens when monitor enumeration returns different results than expected (e.g., 256 monitors vs 16 actual video outputs)?
|
||||
- How does the system handle authentication when GeViSoft credentials differ from GeViScope credentials?
|
||||
|
||||
## Requirements *(mandatory)*
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
- **FR-001**: System MUST authenticate all API requests using JWT tokens with configurable expiration (default 1 hour for access tokens, 7 days for refresh tokens)
|
||||
- **FR-002**: System MUST implement role-based access control with at least three roles: viewer (read-only camera access), operator (camera control + viewing), administrator (full system configuration)
|
||||
- **FR-003**: System MUST provide granular permissions allowing access restriction per camera channel
|
||||
- **FR-004**: System MUST expose live video streams for all configured GeViScope channels with initialization time under 2 seconds
|
||||
- **FR-005**: System MUST support PTZ control operations (pan, tilt, zoom, preset positions) with command response time under 500ms
|
||||
- **FR-006**: System MUST provide WebSocket endpoint for real-time event notifications with delivery latency under 100ms
|
||||
- **FR-007**: System MUST support event subscriptions by type (alarms, analytics, system events) and by camera channel
|
||||
- **FR-008**: System MUST translate all GeViScope SDK actions to RESTful API endpoints following the pattern `/api/v1/{resource}/{id}/{action}`
|
||||
- **FR-009**: System MUST handle concurrent video stream requests from minimum 100 simultaneous users without degradation
|
||||
- **FR-010**: System MUST support WebSocket connections from minimum 1000 concurrent clients for event notifications
|
||||
- **FR-011**: System MUST provide recording management including start/stop recording, schedule configuration, and recording status queries
|
||||
- **FR-012**: System MUST expose recording capacity metrics including total capacity, free space, recording depth in hours, and oldest recording timestamp
|
||||
- **FR-013**: System MUST support video analytics configuration for VMD (Video Motion Detection), OBTRACK (object tracking and people counting), NPR (license plate recognition), and G-Tect (perimeter protection) where hardware supports these features
|
||||
- **FR-014**: System MUST provide query capabilities for recorded footage by channel, time range, and event association
|
||||
- **FR-015**: System MUST export video segments in standard formats (MP4 or AVI) with embedded timestamps and metadata
|
||||
- **FR-016**: System MUST log all authentication attempts (successful and failed) with username, source IP, and timestamp
|
||||
- **FR-017**: System MUST audit log all privileged operations including PTZ control, recording management, configuration changes, and user management with operator ID, action, target, and timestamp
|
||||
- **FR-018**: System MUST gracefully handle camera offline scenarios by returning appropriate error codes and status information
|
||||
- **FR-019**: System MUST implement retry logic for transient SDK communication failures (3 attempts with exponential backoff)
|
||||
- **FR-020**: System MUST provide health check endpoint returning API status, SDK connectivity, database availability, and system resource usage
|
||||
- **FR-021**: System MUST serve auto-generated OpenAPI/Swagger documentation at `/docs` endpoint
|
||||
- **FR-022**: System MUST return meaningful error messages with error codes for all failure scenarios without exposing internal stack traces
|
||||
- **FR-023**: System MUST support API versioning in URL path (v1, v2) to allow backward-compatible evolution
|
||||
- **FR-024**: System MUST rate limit authentication attempts to prevent brute force attacks (max 5 attempts per IP per minute)
|
||||
- **FR-025**: System MUST enforce TLS 1.2+ for all API communication in production environments
|
||||
- **FR-026**: System MUST translate Windows error codes from GeViScope SDK to appropriate HTTP status codes with user-friendly messages
|
||||
- **FR-027**: System MUST support filtering and pagination for endpoints returning lists (camera lists, recording lists, event histories)
|
||||
- **FR-028**: System MUST handle GeViScope SDK ring buffer architecture by exposing recording depth and capacity warnings when storage approaches limits
|
||||
- **FR-029**: System MUST support event correlation using ForeignKey parameter to link events with external system identifiers
|
||||
- **FR-030**: System MUST allow configuration of pre-alarm and post-alarm recording duration for event-triggered recordings
|
||||
**Architecture & Multi-Instance:**
|
||||
- **FR-001**: System MUST support connecting to one GeViSoft instance (GeViServer) for management operations
|
||||
- **FR-002**: System MUST support connecting to multiple GeViScope instances (GSCServer) with configurable instance IDs, hostnames, and credentials
|
||||
- **FR-003**: System MUST provide instance discovery endpoint listing all configured GeViScope instances with connection status
|
||||
- **FR-004**: System MUST support default instance configuration for convenience endpoints without instance ID
|
||||
- **FR-005**: System MUST clearly identify which GeViScope instance each resource (camera, monitor, event) belongs to
|
||||
|
||||
**Authentication & Authorization:**
|
||||
- **FR-006**: System MUST authenticate all API requests using JWT tokens with configurable expiration (default 1 hour for access, 7 days for refresh)
|
||||
- **FR-007**: System MUST implement role-based access control with roles: viewer (read-only), operator (control), administrator (full configuration)
|
||||
- **FR-008**: System MUST provide granular permissions allowing access restriction per camera, monitor, and GeViScope instance
|
||||
- **FR-009**: System MUST audit log all authentication attempts and privileged operations
|
||||
|
||||
**CrossSwitch & Monitor Management:**
|
||||
- **FR-010**: System MUST provide CrossSwitch endpoint to route cameras to monitors: `POST /api/v1/crossswitch` and instance-specific variant
|
||||
- **FR-011**: System MUST track active CrossSwitch routes in database with camera ID, monitor ID, mode, timestamp, and user
|
||||
- **FR-012**: System MUST provide endpoint to clear monitor assignments: `DELETE /api/v1/crossswitch/{monitor_id}`
|
||||
- **FR-013**: System MUST provide routing status endpoint showing all active camera→monitor routes
|
||||
- **FR-014**: System MUST use typed SDK actions (GeViAct_CrossSwitch) instead of string-based commands for reliable execution
|
||||
- **FR-015**: System MUST enumerate and expose all video output monitors with IDs, names, status, and current assignments
|
||||
- **FR-016**: System MUST support monitor grouping and bulk operations on monitor groups
|
||||
|
||||
**Video Operations:**
|
||||
- **FR-017**: System MUST expose live video streams for all cameras with initialization time under 2 seconds
|
||||
- **FR-018**: System MUST support PTZ control operations with command response time under 500ms
|
||||
- **FR-019**: System MUST handle concurrent video stream requests from minimum 100 simultaneous users
|
||||
- **FR-020**: System MUST gracefully handle camera offline scenarios with appropriate error codes
|
||||
|
||||
**Event Management:**
|
||||
- **FR-021**: System MUST provide WebSocket endpoint for real-time event notifications with delivery latency under 100ms
|
||||
- **FR-022**: System MUST support event subscriptions by type, camera, and GeViScope instance
|
||||
- **FR-023**: System MUST handle events from multiple GeViScope instances with clear instance identification
|
||||
- **FR-024**: System MUST support WebSocket connections from minimum 1000 concurrent clients
|
||||
|
||||
**GeViSoft Integration:**
|
||||
- **FR-025**: System MUST provide alarm management endpoints for GeViSoft alarm configuration and triggering
|
||||
- **FR-026**: System MUST support action mapping configuration and execution
|
||||
- **FR-027**: System MUST coordinate cross-instance operations when alarms or actions span multiple GeViScope instances
|
||||
- **FR-028**: System MUST provide endpoints for querying and managing GeViSoft system configuration
|
||||
|
||||
**Configuration Management:** ✅ IMPLEMENTED (2025-12-16)
|
||||
- **FR-039**: System MUST provide CRUD operations for G-Core server management with proper bool type handling
|
||||
- **FR-040**: System MUST provide CRUD operations for action mapping management
|
||||
- **FR-041**: System MUST delete multiple action mappings in reverse order (highest ID first) to prevent cascade deletion
|
||||
- **FR-042**: System MUST auto-increment server IDs based on highest existing numeric ID
|
||||
- **FR-043**: System MUST persist configuration changes to GeViSoft and verify changes are visible in GeViSet
|
||||
- **FR-044**: System MUST parse and navigate GeViSoft configuration tree structure (.set file format)
|
||||
- **FR-045**: System MUST use SetupClient for reliable configuration download/upload operations
|
||||
|
||||
**Recording & Analytics:**
|
||||
- **FR-029**: System MUST provide recording management including start/stop, queries, and capacity metrics
|
||||
- **FR-030**: System MUST support video analytics configuration (VMD, OBTRACK, NPR, G-Tect) where hardware supports
|
||||
- **FR-031**: System MUST provide query capabilities for recorded footage by channel, time range, and event association
|
||||
- **FR-032**: System MUST export video segments in standard formats (MP4/AVI) with metadata
|
||||
|
||||
**System Management:**
|
||||
- **FR-033**: System MUST provide health check endpoint returning status for GeViSoft, all GeViScope instances, database, and SDK bridges
|
||||
- **FR-034**: System MUST implement retry logic for transient SDK communication failures (3 attempts with exponential backoff)
|
||||
- **FR-035**: System MUST serve auto-generated OpenAPI/Swagger documentation at `/docs`
|
||||
- **FR-036**: System MUST support API versioning in URL path (v1, v2) for backward compatibility
|
||||
- **FR-037**: System MUST rate limit authentication attempts (max 5/minute per IP)
|
||||
- **FR-038**: System MUST enforce TLS 1.2+ for all API communication in production
|
||||
|
||||
### Key Entities
|
||||
|
||||
- **Camera**: Represents a video input channel with properties including channel ID, name, location, capabilities (PTZ support, analytics support), current status (online/offline/recording), stream URL, and permissions
|
||||
- **User**: Authentication entity with username, hashed password, assigned role, permissions list, JWT tokens, and audit trail of actions
|
||||
- **Event**: Surveillance occurrence with type ID (motion, alarm, analytics), event ID (instance), channel, timestamp, severity, associated data (e.g., NPR plate number, object tracking ID), and foreign key for external correlation
|
||||
- **Recording**: Video footage segment with channel, start time, end time, file size, recording trigger (scheduled, event, manual), and retention policy
|
||||
- **Stream**: Active video stream session with channel, user, start time, format, quality level, and connection status
|
||||
- **Analytics Configuration**: Video content analysis settings with type (VMD, NPR, OBTRACK, G-Tect, CPA), channel, enabled zones/regions, sensitivity parameters, and alert thresholds
|
||||
- **PTZ Preset**: Saved camera position with preset ID, channel, name, pan/tilt/zoom values
|
||||
- **Audit Log Entry**: Security and operations record with timestamp, user, action type, target resource, outcome (success/failure), and detailed parameters
|
||||
- **GeViScope Instance**: Configuration for a GSCServer connection with ID, hostname, credentials, status, camera count, monitor count
|
||||
- **Camera**: Video input channel with ID, global ID, name, GeViScope instance, capabilities, status, stream URL
|
||||
- **Monitor (Video Output)**: Logical display channel with ID, name, GeViScope instance, status, current camera assignment
|
||||
- **CrossSwitch Route**: Video routing record with camera ID, monitor ID, mode, GeViScope instance, created timestamp, created by user, active status
|
||||
- **User**: Authentication entity with username, password hash, role, permissions, JWT tokens, audit trail
|
||||
- **Event**: Surveillance occurrence with type, event ID, camera, GeViScope instance, timestamp, severity, data, foreign key
|
||||
- **Alarm (GeViSoft)**: System-wide alarm with ID, name, priority, monitor group, cameras, trigger actions, active status
|
||||
- **Action Mapping**: Automation rule with input action, output actions, GeViScope instance scope
|
||||
- **Recording**: Video footage segment with camera, GeViScope instance, start/end time, file size, trigger type
|
||||
- **Audit Log Entry**: Security record with timestamp, user, action, target resource, GeViScope instance, outcome
|
||||
|
||||
## Success Criteria *(mandatory)*
|
||||
|
||||
### Measurable Outcomes
|
||||
|
||||
- **SC-001**: Developers can authenticate and make their first successful API call within 10 minutes of reading the quick start documentation
|
||||
- **SC-002**: Security operators can view live video from any authorized camera with video appearing on screen within 2 seconds of request
|
||||
- **SC-003**: PTZ camera movements respond to operator commands within 500ms, providing responsive control for incident investigation
|
||||
- **SC-004**: Real-time event notifications are delivered to subscribed clients within 100ms of event occurrence, enabling rapid incident response
|
||||
- **SC-005**: System supports 100 concurrent video streams without any individual stream experiencing frame drops or quality degradation
|
||||
- **SC-006**: System handles 1000+ concurrent WebSocket connections for event notifications with message delivery rates exceeding 99.9%
|
||||
- **SC-007**: API metadata queries (camera lists, status checks, user info) return results in under 200ms for 95% of requests
|
||||
- **SC-008**: System maintains 99.9% uptime during production operation, measured as availability of the health check endpoint
|
||||
- **SC-009**: Operators can successfully complete all primary surveillance tasks (view cameras, control PTZ, receive alerts, query recordings) without requiring technical support
|
||||
- **SC-010**: API documentation is sufficiently complete that 90% of integration questions can be answered by reading the OpenAPI specification and examples
|
||||
- **SC-011**: Failed authentication attempts are logged and administrators receive alerts for potential security threats within 5 minutes of detection
|
||||
- **SC-012**: Video export requests for segments up to 1 hour complete within 5 minutes and produce files playable in standard media players
|
||||
- **SC-013**: System gracefully handles camera failures, with offline cameras clearly indicated and the API remaining operational for all other cameras
|
||||
- **SC-014**: Recording capacity warnings are provided when storage reaches 80% capacity, allowing administrators to take action before recordings are lost
|
||||
- **SC-015**: During peak load (500 requests/second), the system maintains response time targets with no more than 0.1% of requests timing out or failing
|
||||
- **SC-001**: Developers can authenticate and make their first successful API call within 10 minutes
|
||||
- **SC-002**: Operators can execute CrossSwitch to route cameras to monitors with routes visible in system within 1 second
|
||||
- **SC-003**: Multi-instance operations work correctly with 3+ GeViScope instances configured
|
||||
- **SC-004**: Security operators can view live video from any authorized camera with video appearing within 2 seconds
|
||||
- **SC-005**: PTZ camera movements respond to commands within 500ms
|
||||
- **SC-006**: Real-time event notifications delivered within 100ms across all GeViScope instances
|
||||
- **SC-007**: System supports 100 concurrent video streams across all instances without degradation
|
||||
- **SC-008**: System handles 1000+ concurrent WebSocket connections with 99.9% message delivery
|
||||
- **SC-009**: CrossSwitch routes created via API are visible in GeViAPI Test Client and affect GSCView displays
|
||||
- **SC-010**: API maintains 99.9% uptime with automatic failover if one GeViScope instance fails
|
||||
|
||||
### Business Impact
|
||||
|
||||
- **BI-001**: Custom surveillance applications can be developed and deployed in under 1 week using the API, compared to 4-6 weeks with direct SDK integration
|
||||
- **BI-002**: Reduction in support requests by 60% compared to direct SDK usage, as API abstracts SDK complexity and provides clear error messages
|
||||
- **BI-003**: Enable integration with third-party systems (access control, building management, alarm systems) that previously couldn't interface with GeViScope
|
||||
- **BI-004**: Support mobile and web-based surveillance clients that can't run Windows SDK, expanding platform compatibility
|
||||
- **BI-001**: Custom surveillance applications can be developed in under 1 week using the API
|
||||
- **BI-002**: Support for multiple GeViScope instances enables scalable multi-site deployments
|
||||
- **BI-003**: Unified API reduces integration complexity by 70% compared to separate GeViSoft/GeViScope integrations
|
||||
- **BI-004**: CrossSwitch automation reduces operator workload for video routing by 80%
|
||||
|
||||
## Dependencies *(mandatory)*
|
||||
|
||||
### External Dependencies
|
||||
|
||||
- **GeViScope SDK 7.9.975.68+**: Core surveillance system SDK providing video streams, camera control, and event management
|
||||
- **Windows Server 2016+** or **Windows 10/11**: Required platform for GeViScope SDK operation
|
||||
- **Active Geutebruck Surveillance System**: Physical cameras, recording servers, and network infrastructure must be configured and operational
|
||||
- **GeViScope SDK 7.9.975.68+**: Core SDK for video operations
|
||||
- **GeViSoft SDK 6.0.1.5+**: Management platform SDK
|
||||
- **Windows Server 2016+** or **Windows 10/11**: Required for both SDKs
|
||||
- **Active GeViSoft System**: Configured with GeViScope instances
|
||||
- **Active GeViScope Instances**: One or more GSCServer instances with cameras and monitors
|
||||
|
||||
### Assumptions
|
||||
|
||||
- GeViScope SDK is already installed and configured with cameras connected and functional
|
||||
- Network connectivity exists between API server and GeViScope SDK service
|
||||
- Sufficient storage capacity available for ring buffer recording as configured in GeViScope
|
||||
- Client applications can consume RESTful APIs and WebSocket connections
|
||||
- Authentication credentials for GeViScope SDK are available for API integration
|
||||
- Standard industry retention and performance expectations apply unless otherwise specified by regulations
|
||||
- JWT-based authentication is acceptable for client applications (OAuth2 flow not required initially)
|
||||
- Video streaming will use existing GeViScope streaming protocols (direct URL or stream proxy to be determined during technical planning)
|
||||
- Redis or similar in-memory database available for session management and caching
|
||||
- SSL/TLS certificates can be obtained and configured for production deployment
|
||||
- GeViSoft and GeViScope instances are installed, configured, and operational
|
||||
- Network connectivity exists between API server and all GeViScope/GeViSoft instances
|
||||
- Authentication credentials available for all instances
|
||||
- Sufficient storage for ring buffer recording
|
||||
- CrossSwitch commands execute at server level, viewer applications (GSCView) required for actual video display
|
||||
- Monitor IDs may not be unique across instances (scoped by instance ID in API)
|
||||
|
||||
### Out of Scope
|
||||
|
||||
- Direct camera hardware management (firmware updates, network configuration) - handled by GeViScope
|
||||
- Video storage architecture changes - API uses existing GeViScope ring buffer
|
||||
- Custom video codec development - API uses GeViScope's supported formats
|
||||
- Mobile native SDKs - this specification covers REST API only, client SDKs are separate future work
|
||||
- Video wall display management - API provides data, UI implementation is client responsibility
|
||||
- Bi-directional audio communication - audio monitoring may be included but two-way audio is deferred
|
||||
- Access control system integration - API provides data interfaces but integration logic is external
|
||||
- Custom analytics algorithm development - API configures existing GeViScope analytics, custom algorithms are separate work
|
||||
- Direct camera hardware management (firmware, network config)
|
||||
- GSCView configuration and deployment
|
||||
- Custom video codec development
|
||||
- Mobile native SDKs (REST API only)
|
||||
- Video wall display management UI
|
||||
- Bi-directional audio communication
|
||||
- Custom analytics algorithm development
|
||||
|
||||
## Constraints
|
||||
|
||||
### Technical Constraints
|
||||
|
||||
- API must run on Windows platform due to GeViScope SDK dependency
|
||||
- All video operations must use GeViScope's channel-based architecture (Channel ID parameter required)
|
||||
- Event notifications limited to events supported by GeViScope SDK action system
|
||||
- Recording capabilities bounded by GeViScope SDK's ring buffer architecture
|
||||
- Analytics features only available for cameras with hardware support (cannot enable NPR on camera without NPR hardware)
|
||||
- API must run on Windows platform due to SDK dependencies
|
||||
- All video operations use GeViScope's channel-based architecture
|
||||
- Event notifications limited to SDK-supported events
|
||||
- Recording capabilities bounded by ring buffer architecture
|
||||
- CrossSwitch routes video at server level, does NOT control physical displays (requires viewers)
|
||||
- Monitor enumeration may return more monitors than physically exist (SDK implementation detail)
|
||||
|
||||
### Performance Constraints
|
||||
|
||||
- Maximum concurrent streams limited by GeViScope SDK license and hardware capacity
|
||||
- WebSocket connection limits determined by operating system socket limits and available memory
|
||||
- API response times dependent on GeViScope SDK response characteristics
|
||||
- Video stream initialization time includes SDK processing delay (targeted under 2 seconds total)
|
||||
- Maximum concurrent streams limited by GeViScope SDK licenses and hardware
|
||||
- WebSocket connection limits determined by OS socket limits
|
||||
- Multi-instance operations may have higher latency than single-instance
|
||||
- CrossSwitch execution time depends on SDK response (typically <100ms)
|
||||
|
||||
### Security Constraints
|
||||
|
||||
- All API communication must use TLS 1.2+ in production
|
||||
- JWT tokens must have configurable expiration to balance security and usability
|
||||
- Audit logging must be tamper-evident (append-only, with checksums or write to immutable storage)
|
||||
- Credentials for GeViScope SDK must be stored securely (environment variables, key vault)
|
||||
- JWT tokens must have configurable expiration
|
||||
- Audit logging must be tamper-evident
|
||||
- Credentials for GeViSoft and GeViScope instances must be stored securely
|
||||
|
||||
## Risk Analysis
|
||||
|
||||
### High Impact Risks
|
||||
|
||||
1. **GeViScope SDK Stability**: If SDK crashes or becomes unresponsive, API loses all functionality
|
||||
- *Mitigation*: Implement circuit breaker pattern, health monitoring, automatic SDK reconnection logic
|
||||
1. **Multi-Instance Complexity**: Managing connections to multiple GeViScope instances increases failure modes
|
||||
- *Mitigation*: Circuit breaker per instance, independent health monitoring, graceful degradation
|
||||
|
||||
2. **Performance Under Load**: Concurrent stream limits may be lower than target (100 streams)
|
||||
- *Mitigation*: Load testing early in development, potentially implement stream quality adaptation
|
||||
2. **CrossSwitch Verification**: Confirming routes are active requires viewer applications
|
||||
- *Mitigation*: Document viewer requirements, provide route tracking in database, API-level route verification
|
||||
|
||||
3. **Windows Platform Dependency**: Restricts deployment options and increases operational complexity
|
||||
- *Mitigation*: Document Windows container approach, design SDK bridge for potential future Linux support via proxy
|
||||
3. **GeViSoft/GeViScope Coordination**: Cross-system operations may have complex failure scenarios
|
||||
- *Mitigation*: Transaction-like patterns, compensating actions, clear error reporting
|
||||
|
||||
### Medium Impact Risks
|
||||
|
||||
4. **SDK Version Compatibility**: Future GeViScope SDK updates may break API integration
|
||||
- *Mitigation*: Version testing before SDK upgrades, maintain SDK abstraction layer
|
||||
4. **Instance Configuration Management**: Adding/removing instances requires careful config management
|
||||
- *Mitigation*: Configuration validation, instance health checks, hot-reload support
|
||||
|
||||
5. **WebSocket Scalability**: 1000+ concurrent connections may stress resources
|
||||
- *Mitigation*: Connection pooling, message batching, load testing, potential horizontal scaling
|
||||
5. **SDK Version Compatibility**: Different GeViScope instances may run different SDK versions
|
||||
- *Mitigation*: Version detection, compatibility matrix, graceful feature detection
|
||||
|
||||
6. **Network Latency**: Event notifications and video streams sensitive to network conditions
|
||||
- *Mitigation*: Document network requirements, implement connection quality monitoring
|
||||
|
||||
### Low Impact Risks
|
||||
|
||||
7. **Documentation Drift**: API changes may outpace documentation updates
|
||||
- *Mitigation*: Auto-generated OpenAPI specs from code, documentation review in PR process
|
||||
6. **Monitor ID Confusion**: Monitor IDs overlap across instances
|
||||
- *Mitigation*: Always scope monitors by instance ID in API, clear documentation
|
||||
|
||||
## Notes
|
||||
|
||||
This specification focuses on **WHAT** the API enables users to do and **WHY** it's valuable, avoiding **HOW** it will be implemented. Technical decisions about Python/FastAPI, specific database choices, video streaming protocols, and SDK integration mechanisms will be made during the `/speckit.plan` phase.
|
||||
This updated specification reflects the **unified architecture** supporting both GeViSoft management and multiple GeViScope instances. The API serves as a central control plane for the entire Geutebruck surveillance ecosystem.
|
||||
|
||||
The user stories are prioritized for iterative development:
|
||||
- **P1 stories** (1-4) form the MVP: authentication, live viewing, PTZ control, event notifications
|
||||
- **P2 stories** (5-7) add operational capabilities: recording management, analytics configuration, multi-camera coordination
|
||||
- **P3 stories** (8-10) provide enhancements: specialized analytics (NPR), evidence export, system monitoring
|
||||
**Key Architectural Decisions:**
|
||||
- Single API with two layers: GeViSoft (management) and GeViScope (operations)
|
||||
- Instance-based routing for GeViScope operations
|
||||
- CrossSwitch implemented with typed SDK actions for reliability
|
||||
- Monitor management reflects SDK's video output concept (logical channels, not physical displays)
|
||||
- Database tracks routes and provides audit trail
|
||||
|
||||
Each story is independently testable and delivers standalone value, enabling flexible development sequencing and incremental delivery to users.
|
||||
**Priority Sequencing:**
|
||||
- **P1** (Stories 1-6): MVP with auth, multi-instance, CrossSwitch, live video, PTZ, events
|
||||
- **P2** (Stories 7-10): GeViSoft integration, monitor management, recording, analytics
|
||||
- **P3** (Stories 11-12): Automation, advanced monitoring
|
||||
|
||||
@@ -407,5 +407,31 @@ GET /metrics # Prometheus metrics
|
||||
---
|
||||
|
||||
**Generated**: 2025-12-08
|
||||
**Scope**: Cross-switching MVP with authentication, expandable to GeViSet configuration
|
||||
**Updated**: 2025-12-16 (Configuration Management implemented)
|
||||
**Scope**: Cross-switching MVP with authentication + GeViSet configuration management ✅
|
||||
**Architecture**: Python FastAPI + C# gRPC Bridge + GeViScope SDK
|
||||
|
||||
---
|
||||
|
||||
## UPDATE: Configuration Management (2025-12-16) ✅ COMPLETED
|
||||
|
||||
**Status**: Phase 9 (GeViSet Configuration Management) has been implemented ahead of schedule
|
||||
|
||||
**Implemented Features**:
|
||||
- ✅ G-Core Server CRUD operations (CREATE, READ, DELETE working; UPDATE has known bug)
|
||||
- ✅ Action Mapping CRUD operations (all CRUD operations working)
|
||||
- ✅ SetupClient integration for configuration file operations
|
||||
- ✅ Configuration tree parsing and navigation
|
||||
- ✅ Critical bug fixes (cascade deletion prevention)
|
||||
|
||||
**API Endpoints Added**:
|
||||
- `GET/POST/PUT/DELETE /api/v1/configuration/servers` - G-Core server management
|
||||
- `GET/POST/PUT/DELETE /api/v1/configuration/action-mappings` - Action mapping management
|
||||
|
||||
**Documentation**:
|
||||
- [SERVER_CRUD_IMPLEMENTATION.md](../../SERVER_CRUD_IMPLEMENTATION.md)
|
||||
- [CRITICAL_BUG_FIX_DELETE.md](../../CRITICAL_BUG_FIX_DELETE.md)
|
||||
|
||||
See Phase 9 section below for original planned tasks.
|
||||
|
||||
---
|
||||
|
||||
@@ -459,7 +459,60 @@ This project uses **web application structure**:
|
||||
|
||||
---
|
||||
|
||||
## Phase 13: Polish & Cross-Cutting Concerns
|
||||
## Phase 13: User Story 12 - GeViSoft Configuration Management (Priority: P1) ✅ IMPLEMENTED (2025-12-16)
|
||||
|
||||
**Goal**: Manage GeViSoft configuration (G-Core servers, action mappings) via REST API
|
||||
|
||||
**Implementation Status**: CRUD operations working with critical bug fixes applied
|
||||
|
||||
### Implementation Summary (Completed)
|
||||
|
||||
**REST API Endpoints**:
|
||||
- ✅ `GET /api/v1/configuration/servers` - List all G-Core servers
|
||||
- ✅ `GET /api/v1/configuration/servers/{server_id}` - Get single server
|
||||
- ✅ `POST /api/v1/configuration/servers` - Create new server
|
||||
- ⚠️ `PUT /api/v1/configuration/servers/{server_id}` - Update server (known bug)
|
||||
- ✅ `DELETE /api/v1/configuration/servers/{server_id}` - Delete server
|
||||
- ✅ `GET /api/v1/configuration/action-mappings` - List all action mappings
|
||||
- ✅ `GET /api/v1/configuration/action-mappings/{mapping_id}` - Get single mapping
|
||||
- ✅ `POST /api/v1/configuration/action-mappings` - Create mapping
|
||||
- ✅ `PUT /api/v1/configuration/action-mappings/{mapping_id}` - Update mapping
|
||||
- ✅ `DELETE /api/v1/configuration/action-mappings/{mapping_id}` - Delete mapping
|
||||
|
||||
**gRPC SDK Bridge**:
|
||||
- ✅ ConfigurationService implementation
|
||||
- ✅ SetupClient integration for .set file operations
|
||||
- ✅ FolderTreeParser for binary configuration parsing
|
||||
- ✅ FolderTreeWriter for configuration updates
|
||||
- ✅ CreateServer, UpdateServer, DeleteServer methods
|
||||
- ✅ CreateActionMapping, UpdateActionMapping, DeleteActionMapping methods
|
||||
- ✅ ReadConfigurationTree for querying configuration
|
||||
|
||||
**Critical Fixes**:
|
||||
- ✅ **Cascade Deletion Bug**: Fixed deletion order issue (delete in reverse order)
|
||||
- ✅ **Bool Type Handling**: Proper bool type usage for GeViSet compatibility
|
||||
- ✅ **Auto-increment Server IDs**: Find highest numeric ID and increment
|
||||
|
||||
**Test Scripts**:
|
||||
- ✅ `comprehensive_crud_test.py` - Full CRUD verification
|
||||
- ✅ `safe_delete_test.py` - Cascade deletion fix verification
|
||||
- ✅ `server_manager.py` - Production server management
|
||||
- ✅ `cleanup_to_base.py` - Configuration reset utility
|
||||
- ✅ `verify_config_via_grpc.py` - Configuration verification
|
||||
|
||||
**Documentation**:
|
||||
- ✅ `SERVER_CRUD_IMPLEMENTATION.md` - Complete implementation guide
|
||||
- ✅ `CRITICAL_BUG_FIX_DELETE.md` - Bug analysis and fix documentation
|
||||
- ✅ Updated spec.md with User Story 12 and functional requirements
|
||||
|
||||
**Known Issues**:
|
||||
- ⚠️ Server UPDATE method has "Server ID is required" bug (workaround: delete and recreate)
|
||||
|
||||
**Checkpoint**: Configuration management complete - can manage G-Core servers and action mappings via API
|
||||
|
||||
---
|
||||
|
||||
## Phase 14: Polish & Cross-Cutting Concerns
|
||||
|
||||
**Purpose**: Improvements that affect multiple user stories
|
||||
|
||||
@@ -535,6 +588,7 @@ Phase 13: Polish
|
||||
- **US8 (NPR Integration)**: Depends on US4, US6 completion
|
||||
- **US9 (Video Export)**: Depends on US5 completion
|
||||
- **US10 (Health Monitoring)**: Can start after Foundational
|
||||
- **US12 (Configuration Management)**: ✅ COMPLETED - Depends on Foundational only
|
||||
|
||||
### Parallel Opportunities
|
||||
|
||||
@@ -552,13 +606,13 @@ Phase 13: Polish
|
||||
- [Similar pattern for all user stories]
|
||||
|
||||
**Across User Stories** (if team capacity allows):
|
||||
- After Foundational completes: US1 can start
|
||||
- After Foundational completes: US1, US10, US12 can start in parallel
|
||||
- After US1 completes: US2, US5 can start in parallel
|
||||
- After US2 completes: US3, US4, US7 can start in parallel
|
||||
- After US4 completes: US6 can start
|
||||
- After US5 completes: US9 can start
|
||||
- After US6 completes: US8 can start
|
||||
- US10 can start any time after Foundational
|
||||
- US12 ✅ COMPLETED (Configuration Management)
|
||||
|
||||
**Polish Phase**: T198-T212, T214-T215 all marked [P] can run in parallel
|
||||
|
||||
@@ -683,9 +737,11 @@ With 3 developers after Foundational phase completes:
|
||||
- Phase 10 (US8 - NPR Integration): 12 tasks
|
||||
- Phase 11 (US9 - Video Export): 14 tasks
|
||||
- Phase 12 (US10 - Health Monitoring): 14 tasks
|
||||
- Phase 13 (Polish): 18 tasks
|
||||
- Phase 13 (US12 - Configuration Management): ✅ COMPLETED (2025-12-16)
|
||||
- Phase 14 (Polish): 18 tasks
|
||||
|
||||
**MVP Tasks** (Phases 1-6): 112 tasks
|
||||
**Configuration Management**: ✅ Implemented separately (not part of original task breakdown)
|
||||
|
||||
**Tests**: 80+ test tasks (all marked TDD - write first, ensure FAIL)
|
||||
|
||||
@@ -711,4 +767,5 @@ With 3 developers after Foundational phase completes:
|
||||
---
|
||||
|
||||
**Generated**: 2025-12-08
|
||||
**Based on**: spec.md (10 user stories), plan.md (tech stack), data-model.md (7 entities), contracts/openapi.yaml (17 endpoints)
|
||||
**Updated**: 2025-12-16 (Configuration Management implemented)
|
||||
**Based on**: spec.md (12 user stories), plan.md (tech stack), data-model.md (8 entities), contracts/openapi.yaml (27+ endpoints)
|
||||
|
||||
@@ -6,10 +6,12 @@ from typing import Optional, List
|
||||
import structlog
|
||||
from config import settings
|
||||
|
||||
# TODO: Import generated protobuf classes after running protoc
|
||||
# from protos import camera_pb2, camera_pb2_grpc
|
||||
# from protos import monitor_pb2, monitor_pb2_grpc
|
||||
# from protos import crossswitch_pb2, crossswitch_pb2_grpc
|
||||
# Import generated protobuf classes
|
||||
from protos import camera_pb2, camera_pb2_grpc
|
||||
from protos import monitor_pb2, monitor_pb2_grpc
|
||||
from protos import crossswitch_pb2, crossswitch_pb2_grpc
|
||||
from protos import action_mapping_pb2, action_mapping_pb2_grpc
|
||||
from protos import configuration_pb2, configuration_pb2_grpc
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
@@ -18,10 +20,11 @@ class SDKBridgeClient:
|
||||
|
||||
def __init__(self):
|
||||
self._channel: Optional[grpc.aio.Channel] = None
|
||||
# TODO: Initialize stubs after protobuf generation
|
||||
# self._camera_stub = None
|
||||
# self._monitor_stub = None
|
||||
# self._crossswitch_stub = None
|
||||
self._camera_stub = None
|
||||
self._monitor_stub = None
|
||||
self._crossswitch_stub = None
|
||||
self._action_mapping_stub = None
|
||||
self._configuration_stub = None
|
||||
|
||||
async def connect(self):
|
||||
"""Initialize gRPC channel to SDK Bridge"""
|
||||
@@ -39,13 +42,12 @@ class SDKBridgeClient:
|
||||
]
|
||||
)
|
||||
|
||||
# TODO: Initialize service stubs after protobuf generation
|
||||
# self._camera_stub = camera_pb2_grpc.CameraServiceStub(self._channel)
|
||||
# self._monitor_stub = monitor_pb2_grpc.MonitorServiceStub(self._channel)
|
||||
# self._crossswitch_stub = crossswitch_pb2_grpc.CrossSwitchServiceStub(self._channel)
|
||||
|
||||
# Test connection with health check
|
||||
# await self.health_check()
|
||||
# Initialize service stubs
|
||||
self._camera_stub = camera_pb2_grpc.CameraServiceStub(self._channel)
|
||||
self._monitor_stub = monitor_pb2_grpc.MonitorServiceStub(self._channel)
|
||||
self._crossswitch_stub = crossswitch_pb2_grpc.CrossSwitchServiceStub(self._channel)
|
||||
self._action_mapping_stub = action_mapping_pb2_grpc.ActionMappingServiceStub(self._channel)
|
||||
self._configuration_stub = configuration_pb2_grpc.ConfigurationServiceStub(self._channel)
|
||||
|
||||
logger.info("sdk_bridge_connected")
|
||||
except Exception as e:
|
||||
@@ -82,21 +84,20 @@ class SDKBridgeClient:
|
||||
"""List all cameras from GeViServer"""
|
||||
try:
|
||||
logger.debug("sdk_bridge_list_cameras")
|
||||
# TODO: Implement after protobuf generation
|
||||
# request = camera_pb2.ListCamerasRequest()
|
||||
# response = await self._camera_stub.ListCameras(request, timeout=10.0)
|
||||
# return [
|
||||
# {
|
||||
# "id": camera.id,
|
||||
# "name": camera.name,
|
||||
# "description": camera.description,
|
||||
# "has_ptz": camera.has_ptz,
|
||||
# "has_video_sensor": camera.has_video_sensor,
|
||||
# "status": camera.status
|
||||
# }
|
||||
# for camera in response.cameras
|
||||
# ]
|
||||
return [] # Placeholder
|
||||
request = camera_pb2.ListCamerasRequest()
|
||||
response = await self._camera_stub.ListCameras(request, timeout=10.0)
|
||||
return [
|
||||
{
|
||||
"id": camera.id,
|
||||
"name": camera.name,
|
||||
"description": camera.description,
|
||||
"has_ptz": camera.has_ptz,
|
||||
"has_video_sensor": camera.has_video_sensor,
|
||||
"status": camera.status,
|
||||
"last_seen": None # TODO: Convert protobuf timestamp to datetime
|
||||
}
|
||||
for camera in response.cameras
|
||||
]
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_list_cameras_failed", error=str(e))
|
||||
raise
|
||||
@@ -127,21 +128,19 @@ class SDKBridgeClient:
|
||||
"""List all monitors from GeViServer"""
|
||||
try:
|
||||
logger.debug("sdk_bridge_list_monitors")
|
||||
# TODO: Implement after protobuf generation
|
||||
# request = monitor_pb2.ListMonitorsRequest()
|
||||
# response = await self._monitor_stub.ListMonitors(request, timeout=10.0)
|
||||
# return [
|
||||
# {
|
||||
# "id": monitor.id,
|
||||
# "name": monitor.name,
|
||||
# "description": monitor.description,
|
||||
# "is_active": monitor.is_active,
|
||||
# "current_camera_id": monitor.current_camera_id,
|
||||
# "status": monitor.status
|
||||
# }
|
||||
# for monitor in response.monitors
|
||||
# ]
|
||||
return [] # Placeholder
|
||||
request = monitor_pb2.ListMonitorsRequest()
|
||||
response = await self._monitor_stub.ListMonitors(request, timeout=10.0)
|
||||
return [
|
||||
{
|
||||
"id": monitor.id,
|
||||
"name": monitor.name,
|
||||
"description": monitor.description,
|
||||
"is_active": monitor.is_active,
|
||||
"current_camera_id": monitor.current_camera_id,
|
||||
"status": monitor.status
|
||||
}
|
||||
for monitor in response.monitors
|
||||
]
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_list_monitors_failed", error=str(e))
|
||||
raise
|
||||
@@ -150,20 +149,18 @@ class SDKBridgeClient:
|
||||
"""Execute cross-switch operation"""
|
||||
try:
|
||||
logger.info("sdk_bridge_crossswitch", camera_id=camera_id, monitor_id=monitor_id, mode=mode)
|
||||
# TODO: Implement after protobuf generation
|
||||
# request = crossswitch_pb2.CrossSwitchRequest(
|
||||
# camera_id=camera_id,
|
||||
# monitor_id=monitor_id,
|
||||
# mode=mode
|
||||
# )
|
||||
# response = await self._crossswitch_stub.ExecuteCrossSwitch(request, timeout=10.0)
|
||||
# return {
|
||||
# "success": response.success,
|
||||
# "message": response.message,
|
||||
# "camera_id": response.camera_id,
|
||||
# "monitor_id": response.monitor_id
|
||||
# }
|
||||
return {"success": True, "message": "Placeholder", "camera_id": camera_id, "monitor_id": monitor_id}
|
||||
request = crossswitch_pb2.CrossSwitchRequest(
|
||||
camera_id=camera_id,
|
||||
monitor_id=monitor_id,
|
||||
mode=mode
|
||||
)
|
||||
response = await self._crossswitch_stub.ExecuteCrossSwitch(request, timeout=10.0)
|
||||
return {
|
||||
"success": response.success,
|
||||
"message": response.message,
|
||||
"camera_id": response.camera_id,
|
||||
"monitor_id": response.monitor_id
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_crossswitch_failed", error=str(e))
|
||||
raise
|
||||
@@ -172,15 +169,13 @@ class SDKBridgeClient:
|
||||
"""Clear monitor (stop video)"""
|
||||
try:
|
||||
logger.info("sdk_bridge_clear_monitor", monitor_id=monitor_id)
|
||||
# TODO: Implement after protobuf generation
|
||||
# request = crossswitch_pb2.ClearMonitorRequest(monitor_id=monitor_id)
|
||||
# response = await self._crossswitch_stub.ClearMonitor(request, timeout=10.0)
|
||||
# return {
|
||||
# "success": response.success,
|
||||
# "message": response.message,
|
||||
# "monitor_id": response.monitor_id
|
||||
# }
|
||||
return {"success": True, "message": "Placeholder", "monitor_id": monitor_id}
|
||||
request = crossswitch_pb2.ClearMonitorRequest(monitor_id=monitor_id)
|
||||
response = await self._crossswitch_stub.ClearMonitor(request, timeout=10.0)
|
||||
return {
|
||||
"success": response.success,
|
||||
"message": response.message,
|
||||
"monitor_id": response.monitor_id
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_clear_monitor_failed", error=str(e))
|
||||
raise
|
||||
@@ -209,6 +204,451 @@ class SDKBridgeClient:
|
||||
logger.error("sdk_bridge_get_routing_state_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def get_action_mappings(self, enabled_only: bool = False) -> dict:
|
||||
"""Get action mappings from GeViServer via SDK Bridge"""
|
||||
try:
|
||||
logger.debug("sdk_bridge_get_action_mappings", enabled_only=enabled_only)
|
||||
request = action_mapping_pb2.GetActionMappingsRequest(enabled_only=enabled_only)
|
||||
response = await self._action_mapping_stub.GetActionMappings(request, timeout=30.0)
|
||||
|
||||
return {
|
||||
"mappings": [
|
||||
{
|
||||
"id": mapping.id,
|
||||
"name": mapping.name,
|
||||
"description": mapping.description,
|
||||
"input_action": mapping.input_action,
|
||||
"output_actions": list(mapping.output_actions),
|
||||
"enabled": mapping.enabled,
|
||||
"execution_count": mapping.execution_count,
|
||||
"last_executed": mapping.last_executed if mapping.last_executed else None,
|
||||
"created_at": mapping.created_at,
|
||||
"updated_at": mapping.updated_at
|
||||
}
|
||||
for mapping in response.mappings
|
||||
],
|
||||
"total_count": response.total_count,
|
||||
"enabled_count": response.enabled_count,
|
||||
"disabled_count": response.disabled_count
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_get_action_mappings_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def read_configuration(self) -> dict:
|
||||
"""Read and parse configuration from GeViServer"""
|
||||
try:
|
||||
logger.debug("sdk_bridge_read_configuration")
|
||||
request = configuration_pb2.ReadConfigurationRequest()
|
||||
response = await self._configuration_stub.ReadConfiguration(request, timeout=30.0)
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"file_size": response.file_size,
|
||||
"header": response.header,
|
||||
"nodes": [
|
||||
{
|
||||
"start_offset": node.start_offset,
|
||||
"end_offset": node.end_offset,
|
||||
"node_type": node.node_type,
|
||||
"name": node.name if node.name else None,
|
||||
"value": node.value if node.value else None,
|
||||
"value_type": node.value_type if node.value_type else None
|
||||
}
|
||||
for node in response.nodes
|
||||
],
|
||||
"statistics": {
|
||||
"total_nodes": response.statistics.total_nodes,
|
||||
"boolean_count": response.statistics.boolean_count,
|
||||
"integer_count": response.statistics.integer_count,
|
||||
"string_count": response.statistics.string_count,
|
||||
"property_count": response.statistics.property_count,
|
||||
"marker_count": response.statistics.marker_count,
|
||||
"rules_section_count": response.statistics.rules_section_count
|
||||
}
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_read_configuration_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def export_configuration_json(self) -> dict:
|
||||
"""Export configuration as JSON"""
|
||||
try:
|
||||
logger.debug("sdk_bridge_export_configuration_json")
|
||||
request = configuration_pb2.ExportJsonRequest()
|
||||
response = await self._configuration_stub.ExportConfigurationJson(request, timeout=30.0)
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"json_data": response.json_data,
|
||||
"json_size": response.json_size
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_export_configuration_json_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def modify_configuration(self, modifications: List[dict]) -> dict:
|
||||
"""Modify configuration and write back to server"""
|
||||
try:
|
||||
logger.info("sdk_bridge_modify_configuration", count=len(modifications))
|
||||
request = configuration_pb2.ModifyConfigurationRequest()
|
||||
|
||||
for mod in modifications:
|
||||
modification = configuration_pb2.NodeModification(
|
||||
start_offset=mod["start_offset"],
|
||||
node_type=mod["node_type"],
|
||||
new_value=mod["new_value"]
|
||||
)
|
||||
request.modifications.append(modification)
|
||||
|
||||
response = await self._configuration_stub.ModifyConfiguration(request, timeout=60.0)
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"modifications_applied": response.modifications_applied
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_modify_configuration_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def import_configuration(self, json_data: str) -> dict:
|
||||
"""Import complete configuration from JSON and write to GeViServer"""
|
||||
try:
|
||||
logger.info("sdk_bridge_import_configuration", json_size=len(json_data))
|
||||
request = configuration_pb2.ImportConfigurationRequest(json_data=json_data)
|
||||
response = await self._configuration_stub.ImportConfiguration(request, timeout=60.0)
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"bytes_written": response.bytes_written,
|
||||
"nodes_imported": response.nodes_imported
|
||||
}
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_import_configuration_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def read_action_mappings(self) -> dict:
|
||||
"""
|
||||
Read ONLY action mappings (Rules markers) from GeViServer
|
||||
Much faster than full configuration export - selective parsing
|
||||
Returns structured format with input_actions and output_actions with parameters
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_read_action_mappings")
|
||||
request = configuration_pb2.ReadActionMappingsRequest()
|
||||
response = await self._configuration_stub.ReadActionMappings(request, timeout=30.0)
|
||||
|
||||
# Convert protobuf response to dict with structured format
|
||||
mappings = []
|
||||
for mapping in response.mappings:
|
||||
# Convert input actions with parameters
|
||||
input_actions = []
|
||||
for action_def in mapping.input_actions:
|
||||
parameters = {}
|
||||
for param in action_def.parameters:
|
||||
parameters[param.name] = param.value
|
||||
|
||||
input_actions.append({
|
||||
"action": action_def.action,
|
||||
"parameters": parameters
|
||||
})
|
||||
|
||||
# Convert output actions with parameters
|
||||
output_actions = []
|
||||
for action_def in mapping.output_actions:
|
||||
parameters = {}
|
||||
for param in action_def.parameters:
|
||||
parameters[param.name] = param.value
|
||||
|
||||
output_actions.append({
|
||||
"action": action_def.action,
|
||||
"parameters": parameters
|
||||
})
|
||||
|
||||
mappings.append({
|
||||
"name": mapping.name,
|
||||
"input_actions": input_actions,
|
||||
"output_actions": output_actions,
|
||||
"start_offset": mapping.start_offset,
|
||||
"end_offset": mapping.end_offset,
|
||||
# Keep old format for backward compatibility
|
||||
"actions": list(mapping.actions)
|
||||
})
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"mappings": mappings,
|
||||
"total_count": response.total_count
|
||||
}
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_read_action_mappings_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def read_specific_markers(self, marker_names: List[str]) -> dict:
|
||||
"""
|
||||
Read specific configuration markers by name
|
||||
Extensible method for reading any configuration type
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_read_specific_markers", markers=marker_names)
|
||||
request = configuration_pb2.ReadSpecificMarkersRequest(marker_names=marker_names)
|
||||
response = await self._configuration_stub.ReadSpecificMarkers(request, timeout=30.0)
|
||||
|
||||
# Convert protobuf response to dict
|
||||
nodes = []
|
||||
for node in response.extracted_nodes:
|
||||
nodes.append({
|
||||
"start_offset": node.start_offset,
|
||||
"end_offset": node.end_offset,
|
||||
"node_type": node.node_type,
|
||||
"name": node.name,
|
||||
"value": node.value,
|
||||
"value_type": node.value_type
|
||||
})
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"file_size": response.file_size,
|
||||
"requested_markers": list(response.requested_markers),
|
||||
"extracted_nodes": nodes,
|
||||
"markers_found": response.markers_found
|
||||
}
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_read_specific_markers_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def create_action_mapping(self, mapping_data: dict) -> dict:
|
||||
"""
|
||||
Create a new action mapping
|
||||
|
||||
Args:
|
||||
mapping_data: Dict with name, input_actions, output_actions
|
||||
|
||||
Returns:
|
||||
Dict with success status and created mapping
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_create_action_mapping", name=mapping_data.get("name"))
|
||||
|
||||
# Build protobuf request
|
||||
mapping_input = configuration_pb2.ActionMappingInput(
|
||||
name=mapping_data.get("name", "")
|
||||
)
|
||||
|
||||
# Add output actions
|
||||
for action_data in mapping_data.get("output_actions", []):
|
||||
action_def = configuration_pb2.ActionDefinition(action=action_data["action"])
|
||||
|
||||
# Add parameters
|
||||
for param_name, param_value in action_data.get("parameters", {}).items():
|
||||
action_def.parameters.add(name=param_name, value=str(param_value))
|
||||
|
||||
mapping_input.output_actions.append(action_def)
|
||||
|
||||
request = configuration_pb2.CreateActionMappingRequest(mapping=mapping_input)
|
||||
response = await self._configuration_stub.CreateActionMapping(request, timeout=60.0)
|
||||
|
||||
# Convert response
|
||||
result = {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"message": response.message
|
||||
}
|
||||
|
||||
if response.mapping:
|
||||
result["mapping"] = {
|
||||
"id": len([]), # ID will be assigned by the system
|
||||
"name": response.mapping.name,
|
||||
"offset": response.mapping.start_offset,
|
||||
"output_actions": []
|
||||
}
|
||||
|
||||
for action_def in response.mapping.output_actions:
|
||||
result["mapping"]["output_actions"].append({
|
||||
"action": action_def.action,
|
||||
"parameters": {p.name: p.value for p in action_def.parameters}
|
||||
})
|
||||
|
||||
return result
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_create_action_mapping_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def update_action_mapping(self, mapping_id: int, mapping_data: dict) -> dict:
|
||||
"""
|
||||
Update an existing action mapping
|
||||
|
||||
Args:
|
||||
mapping_id: 1-based ID of mapping to update
|
||||
mapping_data: Dict with updated fields (name, input_actions, output_actions)
|
||||
|
||||
Returns:
|
||||
Dict with success status and updated mapping
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_update_action_mapping", mapping_id=mapping_id)
|
||||
|
||||
# Build protobuf request
|
||||
mapping_input = configuration_pb2.ActionMappingInput()
|
||||
|
||||
if "name" in mapping_data:
|
||||
mapping_input.name = mapping_data["name"]
|
||||
|
||||
# Add output actions if provided
|
||||
if "output_actions" in mapping_data:
|
||||
for action_data in mapping_data["output_actions"]:
|
||||
action_def = configuration_pb2.ActionDefinition(action=action_data["action"])
|
||||
|
||||
# Add parameters
|
||||
for param_name, param_value in action_data.get("parameters", {}).items():
|
||||
action_def.parameters.add(name=param_name, value=str(param_value))
|
||||
|
||||
mapping_input.output_actions.append(action_def)
|
||||
|
||||
request = configuration_pb2.UpdateActionMappingRequest(
|
||||
mapping_id=mapping_id,
|
||||
mapping=mapping_input
|
||||
)
|
||||
response = await self._configuration_stub.UpdateActionMapping(request, timeout=60.0)
|
||||
|
||||
# Convert response
|
||||
result = {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"message": response.message
|
||||
}
|
||||
|
||||
if response.mapping:
|
||||
result["mapping"] = {
|
||||
"id": mapping_id,
|
||||
"name": response.mapping.name,
|
||||
"offset": response.mapping.start_offset,
|
||||
"output_actions": []
|
||||
}
|
||||
|
||||
for action_def in response.mapping.output_actions:
|
||||
result["mapping"]["output_actions"].append({
|
||||
"action": action_def.action,
|
||||
"parameters": {p.name: p.value for p in action_def.parameters}
|
||||
})
|
||||
|
||||
return result
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_update_action_mapping_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def delete_action_mapping(self, mapping_id: int) -> dict:
|
||||
"""
|
||||
Delete an action mapping by ID
|
||||
|
||||
Args:
|
||||
mapping_id: 1-based ID of mapping to delete
|
||||
|
||||
Returns:
|
||||
Dict with success status and message
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_delete_action_mapping", mapping_id=mapping_id)
|
||||
|
||||
request = configuration_pb2.DeleteActionMappingRequest(mapping_id=mapping_id)
|
||||
response = await self._configuration_stub.DeleteActionMapping(request, timeout=60.0)
|
||||
|
||||
return {
|
||||
"success": response.success,
|
||||
"error_message": response.error_message if response.error_message else None,
|
||||
"message": response.message
|
||||
}
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_delete_action_mapping_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def read_configuration_tree(self) -> dict:
|
||||
"""
|
||||
Read configuration as hierarchical folder tree (RECOMMENDED)
|
||||
|
||||
Returns:
|
||||
Dict with tree structure
|
||||
"""
|
||||
try:
|
||||
logger.info("sdk_bridge_read_configuration_tree")
|
||||
|
||||
request = configuration_pb2.ReadConfigurationTreeRequest()
|
||||
response = await self._configuration_stub.ReadConfigurationTree(request, timeout=30.0)
|
||||
|
||||
if not response.success:
|
||||
return {
|
||||
"success": False,
|
||||
"error_message": response.error_message
|
||||
}
|
||||
|
||||
# Convert protobuf TreeNode to dict
|
||||
def convert_tree_node(node):
|
||||
result = {
|
||||
"type": node.type,
|
||||
"name": node.name
|
||||
}
|
||||
|
||||
# Add value based on type
|
||||
if node.type == "string":
|
||||
result["value"] = node.string_value
|
||||
elif node.type in ("bool", "byte", "int16", "int32", "int64"):
|
||||
result["value"] = node.int_value
|
||||
|
||||
# Add children recursively
|
||||
if node.type == "folder" and len(node.children) > 0:
|
||||
result["children"] = [convert_tree_node(child) for child in node.children]
|
||||
|
||||
return result
|
||||
|
||||
tree_dict = convert_tree_node(response.root) if response.root else None
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"tree": tree_dict,
|
||||
"total_nodes": response.total_nodes
|
||||
}
|
||||
|
||||
except grpc.RpcError as e:
|
||||
logger.error("sdk_bridge_read_configuration_tree_failed", error=str(e))
|
||||
raise
|
||||
|
||||
async def write_configuration_tree(self, tree: dict) -> dict:
|
||||
"""
|
||||
Write modified configuration tree back to GeViServer
|
||||
|
||||
Args:
|
||||
tree: Modified tree structure (dict)
|
||||
|
||||
Returns:
|
||||
Dict with success status and write statistics
|
||||
"""
|
||||
try:
|
||||
import json
|
||||
logger.info("sdk_bridge_write_configuration_tree")
|
||||
|
||||
# Convert tree to JSON string
|
||||
json_data = json.dumps(tree, indent=2)
|
||||
|
||||
# Use import_configuration to write the tree
|
||||
result = await self.import_configuration(json_data)
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("sdk_bridge_write_configuration_tree_failed", error=str(e))
|
||||
raise
|
||||
|
||||
# Global SDK Bridge client instance
|
||||
sdk_bridge_client = SDKBridgeClient()
|
||||
|
||||
|
||||
1
src/api/protos/__init__.py
Normal file
1
src/api/protos/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Generated protobuf modules"""
|
||||
42
src/api/protos/action_mapping.proto
Normal file
42
src/api/protos/action_mapping.proto
Normal file
@@ -0,0 +1,42 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package action_mapping;
|
||||
|
||||
option csharp_namespace = "GeViScopeBridge.Protos";
|
||||
|
||||
service ActionMappingService {
|
||||
rpc GetActionMappings(GetActionMappingsRequest) returns (GetActionMappingsResponse);
|
||||
rpc GetActionMapping(GetActionMappingRequest) returns (ActionMappingResponse);
|
||||
}
|
||||
|
||||
message GetActionMappingsRequest {
|
||||
bool enabled_only = 1;
|
||||
}
|
||||
|
||||
message GetActionMappingRequest {
|
||||
string id = 1;
|
||||
}
|
||||
|
||||
message ActionMapping {
|
||||
string id = 1;
|
||||
string name = 2;
|
||||
string description = 3;
|
||||
string input_action = 4;
|
||||
repeated string output_actions = 5;
|
||||
bool enabled = 6;
|
||||
int32 execution_count = 7;
|
||||
string last_executed = 8; // ISO 8601 datetime string
|
||||
string created_at = 9; // ISO 8601 datetime string
|
||||
string updated_at = 10; // ISO 8601 datetime string
|
||||
}
|
||||
|
||||
message ActionMappingResponse {
|
||||
ActionMapping mapping = 1;
|
||||
}
|
||||
|
||||
message GetActionMappingsResponse {
|
||||
repeated ActionMapping mappings = 1;
|
||||
int32 total_count = 2;
|
||||
int32 enabled_count = 3;
|
||||
int32 disabled_count = 4;
|
||||
}
|
||||
37
src/api/protos/action_mapping_pb2.py
Normal file
37
src/api/protos/action_mapping_pb2.py
Normal file
@@ -0,0 +1,37 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: action_mapping.proto
|
||||
# Protobuf Python Version: 4.25.0
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x61\x63tion_mapping.proto\x12\x0e\x61\x63tion_mapping\"0\n\x18GetActionMappingsRequest\x12\x14\n\x0c\x65nabled_only\x18\x01 \x01(\x08\"%\n\x17GetActionMappingRequest\x12\n\n\x02id\x18\x01 \x01(\t\"\xd5\x01\n\rActionMapping\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x14\n\x0cinput_action\x18\x04 \x01(\t\x12\x16\n\x0eoutput_actions\x18\x05 \x03(\t\x12\x0f\n\x07\x65nabled\x18\x06 \x01(\x08\x12\x17\n\x0f\x65xecution_count\x18\x07 \x01(\x05\x12\x15\n\rlast_executed\x18\x08 \x01(\t\x12\x12\n\ncreated_at\x18\t \x01(\t\x12\x12\n\nupdated_at\x18\n \x01(\t\"G\n\x15\x41\x63tionMappingResponse\x12.\n\x07mapping\x18\x01 \x01(\x0b\x32\x1d.action_mapping.ActionMapping\"\x90\x01\n\x19GetActionMappingsResponse\x12/\n\x08mappings\x18\x01 \x03(\x0b\x32\x1d.action_mapping.ActionMapping\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\x12\x15\n\renabled_count\x18\x03 \x01(\x05\x12\x16\n\x0e\x64isabled_count\x18\x04 \x01(\x05\x32\xe4\x01\n\x14\x41\x63tionMappingService\x12h\n\x11GetActionMappings\x12(.action_mapping.GetActionMappingsRequest\x1a).action_mapping.GetActionMappingsResponse\x12\x62\n\x10GetActionMapping\x12\'.action_mapping.GetActionMappingRequest\x1a%.action_mapping.ActionMappingResponseB\x19\xaa\x02\x16GeViScopeBridge.Protosb\x06proto3')
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'action_mapping_pb2', _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals['DESCRIPTOR']._options = None
|
||||
_globals['DESCRIPTOR']._serialized_options = b'\252\002\026GeViScopeBridge.Protos'
|
||||
_globals['_GETACTIONMAPPINGSREQUEST']._serialized_start=40
|
||||
_globals['_GETACTIONMAPPINGSREQUEST']._serialized_end=88
|
||||
_globals['_GETACTIONMAPPINGREQUEST']._serialized_start=90
|
||||
_globals['_GETACTIONMAPPINGREQUEST']._serialized_end=127
|
||||
_globals['_ACTIONMAPPING']._serialized_start=130
|
||||
_globals['_ACTIONMAPPING']._serialized_end=343
|
||||
_globals['_ACTIONMAPPINGRESPONSE']._serialized_start=345
|
||||
_globals['_ACTIONMAPPINGRESPONSE']._serialized_end=416
|
||||
_globals['_GETACTIONMAPPINGSRESPONSE']._serialized_start=419
|
||||
_globals['_GETACTIONMAPPINGSRESPONSE']._serialized_end=563
|
||||
_globals['_ACTIONMAPPINGSERVICE']._serialized_start=566
|
||||
_globals['_ACTIONMAPPINGSERVICE']._serialized_end=794
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
60
src/api/protos/action_mapping_pb2.pyi
Normal file
60
src/api/protos/action_mapping_pb2.pyi
Normal file
@@ -0,0 +1,60 @@
|
||||
from google.protobuf.internal import containers as _containers
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import message as _message
|
||||
from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class GetActionMappingsRequest(_message.Message):
|
||||
__slots__ = ("enabled_only",)
|
||||
ENABLED_ONLY_FIELD_NUMBER: _ClassVar[int]
|
||||
enabled_only: bool
|
||||
def __init__(self, enabled_only: bool = ...) -> None: ...
|
||||
|
||||
class GetActionMappingRequest(_message.Message):
|
||||
__slots__ = ("id",)
|
||||
ID_FIELD_NUMBER: _ClassVar[int]
|
||||
id: str
|
||||
def __init__(self, id: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ActionMapping(_message.Message):
|
||||
__slots__ = ("id", "name", "description", "input_action", "output_actions", "enabled", "execution_count", "last_executed", "created_at", "updated_at")
|
||||
ID_FIELD_NUMBER: _ClassVar[int]
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
INPUT_ACTION_FIELD_NUMBER: _ClassVar[int]
|
||||
OUTPUT_ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
ENABLED_FIELD_NUMBER: _ClassVar[int]
|
||||
EXECUTION_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
LAST_EXECUTED_FIELD_NUMBER: _ClassVar[int]
|
||||
CREATED_AT_FIELD_NUMBER: _ClassVar[int]
|
||||
UPDATED_AT_FIELD_NUMBER: _ClassVar[int]
|
||||
id: str
|
||||
name: str
|
||||
description: str
|
||||
input_action: str
|
||||
output_actions: _containers.RepeatedScalarFieldContainer[str]
|
||||
enabled: bool
|
||||
execution_count: int
|
||||
last_executed: str
|
||||
created_at: str
|
||||
updated_at: str
|
||||
def __init__(self, id: _Optional[str] = ..., name: _Optional[str] = ..., description: _Optional[str] = ..., input_action: _Optional[str] = ..., output_actions: _Optional[_Iterable[str]] = ..., enabled: bool = ..., execution_count: _Optional[int] = ..., last_executed: _Optional[str] = ..., created_at: _Optional[str] = ..., updated_at: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ActionMappingResponse(_message.Message):
|
||||
__slots__ = ("mapping",)
|
||||
MAPPING_FIELD_NUMBER: _ClassVar[int]
|
||||
mapping: ActionMapping
|
||||
def __init__(self, mapping: _Optional[_Union[ActionMapping, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class GetActionMappingsResponse(_message.Message):
|
||||
__slots__ = ("mappings", "total_count", "enabled_count", "disabled_count")
|
||||
MAPPINGS_FIELD_NUMBER: _ClassVar[int]
|
||||
TOTAL_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
ENABLED_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
DISABLED_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
mappings: _containers.RepeatedCompositeFieldContainer[ActionMapping]
|
||||
total_count: int
|
||||
enabled_count: int
|
||||
disabled_count: int
|
||||
def __init__(self, mappings: _Optional[_Iterable[_Union[ActionMapping, _Mapping]]] = ..., total_count: _Optional[int] = ..., enabled_count: _Optional[int] = ..., disabled_count: _Optional[int] = ...) -> None: ...
|
||||
99
src/api/protos/action_mapping_pb2_grpc.py
Normal file
99
src/api/protos/action_mapping_pb2_grpc.py
Normal file
@@ -0,0 +1,99 @@
|
||||
# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
|
||||
"""Client and server classes corresponding to protobuf-defined services."""
|
||||
import grpc
|
||||
|
||||
import action_mapping_pb2 as action__mapping__pb2
|
||||
|
||||
|
||||
class ActionMappingServiceStub(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
def __init__(self, channel):
|
||||
"""Constructor.
|
||||
|
||||
Args:
|
||||
channel: A grpc.Channel.
|
||||
"""
|
||||
self.GetActionMappings = channel.unary_unary(
|
||||
'/action_mapping.ActionMappingService/GetActionMappings',
|
||||
request_serializer=action__mapping__pb2.GetActionMappingsRequest.SerializeToString,
|
||||
response_deserializer=action__mapping__pb2.GetActionMappingsResponse.FromString,
|
||||
)
|
||||
self.GetActionMapping = channel.unary_unary(
|
||||
'/action_mapping.ActionMappingService/GetActionMapping',
|
||||
request_serializer=action__mapping__pb2.GetActionMappingRequest.SerializeToString,
|
||||
response_deserializer=action__mapping__pb2.ActionMappingResponse.FromString,
|
||||
)
|
||||
|
||||
|
||||
class ActionMappingServiceServicer(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
def GetActionMappings(self, request, context):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def GetActionMapping(self, request, context):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
|
||||
def add_ActionMappingServiceServicer_to_server(servicer, server):
|
||||
rpc_method_handlers = {
|
||||
'GetActionMappings': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.GetActionMappings,
|
||||
request_deserializer=action__mapping__pb2.GetActionMappingsRequest.FromString,
|
||||
response_serializer=action__mapping__pb2.GetActionMappingsResponse.SerializeToString,
|
||||
),
|
||||
'GetActionMapping': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.GetActionMapping,
|
||||
request_deserializer=action__mapping__pb2.GetActionMappingRequest.FromString,
|
||||
response_serializer=action__mapping__pb2.ActionMappingResponse.SerializeToString,
|
||||
),
|
||||
}
|
||||
generic_handler = grpc.method_handlers_generic_handler(
|
||||
'action_mapping.ActionMappingService', rpc_method_handlers)
|
||||
server.add_generic_rpc_handlers((generic_handler,))
|
||||
|
||||
|
||||
# This class is part of an EXPERIMENTAL API.
|
||||
class ActionMappingService(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
@staticmethod
|
||||
def GetActionMappings(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/action_mapping.ActionMappingService/GetActionMappings',
|
||||
action__mapping__pb2.GetActionMappingsRequest.SerializeToString,
|
||||
action__mapping__pb2.GetActionMappingsResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def GetActionMapping(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/action_mapping.ActionMappingService/GetActionMapping',
|
||||
action__mapping__pb2.GetActionMappingRequest.SerializeToString,
|
||||
action__mapping__pb2.ActionMappingResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
36
src/api/protos/camera_pb2.py
Normal file
36
src/api/protos/camera_pb2.py
Normal file
@@ -0,0 +1,36 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: camera.proto
|
||||
# Protobuf Python Version: 4.25.0
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from protos import common_pb2 as common__pb2
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0c\x63\x61mera.proto\x12\x0fgeviscopebridge\x1a\x0c\x63ommon.proto\"\x14\n\x12ListCamerasRequest\"X\n\x13ListCamerasResponse\x12,\n\x07\x63\x61meras\x18\x01 \x03(\x0b\x32\x1b.geviscopebridge.CameraInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"%\n\x10GetCameraRequest\x12\x11\n\tcamera_id\x18\x01 \x01(\x05\"\xa5\x01\n\nCameraInfo\x12\n\n\x02id\x18\x01 \x01(\x05\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x0f\n\x07has_ptz\x18\x04 \x01(\x08\x12\x18\n\x10has_video_sensor\x18\x05 \x01(\x08\x12\x0e\n\x06status\x18\x06 \x01(\t\x12-\n\tlast_seen\x18\x07 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp2\xb6\x01\n\rCameraService\x12X\n\x0bListCameras\x12#.geviscopebridge.ListCamerasRequest\x1a$.geviscopebridge.ListCamerasResponse\x12K\n\tGetCamera\x12!.geviscopebridge.GetCameraRequest\x1a\x1b.geviscopebridge.CameraInfoB\x19\xaa\x02\x16GeViScopeBridge.Protosb\x06proto3')
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'camera_pb2', _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals['DESCRIPTOR']._options = None
|
||||
_globals['DESCRIPTOR']._serialized_options = b'\252\002\026GeViScopeBridge.Protos'
|
||||
_globals['_LISTCAMERASREQUEST']._serialized_start=47
|
||||
_globals['_LISTCAMERASREQUEST']._serialized_end=67
|
||||
_globals['_LISTCAMERASRESPONSE']._serialized_start=69
|
||||
_globals['_LISTCAMERASRESPONSE']._serialized_end=157
|
||||
_globals['_GETCAMERAREQUEST']._serialized_start=159
|
||||
_globals['_GETCAMERAREQUEST']._serialized_end=196
|
||||
_globals['_CAMERAINFO']._serialized_start=199
|
||||
_globals['_CAMERAINFO']._serialized_end=364
|
||||
_globals['_CAMERASERVICE']._serialized_start=367
|
||||
_globals['_CAMERASERVICE']._serialized_end=549
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
0
src/api/protos/camera_pb2_grpc.py
Normal file
0
src/api/protos/camera_pb2_grpc.py
Normal file
33
src/api/protos/common_pb2.py
Normal file
33
src/api/protos/common_pb2.py
Normal file
@@ -0,0 +1,33 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: common.proto
|
||||
# Protobuf Python Version: 4.25.0
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0c\x63ommon.proto\x12\x0fgeviscopebridge\"\x07\n\x05\x45mpty\">\n\x06Status\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\x12\n\nerror_code\x18\x03 \x01(\x05\"+\n\tTimestamp\x12\x0f\n\x07seconds\x18\x01 \x01(\x03\x12\r\n\x05nanos\x18\x02 \x01(\x05\"N\n\x0c\x45rrorDetails\x12\x15\n\rerror_message\x18\x01 \x01(\t\x12\x12\n\nerror_code\x18\x02 \x01(\x05\x12\x13\n\x0bstack_trace\x18\x03 \x01(\tB\x19\xaa\x02\x16GeViScopeBridge.Protosb\x06proto3')
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'common_pb2', _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals['DESCRIPTOR']._options = None
|
||||
_globals['DESCRIPTOR']._serialized_options = b'\252\002\026GeViScopeBridge.Protos'
|
||||
_globals['_EMPTY']._serialized_start=33
|
||||
_globals['_EMPTY']._serialized_end=40
|
||||
_globals['_STATUS']._serialized_start=42
|
||||
_globals['_STATUS']._serialized_end=104
|
||||
_globals['_TIMESTAMP']._serialized_start=106
|
||||
_globals['_TIMESTAMP']._serialized_end=149
|
||||
_globals['_ERRORDETAILS']._serialized_start=151
|
||||
_globals['_ERRORDETAILS']._serialized_end=229
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
0
src/api/protos/common_pb2_grpc.py
Normal file
0
src/api/protos/common_pb2_grpc.py
Normal file
298
src/api/protos/configuration.proto
Normal file
298
src/api/protos/configuration.proto
Normal file
@@ -0,0 +1,298 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package configuration;
|
||||
|
||||
option csharp_namespace = "GeViScopeBridge.Protos";
|
||||
|
||||
service ConfigurationService {
|
||||
// Read and parse complete configuration from GeViServer
|
||||
rpc ReadConfiguration(ReadConfigurationRequest) returns (ConfigurationResponse);
|
||||
|
||||
// Export configuration as JSON string
|
||||
rpc ExportConfigurationJson(ExportJsonRequest) returns (JsonExportResponse);
|
||||
|
||||
// Modify configuration values and write back to server
|
||||
rpc ModifyConfiguration(ModifyConfigurationRequest) returns (ModifyConfigurationResponse);
|
||||
|
||||
// Import complete configuration from JSON and write to GeViServer
|
||||
rpc ImportConfiguration(ImportConfigurationRequest) returns (ImportConfigurationResponse);
|
||||
|
||||
// SELECTIVE/TARGETED READ METHODS (Fast, lightweight)
|
||||
|
||||
// Read ONLY action mappings (Rules markers) - optimized for speed
|
||||
rpc ReadActionMappings(ReadActionMappingsRequest) returns (ActionMappingsResponse);
|
||||
|
||||
// Read specific markers by name - extensible for future config types
|
||||
rpc ReadSpecificMarkers(ReadSpecificMarkersRequest) returns (SelectiveConfigResponse);
|
||||
|
||||
// ACTION MAPPING WRITE METHODS
|
||||
|
||||
// Create a new action mapping
|
||||
rpc CreateActionMapping(CreateActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// Update an existing action mapping by ID
|
||||
rpc UpdateActionMapping(UpdateActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// Delete an action mapping by ID
|
||||
rpc DeleteActionMapping(DeleteActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// SERVER CONFIGURATION WRITE METHODS (G-CORE SERVERS)
|
||||
|
||||
// Create a new G-core server
|
||||
rpc CreateServer(CreateServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// Update an existing G-core server
|
||||
rpc UpdateServer(UpdateServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// Delete a G-core server
|
||||
rpc DeleteServer(DeleteServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// TREE FORMAT (RECOMMENDED)
|
||||
|
||||
// Read configuration as hierarchical folder tree - much more readable than flat format
|
||||
rpc ReadConfigurationTree(ReadConfigurationTreeRequest) returns (ConfigurationTreeResponse);
|
||||
|
||||
// REGISTRY EXPLORATION METHODS
|
||||
|
||||
// List top-level registry nodes
|
||||
rpc ListRegistryNodes(ListRegistryNodesRequest) returns (RegistryNodesResponse);
|
||||
|
||||
// Get details about a specific registry node
|
||||
rpc GetRegistryNodeDetails(GetRegistryNodeDetailsRequest) returns (RegistryNodeDetailsResponse);
|
||||
|
||||
// Search for action mapping paths in registry
|
||||
rpc SearchActionMappingPaths(SearchActionMappingPathsRequest) returns (ActionMappingPathsResponse);
|
||||
}
|
||||
|
||||
message ReadConfigurationRequest {
|
||||
// Empty - uses connection from setup client
|
||||
}
|
||||
|
||||
message ConfigurationStatistics {
|
||||
int32 total_nodes = 1;
|
||||
int32 boolean_count = 2;
|
||||
int32 integer_count = 3;
|
||||
int32 string_count = 4;
|
||||
int32 property_count = 5;
|
||||
int32 marker_count = 6;
|
||||
int32 rules_section_count = 7;
|
||||
}
|
||||
|
||||
message ConfigNode {
|
||||
int32 start_offset = 1;
|
||||
int32 end_offset = 2;
|
||||
string node_type = 3; // "boolean", "integer", "string", "property", "marker"
|
||||
string name = 4;
|
||||
string value = 5; // Serialized as string
|
||||
string value_type = 6;
|
||||
}
|
||||
|
||||
message ConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 file_size = 3;
|
||||
string header = 4;
|
||||
repeated ConfigNode nodes = 5;
|
||||
ConfigurationStatistics statistics = 6;
|
||||
}
|
||||
|
||||
message ExportJsonRequest {
|
||||
// Empty - exports current configuration
|
||||
}
|
||||
|
||||
message JsonExportResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
string json_data = 3;
|
||||
int32 json_size = 4;
|
||||
}
|
||||
|
||||
message NodeModification {
|
||||
int32 start_offset = 1;
|
||||
string node_type = 2; // "boolean", "integer", "string"
|
||||
string new_value = 3; // Serialized as string
|
||||
}
|
||||
|
||||
message ModifyConfigurationRequest {
|
||||
repeated NodeModification modifications = 1;
|
||||
}
|
||||
|
||||
message ModifyConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 modifications_applied = 3;
|
||||
}
|
||||
|
||||
message ImportConfigurationRequest {
|
||||
string json_data = 1; // Complete configuration as JSON string
|
||||
}
|
||||
|
||||
message ImportConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 bytes_written = 3;
|
||||
int32 nodes_imported = 4;
|
||||
}
|
||||
|
||||
// ========== SELECTIVE READ MESSAGES ==========
|
||||
|
||||
message ReadActionMappingsRequest {
|
||||
// Empty - reads action mappings from current configuration
|
||||
}
|
||||
|
||||
message ActionParameter {
|
||||
string name = 1; // Parameter name (e.g., "VideoInput", "G-core alias")
|
||||
string value = 2; // Parameter value (e.g., "101027", "gscope-cdu-3")
|
||||
}
|
||||
|
||||
message ActionDefinition {
|
||||
string action = 1; // Action name (e.g., "CrossSwitch C_101027 -> M")
|
||||
repeated ActionParameter parameters = 2; // Named parameters
|
||||
}
|
||||
|
||||
message ConfigActionMapping {
|
||||
string name = 1; // Mapping name (e.g., "CrossSwitch C_101027 -> M")
|
||||
repeated ActionDefinition input_actions = 2; // Trigger/condition actions
|
||||
repeated ActionDefinition output_actions = 3; // Response actions
|
||||
int32 start_offset = 4;
|
||||
int32 end_offset = 5;
|
||||
|
||||
// Deprecated - kept for backward compatibility
|
||||
repeated string actions = 6; // List of action strings (old format)
|
||||
}
|
||||
|
||||
message ActionMappingsResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
repeated ConfigActionMapping mappings = 3;
|
||||
int32 total_count = 4;
|
||||
}
|
||||
|
||||
message ReadSpecificMarkersRequest {
|
||||
repeated string marker_names = 1; // Names of markers to extract (e.g., "Rules", "Camera")
|
||||
}
|
||||
|
||||
message SelectiveConfigResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 file_size = 3;
|
||||
repeated string requested_markers = 4;
|
||||
repeated ConfigNode extracted_nodes = 5;
|
||||
int32 markers_found = 6;
|
||||
}
|
||||
|
||||
// ========== ACTION MAPPING WRITE MESSAGES ==========
|
||||
|
||||
message ActionMappingInput {
|
||||
string name = 1; // Mapping caption (required for GeViSet display)
|
||||
repeated ActionDefinition input_actions = 2; // Trigger actions
|
||||
repeated ActionDefinition output_actions = 3; // Response actions (required)
|
||||
int32 video_input = 4; // Video input ID (optional, but recommended for GeViSet display)
|
||||
}
|
||||
|
||||
message CreateActionMappingRequest {
|
||||
ActionMappingInput mapping = 1;
|
||||
}
|
||||
|
||||
message UpdateActionMappingRequest {
|
||||
int32 mapping_id = 1; // 1-based ID of mapping to update
|
||||
ActionMappingInput mapping = 2; // New data (fields can be partial)
|
||||
}
|
||||
|
||||
message DeleteActionMappingRequest {
|
||||
int32 mapping_id = 1; // 1-based ID of mapping to delete
|
||||
}
|
||||
|
||||
message ActionMappingOperationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
ConfigActionMapping mapping = 3; // Created/updated mapping (null for delete)
|
||||
string message = 4; // Success/info message
|
||||
}
|
||||
|
||||
// REGISTRY EXPLORATION MESSAGES
|
||||
|
||||
message ListRegistryNodesRequest {
|
||||
// Empty - lists top-level nodes
|
||||
}
|
||||
|
||||
message RegistryNodesResponse {
|
||||
bool success = 1;
|
||||
repeated string node_paths = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
message GetRegistryNodeDetailsRequest {
|
||||
string node_path = 1;
|
||||
}
|
||||
|
||||
message RegistryNodeDetailsResponse {
|
||||
bool success = 1;
|
||||
string details = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
message SearchActionMappingPathsRequest {
|
||||
// Empty - searches for action mapping related nodes
|
||||
}
|
||||
|
||||
message ActionMappingPathsResponse {
|
||||
bool success = 1;
|
||||
repeated string paths = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
// ========== SERVER CRUD MESSAGES ==========
|
||||
|
||||
message ServerData {
|
||||
string id = 1; // Server ID (folder name in GeViGCoreServer)
|
||||
string alias = 2; // Alias (display name)
|
||||
string host = 3; // Host/IP address
|
||||
string user = 4; // Username
|
||||
string password = 5; // Password
|
||||
bool enabled = 6; // Enabled flag
|
||||
bool deactivate_echo = 7; // DeactivateEcho flag
|
||||
bool deactivate_live_check = 8; // DeactivateLiveCheck flag
|
||||
}
|
||||
|
||||
message CreateServerRequest {
|
||||
ServerData server = 1;
|
||||
}
|
||||
|
||||
message UpdateServerRequest {
|
||||
string server_id = 1; // ID of server to update
|
||||
ServerData server = 2; // New server data (fields can be partial)
|
||||
}
|
||||
|
||||
message DeleteServerRequest {
|
||||
string server_id = 1; // ID of server to delete
|
||||
}
|
||||
|
||||
message ServerOperationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
ServerData server = 3; // Created/updated server (null for delete)
|
||||
string message = 4; // Success/info message
|
||||
int32 bytes_written = 5; // Size of configuration written
|
||||
}
|
||||
|
||||
// ========== TREE FORMAT MESSAGES ==========
|
||||
|
||||
message ReadConfigurationTreeRequest {
|
||||
// Empty - reads entire configuration as tree
|
||||
}
|
||||
|
||||
message TreeNode {
|
||||
string type = 1; // "folder", "bool", "byte", "int16", "int32", "int64", "string"
|
||||
string name = 2; // Node name
|
||||
int64 int_value = 3; // For integer/bool types
|
||||
string string_value = 4; // For string types
|
||||
repeated TreeNode children = 5; // For folders (hierarchical structure)
|
||||
}
|
||||
|
||||
message ConfigurationTreeResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
TreeNode root = 3; // Root folder node containing entire configuration tree
|
||||
int32 total_nodes = 4; // Total node count (all levels)
|
||||
}
|
||||
101
src/api/protos/configuration_pb2.py
Normal file
101
src/api/protos/configuration_pb2.py
Normal file
File diff suppressed because one or more lines are too long
362
src/api/protos/configuration_pb2.pyi
Normal file
362
src/api/protos/configuration_pb2.pyi
Normal file
@@ -0,0 +1,362 @@
|
||||
from google.protobuf.internal import containers as _containers
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import message as _message
|
||||
from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class ReadConfigurationRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class ConfigurationStatistics(_message.Message):
|
||||
__slots__ = ("total_nodes", "boolean_count", "integer_count", "string_count", "property_count", "marker_count", "rules_section_count")
|
||||
TOTAL_NODES_FIELD_NUMBER: _ClassVar[int]
|
||||
BOOLEAN_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
INTEGER_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
STRING_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
PROPERTY_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
MARKER_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
RULES_SECTION_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
total_nodes: int
|
||||
boolean_count: int
|
||||
integer_count: int
|
||||
string_count: int
|
||||
property_count: int
|
||||
marker_count: int
|
||||
rules_section_count: int
|
||||
def __init__(self, total_nodes: _Optional[int] = ..., boolean_count: _Optional[int] = ..., integer_count: _Optional[int] = ..., string_count: _Optional[int] = ..., property_count: _Optional[int] = ..., marker_count: _Optional[int] = ..., rules_section_count: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ConfigNode(_message.Message):
|
||||
__slots__ = ("start_offset", "end_offset", "node_type", "name", "value", "value_type")
|
||||
START_OFFSET_FIELD_NUMBER: _ClassVar[int]
|
||||
END_OFFSET_FIELD_NUMBER: _ClassVar[int]
|
||||
NODE_TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
start_offset: int
|
||||
end_offset: int
|
||||
node_type: str
|
||||
name: str
|
||||
value: str
|
||||
value_type: str
|
||||
def __init__(self, start_offset: _Optional[int] = ..., end_offset: _Optional[int] = ..., node_type: _Optional[str] = ..., name: _Optional[str] = ..., value: _Optional[str] = ..., value_type: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ConfigurationResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "file_size", "header", "nodes", "statistics")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
FILE_SIZE_FIELD_NUMBER: _ClassVar[int]
|
||||
HEADER_FIELD_NUMBER: _ClassVar[int]
|
||||
NODES_FIELD_NUMBER: _ClassVar[int]
|
||||
STATISTICS_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
file_size: int
|
||||
header: str
|
||||
nodes: _containers.RepeatedCompositeFieldContainer[ConfigNode]
|
||||
statistics: ConfigurationStatistics
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., file_size: _Optional[int] = ..., header: _Optional[str] = ..., nodes: _Optional[_Iterable[_Union[ConfigNode, _Mapping]]] = ..., statistics: _Optional[_Union[ConfigurationStatistics, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class ExportJsonRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class JsonExportResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "json_data", "json_size")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
JSON_DATA_FIELD_NUMBER: _ClassVar[int]
|
||||
JSON_SIZE_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
json_data: str
|
||||
json_size: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., json_data: _Optional[str] = ..., json_size: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class NodeModification(_message.Message):
|
||||
__slots__ = ("start_offset", "node_type", "new_value")
|
||||
START_OFFSET_FIELD_NUMBER: _ClassVar[int]
|
||||
NODE_TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
NEW_VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
start_offset: int
|
||||
node_type: str
|
||||
new_value: str
|
||||
def __init__(self, start_offset: _Optional[int] = ..., node_type: _Optional[str] = ..., new_value: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ModifyConfigurationRequest(_message.Message):
|
||||
__slots__ = ("modifications",)
|
||||
MODIFICATIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
modifications: _containers.RepeatedCompositeFieldContainer[NodeModification]
|
||||
def __init__(self, modifications: _Optional[_Iterable[_Union[NodeModification, _Mapping]]] = ...) -> None: ...
|
||||
|
||||
class ModifyConfigurationResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "modifications_applied")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
MODIFICATIONS_APPLIED_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
modifications_applied: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., modifications_applied: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ImportConfigurationRequest(_message.Message):
|
||||
__slots__ = ("json_data",)
|
||||
JSON_DATA_FIELD_NUMBER: _ClassVar[int]
|
||||
json_data: str
|
||||
def __init__(self, json_data: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ImportConfigurationResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "bytes_written", "nodes_imported")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
BYTES_WRITTEN_FIELD_NUMBER: _ClassVar[int]
|
||||
NODES_IMPORTED_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
bytes_written: int
|
||||
nodes_imported: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., bytes_written: _Optional[int] = ..., nodes_imported: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ReadActionMappingsRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class ActionParameter(_message.Message):
|
||||
__slots__ = ("name", "value")
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
name: str
|
||||
value: str
|
||||
def __init__(self, name: _Optional[str] = ..., value: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ActionDefinition(_message.Message):
|
||||
__slots__ = ("action", "parameters")
|
||||
ACTION_FIELD_NUMBER: _ClassVar[int]
|
||||
PARAMETERS_FIELD_NUMBER: _ClassVar[int]
|
||||
action: str
|
||||
parameters: _containers.RepeatedCompositeFieldContainer[ActionParameter]
|
||||
def __init__(self, action: _Optional[str] = ..., parameters: _Optional[_Iterable[_Union[ActionParameter, _Mapping]]] = ...) -> None: ...
|
||||
|
||||
class ConfigActionMapping(_message.Message):
|
||||
__slots__ = ("name", "input_actions", "output_actions", "start_offset", "end_offset", "actions")
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
INPUT_ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
OUTPUT_ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
START_OFFSET_FIELD_NUMBER: _ClassVar[int]
|
||||
END_OFFSET_FIELD_NUMBER: _ClassVar[int]
|
||||
ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
name: str
|
||||
input_actions: _containers.RepeatedCompositeFieldContainer[ActionDefinition]
|
||||
output_actions: _containers.RepeatedCompositeFieldContainer[ActionDefinition]
|
||||
start_offset: int
|
||||
end_offset: int
|
||||
actions: _containers.RepeatedScalarFieldContainer[str]
|
||||
def __init__(self, name: _Optional[str] = ..., input_actions: _Optional[_Iterable[_Union[ActionDefinition, _Mapping]]] = ..., output_actions: _Optional[_Iterable[_Union[ActionDefinition, _Mapping]]] = ..., start_offset: _Optional[int] = ..., end_offset: _Optional[int] = ..., actions: _Optional[_Iterable[str]] = ...) -> None: ...
|
||||
|
||||
class ActionMappingsResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "mappings", "total_count")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
MAPPINGS_FIELD_NUMBER: _ClassVar[int]
|
||||
TOTAL_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
mappings: _containers.RepeatedCompositeFieldContainer[ConfigActionMapping]
|
||||
total_count: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., mappings: _Optional[_Iterable[_Union[ConfigActionMapping, _Mapping]]] = ..., total_count: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ReadSpecificMarkersRequest(_message.Message):
|
||||
__slots__ = ("marker_names",)
|
||||
MARKER_NAMES_FIELD_NUMBER: _ClassVar[int]
|
||||
marker_names: _containers.RepeatedScalarFieldContainer[str]
|
||||
def __init__(self, marker_names: _Optional[_Iterable[str]] = ...) -> None: ...
|
||||
|
||||
class SelectiveConfigResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "file_size", "requested_markers", "extracted_nodes", "markers_found")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
FILE_SIZE_FIELD_NUMBER: _ClassVar[int]
|
||||
REQUESTED_MARKERS_FIELD_NUMBER: _ClassVar[int]
|
||||
EXTRACTED_NODES_FIELD_NUMBER: _ClassVar[int]
|
||||
MARKERS_FOUND_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
file_size: int
|
||||
requested_markers: _containers.RepeatedScalarFieldContainer[str]
|
||||
extracted_nodes: _containers.RepeatedCompositeFieldContainer[ConfigNode]
|
||||
markers_found: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., file_size: _Optional[int] = ..., requested_markers: _Optional[_Iterable[str]] = ..., extracted_nodes: _Optional[_Iterable[_Union[ConfigNode, _Mapping]]] = ..., markers_found: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ActionMappingInput(_message.Message):
|
||||
__slots__ = ("name", "input_actions", "output_actions", "video_input")
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
INPUT_ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
OUTPUT_ACTIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
VIDEO_INPUT_FIELD_NUMBER: _ClassVar[int]
|
||||
name: str
|
||||
input_actions: _containers.RepeatedCompositeFieldContainer[ActionDefinition]
|
||||
output_actions: _containers.RepeatedCompositeFieldContainer[ActionDefinition]
|
||||
video_input: int
|
||||
def __init__(self, name: _Optional[str] = ..., input_actions: _Optional[_Iterable[_Union[ActionDefinition, _Mapping]]] = ..., output_actions: _Optional[_Iterable[_Union[ActionDefinition, _Mapping]]] = ..., video_input: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class CreateActionMappingRequest(_message.Message):
|
||||
__slots__ = ("mapping",)
|
||||
MAPPING_FIELD_NUMBER: _ClassVar[int]
|
||||
mapping: ActionMappingInput
|
||||
def __init__(self, mapping: _Optional[_Union[ActionMappingInput, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class UpdateActionMappingRequest(_message.Message):
|
||||
__slots__ = ("mapping_id", "mapping")
|
||||
MAPPING_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
MAPPING_FIELD_NUMBER: _ClassVar[int]
|
||||
mapping_id: int
|
||||
mapping: ActionMappingInput
|
||||
def __init__(self, mapping_id: _Optional[int] = ..., mapping: _Optional[_Union[ActionMappingInput, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class DeleteActionMappingRequest(_message.Message):
|
||||
__slots__ = ("mapping_id",)
|
||||
MAPPING_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
mapping_id: int
|
||||
def __init__(self, mapping_id: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ActionMappingOperationResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "mapping", "message")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
MAPPING_FIELD_NUMBER: _ClassVar[int]
|
||||
MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
mapping: ConfigActionMapping
|
||||
message: str
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., mapping: _Optional[_Union[ConfigActionMapping, _Mapping]] = ..., message: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ListRegistryNodesRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class RegistryNodesResponse(_message.Message):
|
||||
__slots__ = ("success", "node_paths", "error_message")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
NODE_PATHS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
node_paths: _containers.RepeatedScalarFieldContainer[str]
|
||||
error_message: str
|
||||
def __init__(self, success: bool = ..., node_paths: _Optional[_Iterable[str]] = ..., error_message: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class GetRegistryNodeDetailsRequest(_message.Message):
|
||||
__slots__ = ("node_path",)
|
||||
NODE_PATH_FIELD_NUMBER: _ClassVar[int]
|
||||
node_path: str
|
||||
def __init__(self, node_path: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class RegistryNodeDetailsResponse(_message.Message):
|
||||
__slots__ = ("success", "details", "error_message")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
DETAILS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
details: str
|
||||
error_message: str
|
||||
def __init__(self, success: bool = ..., details: _Optional[str] = ..., error_message: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class SearchActionMappingPathsRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class ActionMappingPathsResponse(_message.Message):
|
||||
__slots__ = ("success", "paths", "error_message")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
PATHS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
paths: _containers.RepeatedScalarFieldContainer[str]
|
||||
error_message: str
|
||||
def __init__(self, success: bool = ..., paths: _Optional[_Iterable[str]] = ..., error_message: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ServerData(_message.Message):
|
||||
__slots__ = ("id", "alias", "host", "user", "password", "enabled", "deactivate_echo", "deactivate_live_check")
|
||||
ID_FIELD_NUMBER: _ClassVar[int]
|
||||
ALIAS_FIELD_NUMBER: _ClassVar[int]
|
||||
HOST_FIELD_NUMBER: _ClassVar[int]
|
||||
USER_FIELD_NUMBER: _ClassVar[int]
|
||||
PASSWORD_FIELD_NUMBER: _ClassVar[int]
|
||||
ENABLED_FIELD_NUMBER: _ClassVar[int]
|
||||
DEACTIVATE_ECHO_FIELD_NUMBER: _ClassVar[int]
|
||||
DEACTIVATE_LIVE_CHECK_FIELD_NUMBER: _ClassVar[int]
|
||||
id: str
|
||||
alias: str
|
||||
host: str
|
||||
user: str
|
||||
password: str
|
||||
enabled: bool
|
||||
deactivate_echo: bool
|
||||
deactivate_live_check: bool
|
||||
def __init__(self, id: _Optional[str] = ..., alias: _Optional[str] = ..., host: _Optional[str] = ..., user: _Optional[str] = ..., password: _Optional[str] = ..., enabled: bool = ..., deactivate_echo: bool = ..., deactivate_live_check: bool = ...) -> None: ...
|
||||
|
||||
class CreateServerRequest(_message.Message):
|
||||
__slots__ = ("server",)
|
||||
SERVER_FIELD_NUMBER: _ClassVar[int]
|
||||
server: ServerData
|
||||
def __init__(self, server: _Optional[_Union[ServerData, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class UpdateServerRequest(_message.Message):
|
||||
__slots__ = ("server_id", "server")
|
||||
SERVER_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
SERVER_FIELD_NUMBER: _ClassVar[int]
|
||||
server_id: str
|
||||
server: ServerData
|
||||
def __init__(self, server_id: _Optional[str] = ..., server: _Optional[_Union[ServerData, _Mapping]] = ...) -> None: ...
|
||||
|
||||
class DeleteServerRequest(_message.Message):
|
||||
__slots__ = ("server_id",)
|
||||
SERVER_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
server_id: str
|
||||
def __init__(self, server_id: _Optional[str] = ...) -> None: ...
|
||||
|
||||
class ServerOperationResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "server", "message", "bytes_written")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
SERVER_FIELD_NUMBER: _ClassVar[int]
|
||||
MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
BYTES_WRITTEN_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
server: ServerData
|
||||
message: str
|
||||
bytes_written: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., server: _Optional[_Union[ServerData, _Mapping]] = ..., message: _Optional[str] = ..., bytes_written: _Optional[int] = ...) -> None: ...
|
||||
|
||||
class ReadConfigurationTreeRequest(_message.Message):
|
||||
__slots__ = ()
|
||||
def __init__(self) -> None: ...
|
||||
|
||||
class TreeNode(_message.Message):
|
||||
__slots__ = ("type", "name", "int_value", "string_value", "children")
|
||||
TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
INT_VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
STRING_VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
CHILDREN_FIELD_NUMBER: _ClassVar[int]
|
||||
type: str
|
||||
name: str
|
||||
int_value: int
|
||||
string_value: str
|
||||
children: _containers.RepeatedCompositeFieldContainer[TreeNode]
|
||||
def __init__(self, type: _Optional[str] = ..., name: _Optional[str] = ..., int_value: _Optional[int] = ..., string_value: _Optional[str] = ..., children: _Optional[_Iterable[_Union[TreeNode, _Mapping]]] = ...) -> None: ...
|
||||
|
||||
class ConfigurationTreeResponse(_message.Message):
|
||||
__slots__ = ("success", "error_message", "root", "total_nodes")
|
||||
SUCCESS_FIELD_NUMBER: _ClassVar[int]
|
||||
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
ROOT_FIELD_NUMBER: _ClassVar[int]
|
||||
TOTAL_NODES_FIELD_NUMBER: _ClassVar[int]
|
||||
success: bool
|
||||
error_message: str
|
||||
root: TreeNode
|
||||
total_nodes: int
|
||||
def __init__(self, success: bool = ..., error_message: _Optional[str] = ..., root: _Optional[_Union[TreeNode, _Mapping]] = ..., total_nodes: _Optional[int] = ...) -> None: ...
|
||||
587
src/api/protos/configuration_pb2_grpc.py
Normal file
587
src/api/protos/configuration_pb2_grpc.py
Normal file
@@ -0,0 +1,587 @@
|
||||
# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
|
||||
"""Client and server classes corresponding to protobuf-defined services."""
|
||||
import grpc
|
||||
|
||||
import configuration_pb2 as configuration__pb2
|
||||
|
||||
|
||||
class ConfigurationServiceStub(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
def __init__(self, channel):
|
||||
"""Constructor.
|
||||
|
||||
Args:
|
||||
channel: A grpc.Channel.
|
||||
"""
|
||||
self.ReadConfiguration = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ReadConfiguration',
|
||||
request_serializer=configuration__pb2.ReadConfigurationRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ConfigurationResponse.FromString,
|
||||
)
|
||||
self.ExportConfigurationJson = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ExportConfigurationJson',
|
||||
request_serializer=configuration__pb2.ExportJsonRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.JsonExportResponse.FromString,
|
||||
)
|
||||
self.ModifyConfiguration = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ModifyConfiguration',
|
||||
request_serializer=configuration__pb2.ModifyConfigurationRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ModifyConfigurationResponse.FromString,
|
||||
)
|
||||
self.ImportConfiguration = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ImportConfiguration',
|
||||
request_serializer=configuration__pb2.ImportConfigurationRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ImportConfigurationResponse.FromString,
|
||||
)
|
||||
self.ReadActionMappings = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ReadActionMappings',
|
||||
request_serializer=configuration__pb2.ReadActionMappingsRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ActionMappingsResponse.FromString,
|
||||
)
|
||||
self.ReadSpecificMarkers = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ReadSpecificMarkers',
|
||||
request_serializer=configuration__pb2.ReadSpecificMarkersRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.SelectiveConfigResponse.FromString,
|
||||
)
|
||||
self.CreateActionMapping = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/CreateActionMapping',
|
||||
request_serializer=configuration__pb2.CreateActionMappingRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
)
|
||||
self.UpdateActionMapping = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/UpdateActionMapping',
|
||||
request_serializer=configuration__pb2.UpdateActionMappingRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
)
|
||||
self.DeleteActionMapping = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/DeleteActionMapping',
|
||||
request_serializer=configuration__pb2.DeleteActionMappingRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
)
|
||||
self.CreateServer = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/CreateServer',
|
||||
request_serializer=configuration__pb2.CreateServerRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ServerOperationResponse.FromString,
|
||||
)
|
||||
self.UpdateServer = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/UpdateServer',
|
||||
request_serializer=configuration__pb2.UpdateServerRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ServerOperationResponse.FromString,
|
||||
)
|
||||
self.DeleteServer = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/DeleteServer',
|
||||
request_serializer=configuration__pb2.DeleteServerRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ServerOperationResponse.FromString,
|
||||
)
|
||||
self.ReadConfigurationTree = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ReadConfigurationTree',
|
||||
request_serializer=configuration__pb2.ReadConfigurationTreeRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ConfigurationTreeResponse.FromString,
|
||||
)
|
||||
self.ListRegistryNodes = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/ListRegistryNodes',
|
||||
request_serializer=configuration__pb2.ListRegistryNodesRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.RegistryNodesResponse.FromString,
|
||||
)
|
||||
self.GetRegistryNodeDetails = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/GetRegistryNodeDetails',
|
||||
request_serializer=configuration__pb2.GetRegistryNodeDetailsRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.RegistryNodeDetailsResponse.FromString,
|
||||
)
|
||||
self.SearchActionMappingPaths = channel.unary_unary(
|
||||
'/configuration.ConfigurationService/SearchActionMappingPaths',
|
||||
request_serializer=configuration__pb2.SearchActionMappingPathsRequest.SerializeToString,
|
||||
response_deserializer=configuration__pb2.ActionMappingPathsResponse.FromString,
|
||||
)
|
||||
|
||||
|
||||
class ConfigurationServiceServicer(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
def ReadConfiguration(self, request, context):
|
||||
"""Read and parse complete configuration from GeViServer
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ExportConfigurationJson(self, request, context):
|
||||
"""Export configuration as JSON string
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ModifyConfiguration(self, request, context):
|
||||
"""Modify configuration values and write back to server
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ImportConfiguration(self, request, context):
|
||||
"""Import complete configuration from JSON and write to GeViServer
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ReadActionMappings(self, request, context):
|
||||
"""SELECTIVE/TARGETED READ METHODS (Fast, lightweight)
|
||||
|
||||
Read ONLY action mappings (Rules markers) - optimized for speed
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ReadSpecificMarkers(self, request, context):
|
||||
"""Read specific markers by name - extensible for future config types
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def CreateActionMapping(self, request, context):
|
||||
"""ACTION MAPPING WRITE METHODS
|
||||
|
||||
Create a new action mapping
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def UpdateActionMapping(self, request, context):
|
||||
"""Update an existing action mapping by ID
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def DeleteActionMapping(self, request, context):
|
||||
"""Delete an action mapping by ID
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def CreateServer(self, request, context):
|
||||
"""SERVER CONFIGURATION WRITE METHODS (G-CORE SERVERS)
|
||||
|
||||
Create a new G-core server
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def UpdateServer(self, request, context):
|
||||
"""Update an existing G-core server
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def DeleteServer(self, request, context):
|
||||
"""Delete a G-core server
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ReadConfigurationTree(self, request, context):
|
||||
"""TREE FORMAT (RECOMMENDED)
|
||||
|
||||
Read configuration as hierarchical folder tree - much more readable than flat format
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def ListRegistryNodes(self, request, context):
|
||||
"""REGISTRY EXPLORATION METHODS
|
||||
|
||||
List top-level registry nodes
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def GetRegistryNodeDetails(self, request, context):
|
||||
"""Get details about a specific registry node
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
def SearchActionMappingPaths(self, request, context):
|
||||
"""Search for action mapping paths in registry
|
||||
"""
|
||||
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
|
||||
context.set_details('Method not implemented!')
|
||||
raise NotImplementedError('Method not implemented!')
|
||||
|
||||
|
||||
def add_ConfigurationServiceServicer_to_server(servicer, server):
|
||||
rpc_method_handlers = {
|
||||
'ReadConfiguration': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ReadConfiguration,
|
||||
request_deserializer=configuration__pb2.ReadConfigurationRequest.FromString,
|
||||
response_serializer=configuration__pb2.ConfigurationResponse.SerializeToString,
|
||||
),
|
||||
'ExportConfigurationJson': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ExportConfigurationJson,
|
||||
request_deserializer=configuration__pb2.ExportJsonRequest.FromString,
|
||||
response_serializer=configuration__pb2.JsonExportResponse.SerializeToString,
|
||||
),
|
||||
'ModifyConfiguration': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ModifyConfiguration,
|
||||
request_deserializer=configuration__pb2.ModifyConfigurationRequest.FromString,
|
||||
response_serializer=configuration__pb2.ModifyConfigurationResponse.SerializeToString,
|
||||
),
|
||||
'ImportConfiguration': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ImportConfiguration,
|
||||
request_deserializer=configuration__pb2.ImportConfigurationRequest.FromString,
|
||||
response_serializer=configuration__pb2.ImportConfigurationResponse.SerializeToString,
|
||||
),
|
||||
'ReadActionMappings': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ReadActionMappings,
|
||||
request_deserializer=configuration__pb2.ReadActionMappingsRequest.FromString,
|
||||
response_serializer=configuration__pb2.ActionMappingsResponse.SerializeToString,
|
||||
),
|
||||
'ReadSpecificMarkers': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ReadSpecificMarkers,
|
||||
request_deserializer=configuration__pb2.ReadSpecificMarkersRequest.FromString,
|
||||
response_serializer=configuration__pb2.SelectiveConfigResponse.SerializeToString,
|
||||
),
|
||||
'CreateActionMapping': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.CreateActionMapping,
|
||||
request_deserializer=configuration__pb2.CreateActionMappingRequest.FromString,
|
||||
response_serializer=configuration__pb2.ActionMappingOperationResponse.SerializeToString,
|
||||
),
|
||||
'UpdateActionMapping': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.UpdateActionMapping,
|
||||
request_deserializer=configuration__pb2.UpdateActionMappingRequest.FromString,
|
||||
response_serializer=configuration__pb2.ActionMappingOperationResponse.SerializeToString,
|
||||
),
|
||||
'DeleteActionMapping': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.DeleteActionMapping,
|
||||
request_deserializer=configuration__pb2.DeleteActionMappingRequest.FromString,
|
||||
response_serializer=configuration__pb2.ActionMappingOperationResponse.SerializeToString,
|
||||
),
|
||||
'CreateServer': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.CreateServer,
|
||||
request_deserializer=configuration__pb2.CreateServerRequest.FromString,
|
||||
response_serializer=configuration__pb2.ServerOperationResponse.SerializeToString,
|
||||
),
|
||||
'UpdateServer': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.UpdateServer,
|
||||
request_deserializer=configuration__pb2.UpdateServerRequest.FromString,
|
||||
response_serializer=configuration__pb2.ServerOperationResponse.SerializeToString,
|
||||
),
|
||||
'DeleteServer': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.DeleteServer,
|
||||
request_deserializer=configuration__pb2.DeleteServerRequest.FromString,
|
||||
response_serializer=configuration__pb2.ServerOperationResponse.SerializeToString,
|
||||
),
|
||||
'ReadConfigurationTree': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ReadConfigurationTree,
|
||||
request_deserializer=configuration__pb2.ReadConfigurationTreeRequest.FromString,
|
||||
response_serializer=configuration__pb2.ConfigurationTreeResponse.SerializeToString,
|
||||
),
|
||||
'ListRegistryNodes': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.ListRegistryNodes,
|
||||
request_deserializer=configuration__pb2.ListRegistryNodesRequest.FromString,
|
||||
response_serializer=configuration__pb2.RegistryNodesResponse.SerializeToString,
|
||||
),
|
||||
'GetRegistryNodeDetails': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.GetRegistryNodeDetails,
|
||||
request_deserializer=configuration__pb2.GetRegistryNodeDetailsRequest.FromString,
|
||||
response_serializer=configuration__pb2.RegistryNodeDetailsResponse.SerializeToString,
|
||||
),
|
||||
'SearchActionMappingPaths': grpc.unary_unary_rpc_method_handler(
|
||||
servicer.SearchActionMappingPaths,
|
||||
request_deserializer=configuration__pb2.SearchActionMappingPathsRequest.FromString,
|
||||
response_serializer=configuration__pb2.ActionMappingPathsResponse.SerializeToString,
|
||||
),
|
||||
}
|
||||
generic_handler = grpc.method_handlers_generic_handler(
|
||||
'configuration.ConfigurationService', rpc_method_handlers)
|
||||
server.add_generic_rpc_handlers((generic_handler,))
|
||||
|
||||
|
||||
# This class is part of an EXPERIMENTAL API.
|
||||
class ConfigurationService(object):
|
||||
"""Missing associated documentation comment in .proto file."""
|
||||
|
||||
@staticmethod
|
||||
def ReadConfiguration(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ReadConfiguration',
|
||||
configuration__pb2.ReadConfigurationRequest.SerializeToString,
|
||||
configuration__pb2.ConfigurationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ExportConfigurationJson(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ExportConfigurationJson',
|
||||
configuration__pb2.ExportJsonRequest.SerializeToString,
|
||||
configuration__pb2.JsonExportResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ModifyConfiguration(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ModifyConfiguration',
|
||||
configuration__pb2.ModifyConfigurationRequest.SerializeToString,
|
||||
configuration__pb2.ModifyConfigurationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ImportConfiguration(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ImportConfiguration',
|
||||
configuration__pb2.ImportConfigurationRequest.SerializeToString,
|
||||
configuration__pb2.ImportConfigurationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ReadActionMappings(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ReadActionMappings',
|
||||
configuration__pb2.ReadActionMappingsRequest.SerializeToString,
|
||||
configuration__pb2.ActionMappingsResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ReadSpecificMarkers(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ReadSpecificMarkers',
|
||||
configuration__pb2.ReadSpecificMarkersRequest.SerializeToString,
|
||||
configuration__pb2.SelectiveConfigResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def CreateActionMapping(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/CreateActionMapping',
|
||||
configuration__pb2.CreateActionMappingRequest.SerializeToString,
|
||||
configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def UpdateActionMapping(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/UpdateActionMapping',
|
||||
configuration__pb2.UpdateActionMappingRequest.SerializeToString,
|
||||
configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def DeleteActionMapping(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/DeleteActionMapping',
|
||||
configuration__pb2.DeleteActionMappingRequest.SerializeToString,
|
||||
configuration__pb2.ActionMappingOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def CreateServer(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/CreateServer',
|
||||
configuration__pb2.CreateServerRequest.SerializeToString,
|
||||
configuration__pb2.ServerOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def UpdateServer(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/UpdateServer',
|
||||
configuration__pb2.UpdateServerRequest.SerializeToString,
|
||||
configuration__pb2.ServerOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def DeleteServer(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/DeleteServer',
|
||||
configuration__pb2.DeleteServerRequest.SerializeToString,
|
||||
configuration__pb2.ServerOperationResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ReadConfigurationTree(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ReadConfigurationTree',
|
||||
configuration__pb2.ReadConfigurationTreeRequest.SerializeToString,
|
||||
configuration__pb2.ConfigurationTreeResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def ListRegistryNodes(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/ListRegistryNodes',
|
||||
configuration__pb2.ListRegistryNodesRequest.SerializeToString,
|
||||
configuration__pb2.RegistryNodesResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def GetRegistryNodeDetails(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/GetRegistryNodeDetails',
|
||||
configuration__pb2.GetRegistryNodeDetailsRequest.SerializeToString,
|
||||
configuration__pb2.RegistryNodeDetailsResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
|
||||
@staticmethod
|
||||
def SearchActionMappingPaths(request,
|
||||
target,
|
||||
options=(),
|
||||
channel_credentials=None,
|
||||
call_credentials=None,
|
||||
insecure=False,
|
||||
compression=None,
|
||||
wait_for_ready=None,
|
||||
timeout=None,
|
||||
metadata=None):
|
||||
return grpc.experimental.unary_unary(request, target, '/configuration.ConfigurationService/SearchActionMappingPaths',
|
||||
configuration__pb2.SearchActionMappingPathsRequest.SerializeToString,
|
||||
configuration__pb2.ActionMappingPathsResponse.FromString,
|
||||
options, channel_credentials,
|
||||
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
|
||||
44
src/api/protos/crossswitch_pb2.py
Normal file
44
src/api/protos/crossswitch_pb2.py
Normal file
@@ -0,0 +1,44 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: crossswitch.proto
|
||||
# Protobuf Python Version: 4.25.0
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from protos import common_pb2 as common__pb2
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x11\x63rossswitch.proto\x12\x0fgeviscopebridge\x1a\x0c\x63ommon.proto\"I\n\x12\x43rossSwitchRequest\x12\x11\n\tcamera_id\x18\x01 \x01(\x05\x12\x12\n\nmonitor_id\x18\x02 \x01(\x05\x12\x0c\n\x04mode\x18\x03 \x01(\x05\"\x8f\x01\n\x13\x43rossSwitchResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\x11\n\tcamera_id\x18\x03 \x01(\x05\x12\x12\n\nmonitor_id\x18\x04 \x01(\x05\x12/\n\x0b\x65xecuted_at\x18\x05 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp\")\n\x13\x43learMonitorRequest\x12\x12\n\nmonitor_id\x18\x01 \x01(\x05\"}\n\x14\x43learMonitorResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\x12\x12\n\nmonitor_id\x18\x03 \x01(\x05\x12/\n\x0b\x65xecuted_at\x18\x04 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp\"\x18\n\x16GetRoutingStateRequest\"\x8d\x01\n\x17GetRoutingStateResponse\x12*\n\x06routes\x18\x01 \x03(\x0b\x32\x1a.geviscopebridge.RouteInfo\x12\x14\n\x0ctotal_routes\x18\x02 \x01(\x05\x12\x30\n\x0cretrieved_at\x18\x03 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp\"\x8c\x01\n\tRouteInfo\x12\x11\n\tcamera_id\x18\x01 \x01(\x05\x12\x12\n\nmonitor_id\x18\x02 \x01(\x05\x12\x13\n\x0b\x63\x61mera_name\x18\x03 \x01(\t\x12\x14\n\x0cmonitor_name\x18\x04 \x01(\t\x12-\n\trouted_at\x18\x05 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp\"\x86\x01\n\x13HealthCheckResponse\x12\x12\n\nis_healthy\x18\x01 \x01(\x08\x12\x12\n\nsdk_status\x18\x02 \x01(\t\x12\x17\n\x0fgeviserver_host\x18\x03 \x01(\t\x12.\n\nchecked_at\x18\x04 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp2\x85\x03\n\x12\x43rossSwitchService\x12_\n\x12\x45xecuteCrossSwitch\x12#.geviscopebridge.CrossSwitchRequest\x1a$.geviscopebridge.CrossSwitchResponse\x12[\n\x0c\x43learMonitor\x12$.geviscopebridge.ClearMonitorRequest\x1a%.geviscopebridge.ClearMonitorResponse\x12\x64\n\x0fGetRoutingState\x12\'.geviscopebridge.GetRoutingStateRequest\x1a(.geviscopebridge.GetRoutingStateResponse\x12K\n\x0bHealthCheck\x12\x16.geviscopebridge.Empty\x1a$.geviscopebridge.HealthCheckResponseB\x19\xaa\x02\x16GeViScopeBridge.Protosb\x06proto3')
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'crossswitch_pb2', _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals['DESCRIPTOR']._options = None
|
||||
_globals['DESCRIPTOR']._serialized_options = b'\252\002\026GeViScopeBridge.Protos'
|
||||
_globals['_CROSSSWITCHREQUEST']._serialized_start=52
|
||||
_globals['_CROSSSWITCHREQUEST']._serialized_end=125
|
||||
_globals['_CROSSSWITCHRESPONSE']._serialized_start=128
|
||||
_globals['_CROSSSWITCHRESPONSE']._serialized_end=271
|
||||
_globals['_CLEARMONITORREQUEST']._serialized_start=273
|
||||
_globals['_CLEARMONITORREQUEST']._serialized_end=314
|
||||
_globals['_CLEARMONITORRESPONSE']._serialized_start=316
|
||||
_globals['_CLEARMONITORRESPONSE']._serialized_end=441
|
||||
_globals['_GETROUTINGSTATEREQUEST']._serialized_start=443
|
||||
_globals['_GETROUTINGSTATEREQUEST']._serialized_end=467
|
||||
_globals['_GETROUTINGSTATERESPONSE']._serialized_start=470
|
||||
_globals['_GETROUTINGSTATERESPONSE']._serialized_end=611
|
||||
_globals['_ROUTEINFO']._serialized_start=614
|
||||
_globals['_ROUTEINFO']._serialized_end=754
|
||||
_globals['_HEALTHCHECKRESPONSE']._serialized_start=757
|
||||
_globals['_HEALTHCHECKRESPONSE']._serialized_end=891
|
||||
_globals['_CROSSSWITCHSERVICE']._serialized_start=894
|
||||
_globals['_CROSSSWITCHSERVICE']._serialized_end=1283
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
0
src/api/protos/crossswitch_pb2_grpc.py
Normal file
0
src/api/protos/crossswitch_pb2_grpc.py
Normal file
36
src/api/protos/monitor_pb2.py
Normal file
36
src/api/protos/monitor_pb2.py
Normal file
@@ -0,0 +1,36 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: monitor.proto
|
||||
# Protobuf Python Version: 4.25.0
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from protos import common_pb2 as common__pb2
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rmonitor.proto\x12\x0fgeviscopebridge\x1a\x0c\x63ommon.proto\"\x15\n\x13ListMonitorsRequest\"[\n\x14ListMonitorsResponse\x12.\n\x08monitors\x18\x01 \x03(\x0b\x32\x1c.geviscopebridge.MonitorInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"\'\n\x11GetMonitorRequest\x12\x12\n\nmonitor_id\x18\x01 \x01(\x05\"\xac\x01\n\x0bMonitorInfo\x12\n\n\x02id\x18\x01 \x01(\x05\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x11\n\tis_active\x18\x04 \x01(\x08\x12\x19\n\x11\x63urrent_camera_id\x18\x05 \x01(\x05\x12\x0e\n\x06status\x18\x06 \x01(\t\x12\x30\n\x0clast_updated\x18\x07 \x01(\x0b\x32\x1a.geviscopebridge.Timestamp2\xbd\x01\n\x0eMonitorService\x12[\n\x0cListMonitors\x12$.geviscopebridge.ListMonitorsRequest\x1a%.geviscopebridge.ListMonitorsResponse\x12N\n\nGetMonitor\x12\".geviscopebridge.GetMonitorRequest\x1a\x1c.geviscopebridge.MonitorInfoB\x19\xaa\x02\x16GeViScopeBridge.Protosb\x06proto3')
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'monitor_pb2', _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals['DESCRIPTOR']._options = None
|
||||
_globals['DESCRIPTOR']._serialized_options = b'\252\002\026GeViScopeBridge.Protos'
|
||||
_globals['_LISTMONITORSREQUEST']._serialized_start=48
|
||||
_globals['_LISTMONITORSREQUEST']._serialized_end=69
|
||||
_globals['_LISTMONITORSRESPONSE']._serialized_start=71
|
||||
_globals['_LISTMONITORSRESPONSE']._serialized_end=162
|
||||
_globals['_GETMONITORREQUEST']._serialized_start=164
|
||||
_globals['_GETMONITORREQUEST']._serialized_end=203
|
||||
_globals['_MONITORINFO']._serialized_start=206
|
||||
_globals['_MONITORINFO']._serialized_end=378
|
||||
_globals['_MONITORSERVICE']._serialized_start=381
|
||||
_globals['_MONITORSERVICE']._serialized_end=570
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
0
src/api/protos/monitor_pb2_grpc.py
Normal file
0
src/api/protos/monitor_pb2_grpc.py
Normal file
460
src/api/routers/configuration.py
Normal file
460
src/api/routers/configuration.py
Normal file
@@ -0,0 +1,460 @@
|
||||
"""
|
||||
Configuration router for GeViSoft configuration management
|
||||
Streamlined for external app integration
|
||||
"""
|
||||
from fastapi import APIRouter, Depends, status, HTTPException
|
||||
from fastapi.responses import JSONResponse
|
||||
import structlog
|
||||
|
||||
from schemas.action_mapping_config import (
|
||||
ActionMappingResponse,
|
||||
ActionMappingListResponse,
|
||||
ActionMappingCreate,
|
||||
ActionMappingUpdate,
|
||||
ActionMappingOperationResponse
|
||||
)
|
||||
from services.configuration_service import ConfigurationService
|
||||
from middleware.auth_middleware import require_administrator, require_viewer
|
||||
from models.user import User
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
router = APIRouter(
|
||||
prefix="/api/v1/configuration",
|
||||
tags=["configuration"]
|
||||
)
|
||||
|
||||
|
||||
# ============ CONFIGURATION TREE NAVIGATION ============
|
||||
|
||||
@router.get(
|
||||
"",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Get configuration tree (root level)",
|
||||
description="Get root-level folders - fast overview"
|
||||
)
|
||||
async def read_configuration_tree_root(
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""Get root-level configuration folders (MappingRules, GeViGCoreServer, Users, etc.)"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.read_configuration_as_tree(max_depth=1)
|
||||
return JSONResponse(content=result, status_code=status.HTTP_200_OK)
|
||||
except Exception as e:
|
||||
logger.error("read_configuration_tree_root_error", error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to read configuration tree: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.get(
|
||||
"/path",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Get specific configuration folder",
|
||||
description="Get a specific folder (e.g., MappingRules, Users)"
|
||||
)
|
||||
async def read_configuration_path(
|
||||
path: str,
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""
|
||||
Get specific configuration folder
|
||||
|
||||
Examples:
|
||||
- ?path=MappingRules - Get all action mappings
|
||||
- ?path=GeViGCoreServer - Get all G-core servers
|
||||
- ?path=Users - Get all users
|
||||
"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.read_configuration_path(path)
|
||||
return JSONResponse(content=result, status_code=status.HTTP_200_OK)
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
|
||||
except Exception as e:
|
||||
logger.error("read_configuration_path_error", path=path, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to read configuration path: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
# ============ ACTION MAPPINGS CRUD ============
|
||||
|
||||
@router.get(
|
||||
"/action-mappings",
|
||||
response_model=ActionMappingListResponse,
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="List all action mappings",
|
||||
description="Get all action mappings with input/output actions"
|
||||
)
|
||||
async def list_action_mappings(
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""List all action mappings"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.read_action_mappings()
|
||||
|
||||
if not result["success"]:
|
||||
raise ValueError(result.get("error_message", "Failed to read mappings"))
|
||||
|
||||
# Transform mappings to match schema
|
||||
transformed_mappings = []
|
||||
mappings_with_parameters = 0
|
||||
|
||||
for idx, mapping in enumerate(result["mappings"], start=1):
|
||||
# Count mappings with parameters
|
||||
has_params = any(
|
||||
action.get("parameters") and len(action["parameters"]) > 0
|
||||
for action in mapping.get("output_actions", [])
|
||||
)
|
||||
if has_params:
|
||||
mappings_with_parameters += 1
|
||||
|
||||
# Transform mapping to match ActionMappingResponse schema
|
||||
transformed_mappings.append({
|
||||
"id": idx,
|
||||
"offset": mapping.get("start_offset", 0),
|
||||
"name": mapping.get("name"),
|
||||
"input_actions": mapping.get("input_actions", []),
|
||||
"output_actions": mapping.get("output_actions", [])
|
||||
})
|
||||
|
||||
return {
|
||||
"total_mappings": result["total_count"],
|
||||
"mappings_with_parameters": mappings_with_parameters,
|
||||
"mappings": transformed_mappings
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error("list_action_mappings_error", error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to list action mappings: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.get(
|
||||
"/action-mappings/{mapping_id}",
|
||||
response_model=ActionMappingResponse,
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Get single action mapping",
|
||||
description="Get details of a specific action mapping by ID"
|
||||
)
|
||||
async def get_action_mapping(
|
||||
mapping_id: int,
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""Get single action mapping by ID (1-based)"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.read_action_mappings()
|
||||
|
||||
if not result["success"]:
|
||||
raise ValueError(result.get("error_message"))
|
||||
|
||||
mappings = result.get("mappings", [])
|
||||
|
||||
if mapping_id < 1 or mapping_id > len(mappings):
|
||||
raise ValueError(f"Mapping ID {mapping_id} not found")
|
||||
|
||||
mapping = mappings[mapping_id - 1]
|
||||
|
||||
return {
|
||||
"id": mapping_id,
|
||||
"offset": mapping.get("start_offset", 0),
|
||||
"name": mapping.get("name"),
|
||||
"input_actions": mapping.get("input_actions", []),
|
||||
"output_actions": mapping.get("output_actions", [])
|
||||
}
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
|
||||
except Exception as e:
|
||||
logger.error("get_action_mapping_error", mapping_id=mapping_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to get action mapping: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.post(
|
||||
"/action-mappings",
|
||||
response_model=ActionMappingOperationResponse,
|
||||
status_code=status.HTTP_201_CREATED,
|
||||
summary="Create action mapping",
|
||||
description="Create a new action mapping"
|
||||
)
|
||||
async def create_action_mapping(
|
||||
mapping_data: ActionMappingCreate,
|
||||
current_user: User = Depends(require_administrator)
|
||||
):
|
||||
"""Create new action mapping"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.create_action_mapping({
|
||||
"name": mapping_data.name,
|
||||
"output_actions": [
|
||||
{"action": action.action, "parameters": {}}
|
||||
for action in mapping_data.output_actions
|
||||
]
|
||||
})
|
||||
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.error("create_action_mapping_error", error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to create action mapping: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.put(
|
||||
"/action-mappings/{mapping_id}",
|
||||
response_model=ActionMappingOperationResponse,
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Update action mapping",
|
||||
description="Update an existing action mapping"
|
||||
)
|
||||
async def update_action_mapping(
|
||||
mapping_id: int,
|
||||
mapping_data: ActionMappingUpdate,
|
||||
current_user: User = Depends(require_administrator)
|
||||
):
|
||||
"""Update existing action mapping"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.update_action_mapping(mapping_id, {
|
||||
"name": mapping_data.name,
|
||||
"output_actions": [
|
||||
{"action": action.action, "parameters": {}}
|
||||
for action in mapping_data.output_actions
|
||||
] if mapping_data.output_actions else None
|
||||
})
|
||||
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.error("update_action_mapping_error", mapping_id=mapping_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to update action mapping: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.delete(
|
||||
"/action-mappings/{mapping_id}",
|
||||
response_model=ActionMappingOperationResponse,
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Delete action mapping",
|
||||
description="Delete an action mapping"
|
||||
)
|
||||
async def delete_action_mapping(
|
||||
mapping_id: int,
|
||||
current_user: User = Depends(require_administrator)
|
||||
):
|
||||
"""Delete action mapping"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.delete_action_mapping(mapping_id)
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.error("delete_action_mapping_error", mapping_id=mapping_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to delete action mapping: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
# ============ SERVER CONFIGURATION (G-CORE & GSC) ============
|
||||
|
||||
@router.get(
|
||||
"/servers",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="List all servers",
|
||||
description="Get all G-core servers from GeViGCoreServer folder"
|
||||
)
|
||||
async def list_servers(
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""List all G-core servers"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
# Get GeViGCoreServer folder
|
||||
gcore_folder = await service.read_configuration_path("GeViGCoreServer")
|
||||
|
||||
servers = []
|
||||
if gcore_folder.get("type") == "folder" and "children" in gcore_folder:
|
||||
for child in gcore_folder["children"]:
|
||||
if child.get("type") != "folder":
|
||||
continue
|
||||
|
||||
# Extract server details
|
||||
server_id = child.get("name")
|
||||
children_dict = {c.get("name"): c for c in child.get("children", [])}
|
||||
|
||||
server = {
|
||||
"id": server_id,
|
||||
"alias": children_dict.get("Alias", {}).get("value", ""),
|
||||
"host": children_dict.get("Host", {}).get("value", ""),
|
||||
"user": children_dict.get("User", {}).get("value", ""),
|
||||
"password": children_dict.get("Password", {}).get("value", ""),
|
||||
"enabled": bool(children_dict.get("Enabled", {}).get("value", 0)),
|
||||
"deactivateEcho": bool(children_dict.get("DeactivateEcho", {}).get("value", 0)),
|
||||
"deactivateLiveCheck": bool(children_dict.get("DeactivateLiveCheck", {}).get("value", 0))
|
||||
}
|
||||
servers.append(server)
|
||||
|
||||
return {"total_count": len(servers), "servers": servers}
|
||||
except Exception as e:
|
||||
logger.error("list_servers_error", error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to list servers: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.get(
|
||||
"/servers/{server_id}",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Get single server",
|
||||
description="Get details of a specific G-core server by ID"
|
||||
)
|
||||
async def get_server(
|
||||
server_id: str,
|
||||
current_user: User = Depends(require_viewer)
|
||||
):
|
||||
"""Get single G-core server by ID"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
gcore_folder = await service.read_configuration_path("GeViGCoreServer")
|
||||
|
||||
if gcore_folder.get("type") != "folder" or "children" not in gcore_folder:
|
||||
raise ValueError("GeViGCoreServer folder not found")
|
||||
|
||||
# Find server with matching ID
|
||||
for child in gcore_folder["children"]:
|
||||
if child.get("type") == "folder" and child.get("name") == server_id:
|
||||
children_dict = {c.get("name"): c for c in child.get("children", [])}
|
||||
|
||||
server = {
|
||||
"id": server_id,
|
||||
"alias": children_dict.get("Alias", {}).get("value", ""),
|
||||
"host": children_dict.get("Host", {}).get("value", ""),
|
||||
"user": children_dict.get("User", {}).get("value", ""),
|
||||
"password": children_dict.get("Password", {}).get("value", ""),
|
||||
"enabled": bool(children_dict.get("Enabled", {}).get("value", 0)),
|
||||
"deactivateEcho": bool(children_dict.get("DeactivateEcho", {}).get("value", 0)),
|
||||
"deactivateLiveCheck": bool(children_dict.get("DeactivateLiveCheck", {}).get("value", 0))
|
||||
}
|
||||
return server
|
||||
|
||||
raise ValueError(f"Server '{server_id}' not found")
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
|
||||
except Exception as e:
|
||||
logger.error("get_server_error", server_id=server_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to get server: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.post(
|
||||
"/servers",
|
||||
status_code=status.HTTP_201_CREATED,
|
||||
summary="Create server",
|
||||
description="Create a new G-core server"
|
||||
)
|
||||
async def create_server(
|
||||
server_data: dict
|
||||
# current_user: User = Depends(require_administrator) # Temporarily disabled for testing
|
||||
):
|
||||
"""
|
||||
Create new G-core server
|
||||
|
||||
Request body:
|
||||
{
|
||||
"id": "server-name",
|
||||
"alias": "My Server",
|
||||
"host": "192.168.1.100",
|
||||
"user": "admin",
|
||||
"password": "password",
|
||||
"enabled": true,
|
||||
"deactivateEcho": false,
|
||||
"deactivateLiveCheck": false
|
||||
}
|
||||
"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.create_server(server_data)
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.error("create_server_error", error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to create server: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.put(
|
||||
"/servers/{server_id}",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Update server",
|
||||
description="Update an existing G-core server"
|
||||
)
|
||||
async def update_server(
|
||||
server_id: str,
|
||||
server_data: dict,
|
||||
current_user: User = Depends(require_administrator)
|
||||
):
|
||||
"""Update existing G-core server"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.update_server(server_id, server_data)
|
||||
return result
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
|
||||
except Exception as e:
|
||||
logger.error("update_server_error", server_id=server_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to update server: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@router.delete(
|
||||
"/servers/{server_id}",
|
||||
status_code=status.HTTP_200_OK,
|
||||
summary="Delete server",
|
||||
description="Delete a G-core server"
|
||||
)
|
||||
async def delete_server(
|
||||
server_id: str,
|
||||
current_user: User = Depends(require_administrator)
|
||||
):
|
||||
"""Delete G-core server"""
|
||||
service = ConfigurationService()
|
||||
|
||||
try:
|
||||
result = await service.delete_server(server_id)
|
||||
return result
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
|
||||
except Exception as e:
|
||||
logger.error("delete_server_error", server_id=server_id, error=str(e))
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
detail=f"Failed to delete server: {str(e)}"
|
||||
)
|
||||
647
src/api/services/configuration_service.py
Normal file
647
src/api/services/configuration_service.py
Normal file
@@ -0,0 +1,647 @@
|
||||
"""
|
||||
Configuration service for managing GeViSoft configuration
|
||||
"""
|
||||
from typing import Dict, Any
|
||||
import structlog
|
||||
|
||||
from clients.sdk_bridge_client import sdk_bridge_client
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
|
||||
class ConfigurationService:
|
||||
"""Service for configuration operations"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize configuration service"""
|
||||
pass
|
||||
|
||||
async def read_configuration(self) -> Dict[str, Any]:
|
||||
"""
|
||||
Read and parse complete configuration from GeViServer
|
||||
|
||||
Returns:
|
||||
Dictionary with configuration data and statistics
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_reading_config")
|
||||
result = await sdk_bridge_client.read_configuration()
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_read_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration read failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_read_success",
|
||||
total_nodes=result["statistics"]["total_nodes"],
|
||||
file_size=result["file_size"])
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_read_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def export_configuration_json(self) -> Dict[str, Any]:
|
||||
"""
|
||||
Export complete configuration as JSON
|
||||
|
||||
Returns:
|
||||
Dictionary with JSON data and size
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_exporting_json")
|
||||
result = await sdk_bridge_client.export_configuration_json()
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_export_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration export failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_export_success", json_size=result["json_size"])
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_export_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def modify_configuration(self, modifications: list) -> Dict[str, Any]:
|
||||
"""
|
||||
Modify configuration values and write back to server
|
||||
|
||||
Args:
|
||||
modifications: List of modifications to apply
|
||||
|
||||
Returns:
|
||||
Dictionary with success status and count of modifications applied
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_modifying",
|
||||
modification_count=len(modifications))
|
||||
|
||||
result = await sdk_bridge_client.modify_configuration(modifications)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_modify_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration modification failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_modify_success",
|
||||
modifications_applied=result["modifications_applied"])
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_modify_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def import_configuration(self, json_data: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Import complete configuration from JSON and write to GeViServer
|
||||
|
||||
Args:
|
||||
json_data: Complete configuration as JSON string
|
||||
|
||||
Returns:
|
||||
Dictionary with success status, bytes written, and nodes imported
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_importing",
|
||||
json_size=len(json_data))
|
||||
|
||||
result = await sdk_bridge_client.import_configuration(json_data)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_import_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration import failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_import_success",
|
||||
bytes_written=result["bytes_written"],
|
||||
nodes_imported=result["nodes_imported"])
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_import_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def read_action_mappings(self) -> Dict[str, Any]:
|
||||
"""
|
||||
Read ONLY action mappings (Rules markers) from GeViServer
|
||||
Much faster than full configuration export
|
||||
|
||||
Returns:
|
||||
Dictionary with action mappings list and count
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_reading_action_mappings")
|
||||
result = await sdk_bridge_client.read_action_mappings()
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("action_mappings_read_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Action mappings read failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("action_mappings_read_success",
|
||||
total_count=result["total_count"],
|
||||
total_actions=sum(len(m["actions"]) for m in result["mappings"]))
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_read_action_mappings_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def read_specific_markers(self, marker_names: list) -> Dict[str, Any]:
|
||||
"""
|
||||
Read specific configuration markers by name
|
||||
|
||||
Args:
|
||||
marker_names: List of marker names to extract (e.g., ["Rules", "Camera"])
|
||||
|
||||
Returns:
|
||||
Dictionary with extracted nodes and statistics
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_reading_specific_markers",
|
||||
markers=marker_names)
|
||||
result = await sdk_bridge_client.read_specific_markers(marker_names)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("specific_markers_read_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Specific markers read failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("specific_markers_read_success",
|
||||
markers_found=result["markers_found"])
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_read_specific_markers_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def create_action_mapping(self, mapping_data: dict) -> Dict[str, Any]:
|
||||
"""
|
||||
Create a new action mapping
|
||||
|
||||
Args:
|
||||
mapping_data: Dictionary with name, input_actions, output_actions
|
||||
|
||||
Returns:
|
||||
Dictionary with success status and created mapping
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_creating_action_mapping",
|
||||
name=mapping_data.get("name"))
|
||||
|
||||
result = await sdk_bridge_client.create_action_mapping(mapping_data)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("action_mapping_create_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Action mapping creation failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("action_mapping_create_success")
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_create_action_mapping_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def update_action_mapping(self, mapping_id: int, mapping_data: dict) -> Dict[str, Any]:
|
||||
"""
|
||||
Update an existing action mapping
|
||||
|
||||
Args:
|
||||
mapping_id: 1-based ID of mapping to update
|
||||
mapping_data: Dictionary with updated fields
|
||||
|
||||
Returns:
|
||||
Dictionary with success status and updated mapping
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_updating_action_mapping",
|
||||
mapping_id=mapping_id)
|
||||
|
||||
result = await sdk_bridge_client.update_action_mapping(mapping_id, mapping_data)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("action_mapping_update_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Action mapping update failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("action_mapping_update_success", mapping_id=mapping_id)
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_update_action_mapping_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def delete_action_mapping(self, mapping_id: int) -> Dict[str, Any]:
|
||||
"""
|
||||
Delete an action mapping by ID
|
||||
|
||||
Args:
|
||||
mapping_id: 1-based ID of mapping to delete
|
||||
|
||||
Returns:
|
||||
Dictionary with success status and message
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_deleting_action_mapping",
|
||||
mapping_id=mapping_id)
|
||||
|
||||
result = await sdk_bridge_client.delete_action_mapping(mapping_id)
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("action_mapping_delete_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Action mapping deletion failed: {result.get('error_message')}")
|
||||
|
||||
logger.info("action_mapping_delete_success", mapping_id=mapping_id)
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_delete_action_mapping_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def read_configuration_as_tree(self, max_depth: int = None) -> Dict[str, Any]:
|
||||
"""
|
||||
Read configuration as hierarchical folder tree
|
||||
|
||||
Args:
|
||||
max_depth: Maximum depth to traverse (None = unlimited, 1 = root level only)
|
||||
|
||||
Returns:
|
||||
Dictionary with tree structure
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_reading_tree", max_depth=max_depth)
|
||||
result = await sdk_bridge_client.read_configuration_tree()
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_tree_read_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration tree read failed: {result.get('error_message')}")
|
||||
|
||||
tree = result["tree"]
|
||||
|
||||
# Apply depth limit if specified
|
||||
if max_depth is not None:
|
||||
tree = self._limit_tree_depth(tree, max_depth)
|
||||
|
||||
logger.info("configuration_tree_read_success",
|
||||
total_nodes=result["total_nodes"],
|
||||
max_depth=max_depth)
|
||||
|
||||
return tree
|
||||
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_read_tree_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def read_configuration_path(self, path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Read a specific folder from configuration tree
|
||||
|
||||
Args:
|
||||
path: Path to folder (e.g., "MappingRules" or "MappingRules/1")
|
||||
|
||||
Returns:
|
||||
Dictionary with subtree
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_reading_path", path=path)
|
||||
result = await sdk_bridge_client.read_configuration_tree()
|
||||
|
||||
if not result["success"]:
|
||||
logger.error("configuration_tree_read_failed", error=result.get("error_message"))
|
||||
raise ValueError(f"Configuration tree read failed: {result.get('error_message')}")
|
||||
|
||||
tree = result["tree"]
|
||||
|
||||
# Navigate to requested path
|
||||
path_parts = path.split("/")
|
||||
current = tree
|
||||
|
||||
for part in path_parts:
|
||||
if not part: # Skip empty parts
|
||||
continue
|
||||
|
||||
# Find child with matching name
|
||||
if current.get("type") != "folder" or "children" not in current:
|
||||
raise ValueError(f"Path '{path}' not found: '{part}' is not a folder")
|
||||
|
||||
found = None
|
||||
for child in current["children"]:
|
||||
if child.get("name") == part:
|
||||
found = child
|
||||
break
|
||||
|
||||
if found is None:
|
||||
raise ValueError(f"Path '{path}' not found: folder '{part}' does not exist")
|
||||
|
||||
current = found
|
||||
|
||||
logger.info("configuration_path_read_success", path=path)
|
||||
return current
|
||||
|
||||
except ValueError:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_read_path_failed", path=path, error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
def _limit_tree_depth(self, node: Dict[str, Any], max_depth: int, current_depth: int = 0) -> Dict[str, Any]:
|
||||
"""
|
||||
Limit tree depth by removing children beyond max_depth
|
||||
|
||||
Args:
|
||||
node: Tree node
|
||||
max_depth: Maximum depth
|
||||
current_depth: Current depth (internal)
|
||||
|
||||
Returns:
|
||||
Tree node with limited depth
|
||||
"""
|
||||
if current_depth >= max_depth:
|
||||
# At max depth - remove children
|
||||
limited = {k: v for k, v in node.items() if k != "children"}
|
||||
return limited
|
||||
|
||||
# Not at max depth yet - recurse into children
|
||||
result = node.copy()
|
||||
if "children" in node and node.get("type") == "folder":
|
||||
result["children"] = [
|
||||
self._limit_tree_depth(child, max_depth, current_depth + 1)
|
||||
for child in node["children"]
|
||||
]
|
||||
|
||||
return result
|
||||
|
||||
async def create_server(self, server_data: dict) -> dict:
|
||||
"""
|
||||
Create a new G-core server and persist to GeViServer
|
||||
|
||||
Args:
|
||||
server_data: Dictionary with server configuration (id, alias, host, user, password, enabled, etc.)
|
||||
|
||||
Returns:
|
||||
Dictionary with success status and created server
|
||||
"""
|
||||
try:
|
||||
server_id = server_data.get("id")
|
||||
if not server_id:
|
||||
raise ValueError("Server ID is required")
|
||||
|
||||
logger.info("configuration_service_creating_server", server_id=server_id)
|
||||
|
||||
# Read current tree
|
||||
tree_result = await sdk_bridge_client.read_configuration_tree()
|
||||
if not tree_result["success"]:
|
||||
raise ValueError(f"Failed to read configuration tree: {tree_result.get('error_message')}")
|
||||
|
||||
tree = tree_result["tree"]
|
||||
|
||||
# Find GeViGCoreServer folder
|
||||
gcore_folder = self._find_child(tree, "GeViGCoreServer")
|
||||
if not gcore_folder:
|
||||
raise ValueError("GeViGCoreServer folder not found in configuration")
|
||||
|
||||
# Check if server already exists
|
||||
if self._find_child(gcore_folder, server_id):
|
||||
raise ValueError(f"Server '{server_id}' already exists")
|
||||
|
||||
# Create new server folder structure
|
||||
new_server = {
|
||||
"type": "folder",
|
||||
"name": server_id,
|
||||
"children": [
|
||||
{"type": "string", "name": "Alias", "value": server_data.get("alias", "")},
|
||||
{"type": "string", "name": "Host", "value": server_data.get("host", "")},
|
||||
{"type": "string", "name": "User", "value": server_data.get("user", "")},
|
||||
{"type": "string", "name": "Password", "value": server_data.get("password", "")},
|
||||
{"type": "int32", "name": "Enabled", "value": 1 if server_data.get("enabled", True) else 0},
|
||||
{"type": "int32", "name": "DeactivateEcho", "value": 1 if server_data.get("deactivateEcho", False) else 0},
|
||||
{"type": "int32", "name": "DeactivateLiveCheck", "value": 1 if server_data.get("deactivateLiveCheck", False) else 0}
|
||||
]
|
||||
}
|
||||
|
||||
# Add server to GeViGCoreServer folder
|
||||
if "children" not in gcore_folder:
|
||||
gcore_folder["children"] = []
|
||||
gcore_folder["children"].append(new_server)
|
||||
|
||||
# Write modified tree back to GeViServer
|
||||
write_result = await sdk_bridge_client.write_configuration_tree(tree)
|
||||
|
||||
if not write_result["success"]:
|
||||
raise ValueError(f"Failed to write configuration: {write_result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_service_server_created", server_id=server_id,
|
||||
bytes_written=write_result.get("bytes_written"))
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"Server '{server_id}' created successfully",
|
||||
"server": server_data,
|
||||
"bytes_written": write_result.get("bytes_written")
|
||||
}
|
||||
|
||||
except ValueError:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_create_server_failed", error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def update_server(self, server_id: str, server_data: dict) -> dict:
|
||||
"""
|
||||
Update an existing G-core server and persist to GeViServer
|
||||
|
||||
Args:
|
||||
server_id: ID of the server to update
|
||||
server_data: Dictionary with updated server configuration
|
||||
|
||||
Returns:
|
||||
Dictionary with success status
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_updating_server", server_id=server_id)
|
||||
|
||||
# Read current tree
|
||||
tree_result = await sdk_bridge_client.read_configuration_tree()
|
||||
if not tree_result["success"]:
|
||||
raise ValueError(f"Failed to read configuration tree: {tree_result.get('error_message')}")
|
||||
|
||||
tree = tree_result["tree"]
|
||||
|
||||
# Find GeViGCoreServer folder
|
||||
gcore_folder = self._find_child(tree, "GeViGCoreServer")
|
||||
if not gcore_folder:
|
||||
raise ValueError("GeViGCoreServer folder not found in configuration")
|
||||
|
||||
# Find the server to update
|
||||
server_folder = self._find_child(gcore_folder, server_id)
|
||||
if not server_folder:
|
||||
raise ValueError(f"Server '{server_id}' not found")
|
||||
|
||||
# Update server properties
|
||||
children_dict = {c.get("name"): c for c in server_folder.get("children", [])}
|
||||
|
||||
if "alias" in server_data:
|
||||
if "Alias" in children_dict:
|
||||
children_dict["Alias"]["value"] = server_data["alias"]
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "string", "name": "Alias", "value": server_data["alias"]}
|
||||
)
|
||||
|
||||
if "host" in server_data:
|
||||
if "Host" in children_dict:
|
||||
children_dict["Host"]["value"] = server_data["host"]
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "string", "name": "Host", "value": server_data["host"]}
|
||||
)
|
||||
|
||||
if "user" in server_data:
|
||||
if "User" in children_dict:
|
||||
children_dict["User"]["value"] = server_data["user"]
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "string", "name": "User", "value": server_data["user"]}
|
||||
)
|
||||
|
||||
if "password" in server_data:
|
||||
if "Password" in children_dict:
|
||||
children_dict["Password"]["value"] = server_data["password"]
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "string", "name": "Password", "value": server_data["password"]}
|
||||
)
|
||||
|
||||
if "enabled" in server_data:
|
||||
enabled_value = 1 if server_data["enabled"] else 0
|
||||
if "Enabled" in children_dict:
|
||||
children_dict["Enabled"]["value"] = enabled_value
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "int32", "name": "Enabled", "value": enabled_value}
|
||||
)
|
||||
|
||||
if "deactivateEcho" in server_data:
|
||||
echo_value = 1 if server_data["deactivateEcho"] else 0
|
||||
if "DeactivateEcho" in children_dict:
|
||||
children_dict["DeactivateEcho"]["value"] = echo_value
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "int32", "name": "DeactivateEcho", "value": echo_value}
|
||||
)
|
||||
|
||||
if "deactivateLiveCheck" in server_data:
|
||||
livecheck_value = 1 if server_data["deactivateLiveCheck"] else 0
|
||||
if "DeactivateLiveCheck" in children_dict:
|
||||
children_dict["DeactivateLiveCheck"]["value"] = livecheck_value
|
||||
else:
|
||||
server_folder.setdefault("children", []).append(
|
||||
{"type": "int32", "name": "DeactivateLiveCheck", "value": livecheck_value}
|
||||
)
|
||||
|
||||
# Write modified tree back to GeViServer
|
||||
write_result = await sdk_bridge_client.write_configuration_tree(tree)
|
||||
|
||||
if not write_result["success"]:
|
||||
raise ValueError(f"Failed to write configuration: {write_result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_service_server_updated", server_id=server_id,
|
||||
bytes_written=write_result.get("bytes_written"))
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"Server '{server_id}' updated successfully",
|
||||
"bytes_written": write_result.get("bytes_written")
|
||||
}
|
||||
|
||||
except ValueError:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_update_server_failed", server_id=server_id, error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
async def delete_server(self, server_id: str) -> dict:
|
||||
"""
|
||||
Delete a G-core server and persist to GeViServer
|
||||
|
||||
Args:
|
||||
server_id: ID of the server to delete
|
||||
|
||||
Returns:
|
||||
Dictionary with success status
|
||||
"""
|
||||
try:
|
||||
logger.info("configuration_service_deleting_server", server_id=server_id)
|
||||
|
||||
# Read current tree
|
||||
tree_result = await sdk_bridge_client.read_configuration_tree()
|
||||
if not tree_result["success"]:
|
||||
raise ValueError(f"Failed to read configuration tree: {tree_result.get('error_message')}")
|
||||
|
||||
tree = tree_result["tree"]
|
||||
|
||||
# Find GeViGCoreServer folder
|
||||
gcore_folder = self._find_child(tree, "GeViGCoreServer")
|
||||
if not gcore_folder:
|
||||
raise ValueError("GeViGCoreServer folder not found in configuration")
|
||||
|
||||
# Find and remove the server
|
||||
if "children" not in gcore_folder:
|
||||
raise ValueError(f"Server '{server_id}' not found")
|
||||
|
||||
server_index = None
|
||||
for i, child in enumerate(gcore_folder["children"]):
|
||||
if child.get("name") == server_id and child.get("type") == "folder":
|
||||
server_index = i
|
||||
break
|
||||
|
||||
if server_index is None:
|
||||
raise ValueError(f"Server '{server_id}' not found")
|
||||
|
||||
# Remove server from children list
|
||||
gcore_folder["children"].pop(server_index)
|
||||
|
||||
# Write modified tree back to GeViServer
|
||||
write_result = await sdk_bridge_client.write_configuration_tree(tree)
|
||||
|
||||
if not write_result["success"]:
|
||||
raise ValueError(f"Failed to write configuration: {write_result.get('error_message')}")
|
||||
|
||||
logger.info("configuration_service_server_deleted", server_id=server_id,
|
||||
bytes_written=write_result.get("bytes_written"))
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"message": f"Server '{server_id}' deleted successfully",
|
||||
"bytes_written": write_result.get("bytes_written")
|
||||
}
|
||||
|
||||
except ValueError:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("configuration_service_delete_server_failed", server_id=server_id, error=str(e), exc_info=True)
|
||||
raise
|
||||
|
||||
def _find_child(self, parent: dict, child_name: str) -> dict:
|
||||
"""
|
||||
Helper method to find a child node by name
|
||||
|
||||
Args:
|
||||
parent: Parent node (folder)
|
||||
child_name: Name of child to find
|
||||
|
||||
Returns:
|
||||
Child node or None if not found
|
||||
"""
|
||||
if parent.get("type") != "folder" or "children" not in parent:
|
||||
return None
|
||||
|
||||
for child in parent["children"]:
|
||||
if child.get("name") == child_name:
|
||||
return child
|
||||
|
||||
return None
|
||||
File diff suppressed because it is too large
Load Diff
298
src/sdk-bridge/Protos/configuration.proto
Normal file
298
src/sdk-bridge/Protos/configuration.proto
Normal file
@@ -0,0 +1,298 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package configuration;
|
||||
|
||||
option csharp_namespace = "GeViScopeBridge.Protos";
|
||||
|
||||
service ConfigurationService {
|
||||
// Read and parse complete configuration from GeViServer
|
||||
rpc ReadConfiguration(ReadConfigurationRequest) returns (ConfigurationResponse);
|
||||
|
||||
// Export configuration as JSON string
|
||||
rpc ExportConfigurationJson(ExportJsonRequest) returns (JsonExportResponse);
|
||||
|
||||
// Modify configuration values and write back to server
|
||||
rpc ModifyConfiguration(ModifyConfigurationRequest) returns (ModifyConfigurationResponse);
|
||||
|
||||
// Import complete configuration from JSON and write to GeViServer
|
||||
rpc ImportConfiguration(ImportConfigurationRequest) returns (ImportConfigurationResponse);
|
||||
|
||||
// SELECTIVE/TARGETED READ METHODS (Fast, lightweight)
|
||||
|
||||
// Read ONLY action mappings (Rules markers) - optimized for speed
|
||||
rpc ReadActionMappings(ReadActionMappingsRequest) returns (ActionMappingsResponse);
|
||||
|
||||
// Read specific markers by name - extensible for future config types
|
||||
rpc ReadSpecificMarkers(ReadSpecificMarkersRequest) returns (SelectiveConfigResponse);
|
||||
|
||||
// ACTION MAPPING WRITE METHODS
|
||||
|
||||
// Create a new action mapping
|
||||
rpc CreateActionMapping(CreateActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// Update an existing action mapping by ID
|
||||
rpc UpdateActionMapping(UpdateActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// Delete an action mapping by ID
|
||||
rpc DeleteActionMapping(DeleteActionMappingRequest) returns (ActionMappingOperationResponse);
|
||||
|
||||
// SERVER CONFIGURATION WRITE METHODS (G-CORE SERVERS)
|
||||
|
||||
// Create a new G-core server
|
||||
rpc CreateServer(CreateServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// Update an existing G-core server
|
||||
rpc UpdateServer(UpdateServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// Delete a G-core server
|
||||
rpc DeleteServer(DeleteServerRequest) returns (ServerOperationResponse);
|
||||
|
||||
// TREE FORMAT (RECOMMENDED)
|
||||
|
||||
// Read configuration as hierarchical folder tree - much more readable than flat format
|
||||
rpc ReadConfigurationTree(ReadConfigurationTreeRequest) returns (ConfigurationTreeResponse);
|
||||
|
||||
// REGISTRY EXPLORATION METHODS
|
||||
|
||||
// List top-level registry nodes
|
||||
rpc ListRegistryNodes(ListRegistryNodesRequest) returns (RegistryNodesResponse);
|
||||
|
||||
// Get details about a specific registry node
|
||||
rpc GetRegistryNodeDetails(GetRegistryNodeDetailsRequest) returns (RegistryNodeDetailsResponse);
|
||||
|
||||
// Search for action mapping paths in registry
|
||||
rpc SearchActionMappingPaths(SearchActionMappingPathsRequest) returns (ActionMappingPathsResponse);
|
||||
}
|
||||
|
||||
message ReadConfigurationRequest {
|
||||
// Empty - uses connection from setup client
|
||||
}
|
||||
|
||||
message ConfigurationStatistics {
|
||||
int32 total_nodes = 1;
|
||||
int32 boolean_count = 2;
|
||||
int32 integer_count = 3;
|
||||
int32 string_count = 4;
|
||||
int32 property_count = 5;
|
||||
int32 marker_count = 6;
|
||||
int32 rules_section_count = 7;
|
||||
}
|
||||
|
||||
message ConfigNode {
|
||||
int32 start_offset = 1;
|
||||
int32 end_offset = 2;
|
||||
string node_type = 3; // "boolean", "integer", "string", "property", "marker"
|
||||
string name = 4;
|
||||
string value = 5; // Serialized as string
|
||||
string value_type = 6;
|
||||
}
|
||||
|
||||
message ConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 file_size = 3;
|
||||
string header = 4;
|
||||
repeated ConfigNode nodes = 5;
|
||||
ConfigurationStatistics statistics = 6;
|
||||
}
|
||||
|
||||
message ExportJsonRequest {
|
||||
// Empty - exports current configuration
|
||||
}
|
||||
|
||||
message JsonExportResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
string json_data = 3;
|
||||
int32 json_size = 4;
|
||||
}
|
||||
|
||||
message NodeModification {
|
||||
int32 start_offset = 1;
|
||||
string node_type = 2; // "boolean", "integer", "string"
|
||||
string new_value = 3; // Serialized as string
|
||||
}
|
||||
|
||||
message ModifyConfigurationRequest {
|
||||
repeated NodeModification modifications = 1;
|
||||
}
|
||||
|
||||
message ModifyConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 modifications_applied = 3;
|
||||
}
|
||||
|
||||
message ImportConfigurationRequest {
|
||||
string json_data = 1; // Complete configuration as JSON string
|
||||
}
|
||||
|
||||
message ImportConfigurationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 bytes_written = 3;
|
||||
int32 nodes_imported = 4;
|
||||
}
|
||||
|
||||
// ========== SELECTIVE READ MESSAGES ==========
|
||||
|
||||
message ReadActionMappingsRequest {
|
||||
// Empty - reads action mappings from current configuration
|
||||
}
|
||||
|
||||
message ActionParameter {
|
||||
string name = 1; // Parameter name (e.g., "VideoInput", "G-core alias")
|
||||
string value = 2; // Parameter value (e.g., "101027", "gscope-cdu-3")
|
||||
}
|
||||
|
||||
message ActionDefinition {
|
||||
string action = 1; // Action name (e.g., "CrossSwitch C_101027 -> M")
|
||||
repeated ActionParameter parameters = 2; // Named parameters
|
||||
}
|
||||
|
||||
message ConfigActionMapping {
|
||||
string name = 1; // Mapping name (e.g., "CrossSwitch C_101027 -> M")
|
||||
repeated ActionDefinition input_actions = 2; // Trigger/condition actions
|
||||
repeated ActionDefinition output_actions = 3; // Response actions
|
||||
int32 start_offset = 4;
|
||||
int32 end_offset = 5;
|
||||
|
||||
// Deprecated - kept for backward compatibility
|
||||
repeated string actions = 6; // List of action strings (old format)
|
||||
}
|
||||
|
||||
message ActionMappingsResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
repeated ConfigActionMapping mappings = 3;
|
||||
int32 total_count = 4;
|
||||
}
|
||||
|
||||
message ReadSpecificMarkersRequest {
|
||||
repeated string marker_names = 1; // Names of markers to extract (e.g., "Rules", "Camera")
|
||||
}
|
||||
|
||||
message SelectiveConfigResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
int32 file_size = 3;
|
||||
repeated string requested_markers = 4;
|
||||
repeated ConfigNode extracted_nodes = 5;
|
||||
int32 markers_found = 6;
|
||||
}
|
||||
|
||||
// ========== ACTION MAPPING WRITE MESSAGES ==========
|
||||
|
||||
message ActionMappingInput {
|
||||
string name = 1; // Mapping caption (required for GeViSet display)
|
||||
repeated ActionDefinition input_actions = 2; // Trigger actions
|
||||
repeated ActionDefinition output_actions = 3; // Response actions (required)
|
||||
int32 video_input = 4; // Video input ID (optional, but recommended for GeViSet display)
|
||||
}
|
||||
|
||||
message CreateActionMappingRequest {
|
||||
ActionMappingInput mapping = 1;
|
||||
}
|
||||
|
||||
message UpdateActionMappingRequest {
|
||||
int32 mapping_id = 1; // 1-based ID of mapping to update
|
||||
ActionMappingInput mapping = 2; // New data (fields can be partial)
|
||||
}
|
||||
|
||||
message DeleteActionMappingRequest {
|
||||
int32 mapping_id = 1; // 1-based ID of mapping to delete
|
||||
}
|
||||
|
||||
message ActionMappingOperationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
ConfigActionMapping mapping = 3; // Created/updated mapping (null for delete)
|
||||
string message = 4; // Success/info message
|
||||
}
|
||||
|
||||
// REGISTRY EXPLORATION MESSAGES
|
||||
|
||||
message ListRegistryNodesRequest {
|
||||
// Empty - lists top-level nodes
|
||||
}
|
||||
|
||||
message RegistryNodesResponse {
|
||||
bool success = 1;
|
||||
repeated string node_paths = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
message GetRegistryNodeDetailsRequest {
|
||||
string node_path = 1;
|
||||
}
|
||||
|
||||
message RegistryNodeDetailsResponse {
|
||||
bool success = 1;
|
||||
string details = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
message SearchActionMappingPathsRequest {
|
||||
// Empty - searches for action mapping related nodes
|
||||
}
|
||||
|
||||
message ActionMappingPathsResponse {
|
||||
bool success = 1;
|
||||
repeated string paths = 2;
|
||||
string error_message = 3;
|
||||
}
|
||||
|
||||
// ========== SERVER CRUD MESSAGES ==========
|
||||
|
||||
message ServerData {
|
||||
string id = 1; // Server ID (folder name in GeViGCoreServer)
|
||||
string alias = 2; // Alias (display name)
|
||||
string host = 3; // Host/IP address
|
||||
string user = 4; // Username
|
||||
string password = 5; // Password
|
||||
bool enabled = 6; // Enabled flag
|
||||
bool deactivate_echo = 7; // DeactivateEcho flag
|
||||
bool deactivate_live_check = 8; // DeactivateLiveCheck flag
|
||||
}
|
||||
|
||||
message CreateServerRequest {
|
||||
ServerData server = 1;
|
||||
}
|
||||
|
||||
message UpdateServerRequest {
|
||||
string server_id = 1; // ID of server to update
|
||||
ServerData server = 2; // New server data (fields can be partial)
|
||||
}
|
||||
|
||||
message DeleteServerRequest {
|
||||
string server_id = 1; // ID of server to delete
|
||||
}
|
||||
|
||||
message ServerOperationResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
ServerData server = 3; // Created/updated server (null for delete)
|
||||
string message = 4; // Success/info message
|
||||
int32 bytes_written = 5; // Size of configuration written
|
||||
}
|
||||
|
||||
// ========== TREE FORMAT MESSAGES ==========
|
||||
|
||||
message ReadConfigurationTreeRequest {
|
||||
// Empty - reads entire configuration as tree
|
||||
}
|
||||
|
||||
message TreeNode {
|
||||
string type = 1; // "folder", "bool", "byte", "int16", "int32", "int64", "string"
|
||||
string name = 2; // Node name
|
||||
int64 int_value = 3; // For integer/bool types
|
||||
string string_value = 4; // For string types
|
||||
repeated TreeNode children = 5; // For folders (hierarchical structure)
|
||||
}
|
||||
|
||||
message ConfigurationTreeResponse {
|
||||
bool success = 1;
|
||||
string error_message = 2;
|
||||
TreeNode root = 3; // Root folder node containing entire configuration tree
|
||||
int32 total_nodes = 4; // Total node count (all levels)
|
||||
}
|
||||
Reference in New Issue
Block a user