Hosam-Eldin.mostafa/ecu-tests
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: Hosam-Eldin.mostafa:feature/create-pytest-testing-framework
Branches Tags
Hosam-Eldin.mostafa:main
Hosam-Eldin.mostafa:feature/create-pytest-testing-framework
..
compare: Hosam-Eldin.mostafa:main
Branches Tags
Hosam-Eldin.mostafa:feature/create-pytest-testing-framework
Hosam-Eldin.mostafa:main

No commits in common. "feature/create-pytest-testing-framework" and "main" have entirely different histories.
feature/cr ... main

96 changed files with 2 additions and 26068 deletions
Show Stats Expand all files Collapse all files

12
.gitignore vendored
View File

@ -168,15 +168,3 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# --- Project specific ---
# Test run artifacts
reports/
!reports/.gitkeep
# Vendor binaries (keep headers/docs and keep .dll from the SDK for now)
vendor/**/*.lib
vendor/**/*.pdb
# Optional firmware blobs (uncomment if you don't want to track)
# firmware/

286
README.md
View File

@ -1,285 +1,3 @@
# ECU Tests Framework
# ecu-tests
Python-based ECU testing framework built on pytest, with a pluggable LIN communication layer (Mock and BabyLin), configuration via YAML, and enhanced HTML/XML reporting with rich test metadata.
## Highlights
- Mock LIN adapter for fast, hardware-free development
- Real BabyLIN adapter using the SDK's official Python wrapper (BabyLIN_library.py)
- Hex flashing scaffold you can wire to UDS
- Rich pytest fixtures and example tests
- Self-contained HTML report with Title, Requirements, Steps, and Expected Results extracted from test docstrings
- JUnit XML report for CI/CD
## Quick links
- Using the framework (common runs, markers, CI, Pi): `docs/12_using_the_framework.md`
- Plugin overview (reporting, hooks, artifacts): `docs/11_conftest_plugin_overview.md`
- Power supply (Owon) usage and troubleshooting: `docs/14_power_supply.md`
- Report properties cheatsheet (standard keys): `docs/15_report_properties_cheatsheet.md`
## TL;DR quick start (copy/paste)
Mock (no hardware):
```powershell
python -m venv .venv; .\.venv\Scripts\Activate.ps1; pip install -r requirements.txt; pytest -m "not hardware" -v
```
Hardware (BabyLIN SDK):
```powershell
# Place BabyLIN_library.py and native libs under .\vendor per vendor/README.md first
$env:ECU_TESTS_CONFIG = ".\config\babylin.example.yaml"; pytest -m "hardware and babylin" -v
```
## Quick start (Windows PowerShell)
1) Create a virtual environment and install dependencies
```powershell
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
```
2) Run the mock test suite (default interface)
```powershell
python.exe -m pytest -m "not hardware" -v
```
3) View the reports
- HTML: `reports/report.html`
- JUnit XML: `reports/junit.xml`
Tip: You can change output via `--html` and `--junitxml` CLI options.
## Reporting: Metadata in HTML
We extract these fields from each test’s docstring and render them in the HTML report:
- Title
- Description
- Requirements (e.g., REQ-001)
- Test Steps
- Expected Result
Markers like `smoke`, `hardware`, and `req_00x` are also displayed.
Example docstring format used by the plugin:
```python
"""
Title: Mock LIN Interface - Send/Receive Echo Test
Description: Validates basic send/receive functionality using the mock LIN interface with echo behavior.
Requirements: REQ-001, REQ-003
Test Steps:
1. Connect to mock interface
2. Send frame ID 0x01 with data [0x55]
3. Receive the echo within 100ms
4. Assert ID and data integrity
Expected Result:
- Echoed frame matches sent frame
"""
```
## Configuration
Default config is `config/test_config.yaml`. Override via the `ECU_TESTS_CONFIG` environment variable.
```powershell
$env:ECU_TESTS_CONFIG = (Resolve-Path .\config\test_config.yaml)
```
BabyLIN configuration template: `config/babylin.example.yaml`
```yaml
interface:
type: babylin # or "mock"
channel: 0 # Channel index used by the SDK wrapper
bitrate: 19200 # Usually determined by SDF
sdf_path: ./vendor/Example.sdf
schedule_nr: 0 # Start this schedule on connect
```
Switch to hardware profile and run only hardware tests:
```powershell
$env:ECU_TESTS_CONFIG = (Resolve-Path .\config\babylin.example.yaml)
python.exe -m pytest -m hardware -v
```
## Project structure
```
ecu_tests/
├── ecu_framework/
│ ├── config.py # YAML config loader
│ ├── power/
│ │ └── owon_psu.py # Owon PSU serial SCPI controller (library)
│ ├── lin/
│ │ ├── base.py # LinInterface + LinFrame
│ │ ├── mock.py # Mock LIN adapter
│ │ └── babylin.py # BabyLIN SDK-wrapper adapter (uses BabyLIN_library.py)
│ └── flashing/
│ └── hex_flasher.py # Hex flashing scaffold
├── tests/
│ ├── conftest.py # Shared fixtures
│ ├── test_smoke_mock.py # Mock interface smoke and boundary tests
│ ├── test_babylin_hardware_smoke.py # Hardware smoke tests
│ ├── test_babylin_hardware_schedule_smoke.py # Hardware schedule flow
│ ├── test_babylin_wrapper_mock.py # SDK adapter with mock wrapper
│ ├── plugin/
│ │ └── test_conftest_plugin_artifacts.py # Plugin self-test (reports artifacts)
│ ├── unit/
│ │ ├── test_config_loader.py # Config loader unit tests
│ │ ├── test_linframe.py # LIN frame dataclass/logic
│ │ ├── test_hex_flasher.py # Hex flasher scaffolding
│ │ └── test_babylin_adapter_mocked.py # BabyLIN adapter with mocks
│ └── hardware/
│ └── test_owon_psu.py # Owon PSU hardware test (uses central config)
├── config/
│ ├── test_config.yaml # Default config
│ ├── babylin.example.yaml # BabyLIN hardware template
│ ├── owon_psu.example.yaml # Owon PSU example (copy to owon_psu.yaml)
│ └── owon_psu.yaml # Optional machine-specific PSU config
├── vendor/ # Place SDK wrapper and platform libs here
│ ├── Owon/
│ │ └── owon_psu_quick_demo.py # Quick PSU demo using the library & YAML
│ ├── BabyLIN_library.py # Official SDK Python wrapper
│ └── BabyLIN library/ # Platform-specific binaries from SDK (DLL/.so)
├── reports/ # Generated reports
│ ├── report.html
│ └── junit.xml
├── conftest_plugin.py # HTML metadata extraction & rendering
├── pytest.ini # Markers and default addopts
├── requirements.txt
└── README.md
```
## Usage recipes
- Run everything (mock and any non-hardware tests):
```powershell
python.exe -m pytest -v
```
- Run by marker:
```powershell
python.exe -m pytest -m "smoke" -v
python.exe -m pytest -m "req_001" -v
```
- Run in parallel:
```powershell
python.exe -m pytest -n auto -v
```
- Run the plugin self-test (verifies reporting artifacts under `reports/`):
```powershell
python -m pytest tests\plugin\test_conftest_plugin_artifacts.py -q
```
- Generate separate HTML/JUnit reports for unit vs non-unit tests:
```powershell
./scripts/run_two_reports.ps1
```
## BabyLIN adapter notes
The `ecu_framework/lin/babylin.py` implementation uses the official `BabyLIN_library.py` wrapper from the SDK. Put `BabyLIN_library.py` under `vendor/` (or on `PYTHONPATH`) along with the SDK's platform-specific libraries. Configure `sdf_path` and `schedule_nr` to load an SDF and start a schedule during connect. The adapter sends frames via `BLC_mon_set_xmit` and receives via `BLC_getNextFrameTimeout`.
## Docs and references
- Guide: `TESTING_FRAMEWORK_GUIDE.md` (deep dive with examples and step-by-step flows)
- Reports: `reports/report.html` and `reports/junit.xml` (generated on each run)
- CI summary: `reports/summary.md` (machine-friendly run summary)
- Requirements coverage: `reports/requirements_coverage.json` (requirement → tests mapping)
- Tip: Open the HTML report on Windows with: `start .\reports\report.html`
- Configs: `config/test_config.yaml`, `config/babylin.example.yaml` (copy and modify for your environment)
- BabyLIN SDK placement and notes: `vendor/README.md`
- Docs index: `docs/README.md` (run sequence, config resolution, reporting, call flows)
- Raspberry Pi deployment: `docs/09_raspberry_pi_deployment.md`
- Build custom Pi image: `docs/10_build_custom_image.md`
- Pi scripts: `scripts/pi_install.sh`, `scripts/ecu-tests.service`, `scripts/ecu-tests.timer`, `scripts/run_tests.sh`
## Troubleshooting
- HTML report missing columns: ensure `pytest.ini` includes `-p conftest_plugin` in `addopts`.
- ImportError for BabyLIN_library: verify `vendor/BabyLIN_library.py` placement and that required native libraries (DLL/.so) from the SDK are available on PATH/LD_LIBRARY_PATH.
- Permission errors in PowerShell: run the venv's full Python path or adjust ExecutionPolicy for scripts.
- Import errors: activate the venv and reinstall `requirements.txt`.
## Owon Power Supply (SCPI) — library, config, tests, and quick demo
We provide a reusable pyserial-based library, a hardware test integrated with the central config,
and a minimal quick demo script.
- Library: `ecu_framework/power/owon_psu.py` (class `OwonPSU`, `SerialParams`, `scan_ports`)
- Central config: `config/test_config.yaml` (`power_supply` section)
- Optionally merge `config/owon_psu.yaml` or set `OWON_PSU_CONFIG` to a YAML path
- Hardware test: `tests/hardware/test_owon_psu.py` (skips unless `power_supply.enabled` is true)
- quick demo: `vendor/Owon/owon_psu_quick_demo.py` (reads `OWON_PSU_CONFIG` or `config/owon_psu.yaml`)
Quick setup (Windows PowerShell):
```powershell
# Ensure dependencies
pip install -r .\requirements.txt
# Option A: configure centrally in test_config.yaml
# Edit config\test_config.yaml and set:
# power_supply.enabled: true
# power_supply.port: COM4
# Option B: use a separate machine-specific YAML
copy .\config\owon_psu.example.yaml .\config\owon_psu.yaml
# edit COM port and options in .\config\owon_psu.yaml
# Run the hardware PSU test (skips if disabled or missing port)
pytest -k test_owon_psu_idn_and_optional_set -m hardware -q
# Run the quick demo script
python .\vendor\Owon\owon_psu_quick_demo.py
```
YAML keys supported by `power_supply`:
```yaml
power_supply:
enabled: true
port: COM4 # or /dev/ttyUSB0
baudrate: 115200
timeout: 1.0
eol: "\n" # or "\r\n"
parity: N # N|E|O
stopbits: 1 # 1|2
xonxoff: false
rtscts: false
dsrdtr: false
idn_substr: OWON
do_set: false
set_voltage: 5.0
set_current: 0.1
```
Troubleshooting:
- If `*IDN?` is empty, confirm port, parity/stopbits, and `eol` (try `\r\n`).
- On Windows, if COM>9, use `\\.\COM10` style in some tools; here plain `COM10` usually works.
- Ensure only one program opens the COM port at a time.
## Next steps
- Replace `HexFlasher` with a production flashing routine (UDS)
- Expand tests for end-to-end ECU workflows and requirement coverage
Automation test

359
TESTING_FRAMEWORK_GUIDE.md
View File

@ -1,359 +0,0 @@
# ECU Testing Framework - Complete Guide
## Overview
This comprehensive ECU Testing Framework provides a robust solution for testing Electronic Control Units (ECUs) using pytest with BabyLIN LIN bus communication. The framework includes detailed test documentation, enhanced reporting, mock interfaces for development, and real hardware integration capabilities.
## Framework Features
### ✅ **Complete Implementation Status**
- **✅ pytest-based testing framework** with custom plugins
- **✅ BabyLIN LIN communication integration** via the official SDK Python wrapper (`BabyLIN_library.py`)
- **✅ Mock interface for hardware-independent development**
- **✅ Enhanced HTML/XML reporting with test metadata**
- **✅ Detailed test documentation extraction**
- **✅ Configuration management with YAML**
- **✅ Hex file flashing capabilities (scaffold)**
- **✅ Custom pytest markers for requirement traceability**
## Enhanced Reporting System
### Test Metadata Integration
The framework automatically extracts detailed test information from docstrings and integrates it into reports:
**HTML Report Features:**
- **Title Column**: Clear test descriptions extracted from docstrings
- **Requirements Column**: Requirement traceability (REQ-001, REQ-002, etc.)
- **Enhanced Test Details**: Description, test steps, and expected results
- **Marker Integration**: Custom pytest markers for categorization
**Example Test Documentation Format:**
```python
@pytest.mark.smoke
@pytest.mark.req_001
def test_mock_send_receive_echo(self, mock_interface):
"""
Title: Mock LIN Interface - Send/Receive Echo Test
Description: Validates basic send/receive functionality using the mock
LIN interface with echo behavior for development testing.
Requirements: REQ-001, REQ-003
Test Steps:
1. Connect to mock LIN interface
2. Send a test frame with ID 0x01 and data [0x55]
3. Receive the echoed frame within 100ms timeout
4. Verify frame ID and data integrity
Expected Result:
- Frame should be echoed back successfully
- Received data should match sent data exactly
- Operation should complete within timeout period
"""
```
### Report Generation
**HTML Report (`reports/report.html`):**
- Interactive table with sortable columns
- Test titles and requirements clearly visible
- Execution duration and status tracking
- Enhanced metadata from docstrings
**XML Report (`reports/junit.xml`):**
- Standard JUnit XML format for CI/CD integration
- Test execution data and timing information
- Compatible with most CI systems (Jenkins, GitLab CI, etc.)
## Project Structure
```
ecu_tests/
├── ecu_framework/ # Core framework package
│ ├── config.py # YAML configuration management
│ ├── lin/ # LIN communication interfaces
│ │ ├── base.py # Abstract LinInterface definition
│ │ ├── mock.py # Mock interface for development
│ │ └── babylin.py # Real BabyLin hardware interface
│ └── flashing/ # Hex file flashing capabilities
│ └── hex_flasher.py # ECU flash programming
├── tests/ # Test suite
│ ├── conftest.py # pytest fixtures and configuration
│ ├── test_smoke_mock.py # Mock interface validation tests
│ ├── test_babylin_hardware_smoke.py # Hardware smoke tests
│ └── test_hardware_placeholder.py # Future hardware tests
├── config/ # Configuration files
│ ├── test_config.yaml # Main test configuration
│ └── babylin.example.yaml # BabyLin configuration template
├── vendor/ # BabyLIN SDK placement
| ├── BabyLIN_library.py # Official SDK Python wrapper
| └── platform libs # OS-specific native libs (DLL/.so/.dylib)
├── reports/ # Generated test reports
│ ├── report.html # Enhanced HTML report
│ └── junit.xml # JUnit XML report
├── conftest_plugin.py # Custom pytest plugin for enhanced reporting
├── pytest.ini # pytest configuration with custom markers
├── requirements.txt # Python dependencies
└── README.md # Project documentation
```
## Running Tests
### Basic Test Execution
```powershell
# Run all tests with verbose output
python -m pytest -v
# Run specific test suite
python -m pytest tests\test_smoke_mock.py -v
# Run tests with specific markers
python -m pytest -m "smoke" -v
python -m pytest -m "req_001" -v
# Run hardware tests (requires BabyLIN hardware); join with adapter marker
python -m pytest -m "hardware and babylin" -v
```
### Unit Tests (fast, no hardware)
Run only unit tests using the dedicated marker or by path:
```powershell
# By marker
python -m pytest -m unit -q
# By path
python -m pytest tests\unit -q
# Plugin self-tests (verifies reporting artifacts)
python -m pytest tests\plugin -q
```
Reports still go to `reports/` (HTML and JUnit per defaults). Open the HTML on Windows with:
```powershell
start .\reports\report.html
```
Coverage: enabled by default via pytest.ini. To disable locally:
```powershell
python -m pytest -q -o addopts=""
```
Optional HTML coverage:
```powershell
python -m pytest --cov=ecu_framework --cov-report=html -q
start .\htmlcov\index.html
```
See also: `docs/13_unit_testing_guide.md` for more details and examples.
### Report Generation
Tests automatically generate enhanced reports:
- **HTML Report**: `reports/report.html` - Interactive report with metadata
- **XML Report**: `reports/junit.xml` - CI/CD compatible format
## Configuration
### Test Configuration (`config/test_config.yaml`)
```yaml
interface:
type: mock # or babylin for hardware
timeout: 1.0
flash:
hex_file_path: firmware/ecu_firmware.hex
flash_timeout: 30.0
ecu:
name: Test ECU
lin_id_range: [0x01, 0x3F]
```
### BabyLIN Configuration (`config/babylin.example.yaml`)
```yaml
interface:
type: babylin
channel: 0 # channel index used by the SDK wrapper
bitrate: 19200 # typically set by SDF
sdf_path: ./vendor/Example.sdf
schedule_nr: 0 # schedule to start on connect
```
## Test Categories
### 1. Mock Interface Tests (`test_smoke_mock.py`)
**Purpose**: Hardware-independent development and validation
- ✅ Send/receive echo functionality
- ✅ Master request/response testing
- ✅ Timeout behavior validation
- ✅ Frame validation boundary testing
- ✅ Parameterized boundary tests for comprehensive coverage
**Status**: **7 tests passing** - Complete implementation
### 2. Hardware Smoke Tests (`test_babylin_hardware_smoke.py`)
**Purpose**: Basic BabyLIN hardware connectivity validation
- ✅ SDK wrapper import and device open
- ✅ Interface connection establishment
- ✅ Basic send/receive operations
- ✅ Error handling and cleanup
**Status**: Ready for hardware testing
### 3. Hardware Integration Tests (`test_hardware_placeholder.py`)
**Purpose**: Full ECU testing workflow with real hardware
- ECU flashing with hex files
- Communication protocol validation
- Diagnostic command testing
- Performance and stress testing
**Status**: Framework ready, awaiting ECU specifications
## Custom Pytest Markers
The framework includes custom markers for test categorization and requirement traceability:
```python
# In pytest.ini
markers =
smoke: Basic functionality tests
integration: Integration tests requiring hardware
hardware: Tests requiring physical BabyLin hardware
babylin: Tests targeting the BabyLIN SDK adapter
unit: Fast unit tests (no hardware)
boundary: Boundary condition and edge case tests
req_001: Tests validating requirement REQ-001 (LIN Interface Basic Operations)
req_002: Tests validating requirement REQ-002 (Master Request/Response)
req_003: Tests validating requirement REQ-003 (Frame Validation)
req_004: Tests validating requirement REQ-004 (Timeout Handling)
```
## BabyLIN Integration Details
### SDK Python wrapper
The framework uses the official SDK Python wrapper `BabyLIN_library.py` (placed under `vendor/`) and calls its BLC_* APIs.
Key calls in the adapter (`ecu_framework/lin/babylin.py`):
- `BLC_getBabyLinPorts`, `BLC_openPort` — discovery and open
- `BLC_loadSDF`, `BLC_getChannelHandle`, `BLC_sendCommand('start schedule N;')` — SDF + scheduling
- `BLC_mon_set_xmit` — transmit
- `BLC_getNextFrameTimeout` — receive
- `BLC_sendRawMasterRequest` — master request (length then bytes)
## Development Workflow
### 1. Development Phase
```powershell
# Use mock interface for development
python -m pytest tests\test_smoke_mock.py -v
```
### 2. Hardware Integration Phase
```powershell
# Test with real BabyLIN hardware
python -m pytest -m "hardware and babylin" -v
```
### 3. Full System Testing
```powershell
# Complete test suite including ECU flashing
python -m pytest -v
```
## Enhanced Reporting Output Example
The enhanced HTML report includes:
| Result | Test | Title | Requirements | Duration | Links |
|--------|------|-------|--------------|----------|--------|
| ✅ Passed | test_mock_send_receive_echo | Mock LIN Interface - Send/Receive Echo Test | REQ-001, REQ-003 | 1 ms | |
| ✅ Passed | test_mock_request_synthesized_response | Mock LIN Interface - Master Request Response Test | REQ-002 | 0 ms | |
| ✅ Passed | test_mock_receive_timeout_behavior | Mock LIN Interface - Receive Timeout Test | REQ-004 | 106 ms | |
## Framework Validation Results
**Current Status**: ✅ **All core features implemented and tested**
**Mock Interface Tests**: 7/7 passing (0.14s execution time)
- Send/receive operations: ✅ Working
- Timeout handling: ✅ Working
- Frame validation: ✅ Working
- Boundary testing: ✅ Working
**Enhanced Reporting**: ✅ **Fully functional**
- HTML report with metadata: ✅ Working
- XML report generation: ✅ Working
- Custom pytest plugin: ✅ Working
- Docstring metadata extraction: ✅ Working
**Configuration System**: ✅ **Complete**
- YAML configuration loading: ✅ Working
- Environment variable override: ✅ Working
- BabyLIN SDF/schedule configuration: ✅ Working
- Power supply (PSU) configuration: ✅ Working (see `config/test_config.yaml` → `power_supply`)
## Owon Power Supply (PSU) Integration
The framework includes a serial SCPI controller for Owon PSUs and a hardware test wired to the central config.
- Library: `ecu_framework/power/owon_psu.py` (pyserial)
- Config: `config/test_config.yaml` (`power_supply` section)
- Optionally merge machine-specific settings from `config/owon_psu.yaml` or env `OWON_PSU_CONFIG`
- Hardware test: `tests/hardware/test_owon_psu.py` (skips unless `power_supply.enabled` and `port` present)
- quick demo: `vendor/Owon/owon_psu_quickdemo.py`
Quick run:
```powershell
pip install -r .\requirements.txt
copy .\config\owon_psu.example.yaml .\config\owon_psu.yaml
# edit COM port in .\config\owon_psu.yaml
pytest -k test_owon_psu_idn_and_optional_set -m hardware -q
python .\vendor\Owon\owon_psu_quick_demo.py
```
Common config keys:
```yaml
power_supply:
enabled: true
port: COM4
baudrate: 115200
timeout: 1.0
eol: "\n"
parity: N
stopbits: 1
idn_substr: OWON
```
## Next Steps
1. **Hardware Testing**: Connect BabyLin hardware and validate hardware smoke tests
2. **ECU Integration**: Define ECU-specific communication protocols and diagnostic commands
3. **Hex Flashing**: Implement complete hex file flashing workflow
4. **CI/CD Integration**: Set up automated testing pipeline with generated reports
## Dependencies
```
pytest>=8.4.2
pytest-html>=4.1.1
pytest-xdist>=3.8.0
pyyaml>=6.0.2
```
This framework provides a complete, production-ready testing solution for ECU development with BabyLIN communication, featuring enhanced documentation, traceability, and reporting capabilities.

11
config/babylin.example.yaml
View File

@ -1,11 +0,0 @@
# Example configuration for BabyLIN hardware runs (SDK Python wrapper)
interface:
type: babylin
channel: 0 # Channel index (0-based) as used by the SDK
bitrate: 19200 # Usually defined by the SDF, kept for reference
node_name: ECU_TEST_NODE
sdf_path: .\vendor\Example.sdf # Path to your SDF file
schedule_nr: 0 # Schedule number to start on connect
flash:
enabled: true
hex_path: C:\\Path\\To\\firmware.hex # TODO: update

50
config/examples.yaml
View File

@ -1,50 +0,0 @@
# Examples: Mock-only and BabyLIN hardware configurations
#
# How to use (Windows PowerShell):
# # Point the framework to a specific config file
# $env:ECU_TESTS_CONFIG = ".\config\examples.yaml"
# # Run only mock tests
# pytest -m "not hardware" -v
# # Switch to the BabyLIN profile by moving it under the 'active' key or by
# # exporting a different file path containing only the desired profile.
#
# This file shows both profiles in one place; typically you'll copy the relevant
# section into its own YAML file (e.g., config/mock.yaml, config/babylin.yaml).
# --- MOCK PROFILE -----------------------------------------------------------
mock_profile:
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
hex_path:
# --- BABYLIN PROFILE --------------------------------------------------------
# Requires: vendor/BabyLIN_library.py and platform libraries placed per vendor/README.md
babylin_profile:
interface:
type: babylin
channel: 0 # SDK channel index (0-based)
bitrate: 19200 # Informational; SDF usually defines effective timing
node_name: ECU_TEST_NODE # Optional label
sdf_path: .\vendor\Example.sdf # Update to your real SDF path
schedule_nr: 0 # Start this schedule on connect
flash:
enabled: true
hex_path: C:\\Path\\To\\firmware.hex # Update as needed
# --- ACTIVE SELECTION -------------------------------------------------------
# To use one of the profiles above, copy it under the 'active' key below or
# include only that profile in a separate file. The loader expects the top-level
# keys 'interface' and 'flash' by default. For convenience, we expose a shape
# that mirrors that directly. Here is a self-contained active selection:
active:
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
hex_path:

18
config/owon_psu.example.yaml
View File

@ -1,18 +0,0 @@
# Example configuration for Owon PSU hardware test
# Copy to config/owon_psu.yaml and adjust values for your setup
port: COM4 # e.g., COM4 on Windows, /dev/ttyUSB0 on Linux
baudrate: 115200 # default 115200
timeout: 1.0 # seconds
# eol: "\n" # write/query line termination (default "\n"); use "\r\n" if required
# parity: N # N|E|O (default N)
# stopbits: 1 # 1 or 2 (default 1)
# xonxoff: false
# rtscts: false
# dsrdtr: false
# Optional assertions/behavior
# idn_substr: OWON # require this substring in *IDN?
# do_set: true # briefly set V/I and toggle output
# set_voltage: 1.0 # volts when do_set is true
# set_current: 0.1 # amps when do_set is true

18
config/owon_psu.yaml
View File

@ -1,18 +0,0 @@
# Example configuration for Owon PSU hardware test
# Copy to config/owon_psu.yaml and adjust values for your setup
port: COM4 # e.g., COM4 on Windows, /dev/ttyUSB0 on Linux
baudrate: 115200 # default 115200
timeout: 1.0 # seconds
eol: "\n" # write/query line termination (default "\n"); use "\r\n" if required
parity: N # N|E|O (default N)
stopbits: 1 # 1 or 2 (default 1)
xonxoff: false
rtscts: false
dsrdtr: false
# Optional assertions/behavior
idn_substr: OWON # require this substring in *IDN?
do_set: true # briefly set V/I and toggle output
set_voltage: 10.0 # volts when do_set is true
set_current: 0.1 # amps when do_set is true

25
config/test_config.yaml
View File

@ -1,25 +0,0 @@
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
hex_path:
# Optional: central power supply config used by hardware tests/demos
# You can also place machine-specific values in config/owon_psu.yaml or set OWON_PSU_CONFIG
power_supply:
enabled: true
# port: COM4
baudrate: 115200
timeout: 1.0
eol: "\n"
parity: N
stopbits: 1
xonxoff: false
rtscts: false
dsrdtr: false
# idn_substr: OWON
do_set: false
set_voltage: 1.0
set_current: 0.1

27
conftest.py
View File

@ -1,27 +0,0 @@
"""
Pytest configuration for this repository.
Purpose:
- Optionally register the local plugin in `conftest_plugin.py` if present.
- Avoid hard failures on environments where that file isn't available.
"""
from __future__ import annotations
import importlib
import sys
from typing import Any
def pytest_configure(config: Any) -> None:
try:
plugin = importlib.import_module("conftest_plugin")
except Exception as e:
# Soft warning only; tests can still run without the extra report features.
sys.stderr.write(f"[pytest] conftest_plugin not loaded: {e}\n")
return
# Register the plugin module so its hooks are active.
try:
config.pluginmanager.register(plugin, name="conftest_plugin")
except Exception as reg_err:
sys.stderr.write(f"[pytest] failed to register conftest_plugin: {reg_err}\n")

261
conftest_plugin.py
View File

@ -1,261 +0,0 @@
"""
Custom pytest plugin to enhance test reports with detailed metadata.
Why we need this plugin:
- Surface business-facing info (Title, Description, Requirements, Steps, Expected Result) in the HTML report for quick review.
- Map tests to requirement IDs and produce a requirements coverage JSON artifact for traceability.
- Emit a compact CI summary (summary.md) for dashboards and PR comments.
How it works (high level):
- During collection, we track all test nodeids for later "unmapped" reporting.
- During test execution, we parse the test function's docstring and markers to extract metadata and requirement IDs; we attach these as user_properties on the report.
- We add custom columns (Title, Requirements) to the HTML table.
- At the end of the run, we write two artifacts into reports/: requirements_coverage.json and summary.md.
"""
import os
import re
import json
import datetime as _dt
import pytest
# -----------------------------
# Session-scoped state for reports
# -----------------------------
# Track all collected tests (nodeids) so we can later highlight tests that had no requirement mapping.
_ALL_COLLECTED_TESTS: set[str] = set()
# Map requirement ID (e.g., REQ-001) -> set of nodeids that cover it.
_REQ_TO_TESTS: dict[str, set[str]] = {}
# Nodeids that did map to at least one requirement.
_MAPPED_TESTS: set[str] = set()
def _normalize_req_id(token: str) -> str | None:
"""Normalize requirement token to REQ-XXX form.
Accepts markers like 'req_001' or strings like 'REQ-001'.
Returns None if not a recognizable requirement. This provides a single
canonical format for coverage mapping and reporting.
"""
token = token.strip()
m1 = re.fullmatch(r"req_(\d{1,3})", token, re.IGNORECASE)
if m1:
return f"REQ-{int(m1.group(1)):03d}"
m2 = re.fullmatch(r"REQ[-_ ]?(\d{1,3})", token, re.IGNORECASE)
if m2:
return f"REQ-{int(m2.group(1)):03d}"
return None
def _extract_req_ids_from_docstring(docstring: str) -> list[str]:
"""Parse the 'Requirements:' line in the docstring and return REQ-XXX tokens.
Supports comma- or whitespace-separated tokens and normalizes them.
"""
reqs: list[str] = []
req_match = re.search(r"Requirements:\s*(.+)", docstring)
if req_match:
raw = req_match.group(1)
# split by comma or whitespace
parts = re.split(r"[\s,]+", raw)
for p in parts:
rid = _normalize_req_id(p)
if rid:
reqs.append(rid)
return list(dict.fromkeys(reqs)) # dedupe, preserve order
def pytest_configure(config):
# Ensure reports directory exists early so downstream hooks can write artifacts safely
os.makedirs("reports", exist_ok=True)
def pytest_collection_modifyitems(session, config, items):
# Track all collected tests for unmapped detection (for the final coverage JSON)
for item in items:
_ALL_COLLECTED_TESTS.add(item.nodeid)
# (Legacy makereport implementation removed in favor of the hookwrapper below.)
def pytest_html_results_table_header(cells):
"""Add custom columns to HTML report table.
Why: Make the most important context (Title and Requirements) visible at a glance
in the HTML report table without opening each test details section.
"""
cells.insert(2, '<th class="sortable" data-column-type="text">Title</th>')
cells.insert(3, '<th class="sortable" data-column-type="text">Requirements</th>')
def pytest_html_results_table_row(report, cells):
"""Add custom data to HTML report table rows.
We pull the user_properties attached during makereport and render the
Title and Requirements columns for each test row.
"""
# Get title from user properties
title = ""
requirements = ""
for prop in getattr(report, 'user_properties', []):
if prop[0] == "title":
title = prop[1]
elif prop[0] == "requirements":
requirements = prop[1]
cells.insert(2, f'<td class="col-title">{title}</td>')
cells.insert(3, f'<td class="col-requirements">{requirements}</td>')
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
"""Active hook: attach metadata to reports and build requirement coverage.
Why hook at makereport:
- We want to attach metadata to the test report object so it shows up in
the HTML and JUnit outputs via user_properties.
- We also build the requirements mapping here because we have both markers
and docstrings available on the test item.
"""
outcome = yield
report = outcome.get_result()
if call.when == "call" and hasattr(item, "function"):
# Add test metadata from docstring: parse Title, Description, Requirements,
# Test Steps, and Expected Result. Each is optional and extracted if present.
if item.function.__doc__:
docstring = item.function.__doc__.strip()
# Extract and add all metadata
metadata: dict[str, str] = {}
# Title
title_match = re.search(r"Title:\s*(.+)", docstring)
if title_match:
metadata["title"] = title_match.group(1).strip()
# Description
desc_match = re.search(r"Description:\s*(.+?)(?=\n\s*(?:Requirements|Test Steps|Expected Result))", docstring, re.DOTALL)
if desc_match:
metadata["description"] = " ".join(desc_match.group(1).strip().split())
# Requirements
req_match = re.search(r"Requirements:\s*(.+)", docstring)
if req_match:
metadata["requirements"] = req_match.group(1).strip()
# Test steps
steps_match = re.search(r"Test Steps:\s*(.+?)(?=\n\s*Expected Result)", docstring, re.DOTALL)
if steps_match:
steps = steps_match.group(1).strip()
steps_clean = re.sub(r"\n\s*\d+\.\s*", " | ", steps)
metadata["test_steps"] = steps_clean.strip(" |")
# Expected result
result_match = re.search(r"Expected Result:\s*(.+?)(?=\n\s*\"\"\"|\Z)", docstring, re.DOTALL)
if result_match:
expected = " ".join(result_match.group(1).strip().split())
metadata["expected_result"] = expected.replace("- ", "• ")
# Add all metadata as user properties (HTML plugin reads these)
if metadata:
if not hasattr(report, "user_properties"):
report.user_properties = []
for key, value in metadata.items():
report.user_properties.append((key, value))
# Build requirement coverage mapping
nodeid = item.nodeid
req_ids: set[str] = set()
# From markers: allow @pytest.mark.req_001 style to count toward coverage
for mark in item.iter_markers():
rid = _normalize_req_id(mark.name)
if rid:
req_ids.add(rid)
# From docstring line 'Requirements:'
for rid in _extract_req_ids_from_docstring(docstring):
req_ids.add(rid)
# Update global maps for coverage JSON
if req_ids:
_MAPPED_TESTS.add(nodeid)
for rid in req_ids:
bucket = _REQ_TO_TESTS.setdefault(rid, set())
bucket.add(nodeid)
def pytest_terminal_summary(terminalreporter, exitstatus):
"""Write CI-friendly summary and requirements coverage JSON.
Why we write these artifacts:
- requirements_coverage.json → Machine-readable traceability matrix for CI dashboards.
- summary.md → Quick textual summary that can be surfaced in PR checks or CI job logs.
"""
# Compute stats
stats = terminalreporter.stats
def _count(key):
return len(stats.get(key, []))
results = {
"passed": _count("passed"),
"failed": _count("failed"),
"skipped": _count("skipped"),
"error": _count("error"),
"xfailed": _count("xfailed"),
"xpassed": _count("xpassed"),
"rerun": _count("rerun"),
"total": sum(len(v) for v in stats.values()),
"collected": getattr(terminalreporter, "_numcollected", None),
}
# Prepare JSON payload for requirements coverage and quick links to artifacts
coverage = {
"generated_at": _dt.datetime.now().astimezone().isoformat(),
"results": results,
"requirements": {rid: sorted(list(nodes)) for rid, nodes in sorted(_REQ_TO_TESTS.items())},
"unmapped_tests": sorted(list(_ALL_COLLECTED_TESTS - _MAPPED_TESTS)),
"files": {
"html": "reports/report.html",
"junit": "reports/junit.xml",
"summary_md": "reports/summary.md",
},
}
# Write JSON coverage file
json_path = os.path.join("reports", "requirements_coverage.json")
try:
with open(json_path, "w", encoding="utf-8") as f:
json.dump(coverage, f, indent=2)
except Exception as e:
terminalreporter.write_line(f"[conftest_plugin] Failed to write {json_path}: {e}")
# Write Markdown summary for CI consumption
md_path = os.path.join("reports", "summary.md")
try:
lines = [
"# Test Run Summary",
"",
f"Generated: {coverage['generated_at']}",
"",
f"- Collected: {results.get('collected')}",
f"- Passed: {results['passed']}",
f"- Failed: {results['failed']}",
f"- Skipped: {results['skipped']}",
f"- Errors: {results['error']}",
f"- XFailed: {results['xfailed']}",
f"- XPassed: {results['xpassed']}",
f"- Rerun: {results['rerun']}",
"",
"## Artifacts",
"- HTML Report: ./report.html",
"- JUnit XML: ./junit.xml",
"- Requirements Coverage (JSON): ./requirements_coverage.json",
]
with open(md_path, "w", encoding="utf-8") as f:
f.write("\n".join(lines) + "\n")
except Exception as e:
terminalreporter.write_line(f"[conftest_plugin] Failed to write {md_path}: {e}")

124
docs/01_run_sequence.md
View File

@ -1,124 +0,0 @@
# Run Sequence: What Happens When You Start Tests
This document walks through the exact order of operations when you run the framework with pytest, what gets called, and where configuration/data is fetched from.
## High-level flow
1. You run pytest from PowerShell
2. pytest reads `pytest.ini` and loads configured plugins (including our custom `conftest_plugin`)
3. Test discovery collects tests under `tests/`
4. Session fixtures run:
- `config()` loads YAML configuration
- `lin()` selects and connects the LIN interface (Mock or BabyLin)
- `flash_ecu()` optionally flashes the ECU (if enabled)
5. Tests execute using fixtures and call interface methods
6. Our plugin extracts test metadata (Title, Requirements, Steps) from docstrings
7. Reports are written to `reports/report.html` and `reports/junit.xml`
## Detailed call sequence
```mermaid
sequenceDiagram
autonumber
participant U as User (PowerShell)
participant P as pytest
participant PI as pytest.ini
participant PL as conftest_plugin.py
participant T as Test Discovery (tests/*)
participant F as Fixtures (conftest.py)
participant C as Config Loader (ecu_framework/config.py)
participant PS as Power Supply (optional)
participant L as LIN Adapter (mock/BabyLIN SDK)
participant X as HexFlasher (optional)
participant R as Reports (HTML/JUnit)
U->>P: python -m pytest [args]
P->>PI: Read addopts, markers, plugins
P->>PL: Load custom plugin hooks
P->>T: Collect tests
P->>F: Init session fixtures
F->>C: load_config(workspace_root)
C-->>F: EcuTestConfig (merged dataclasses)
F->>L: Create interface (mock or BabyLIN SDK)
L-->>F: Instance ready
F->>L: connect()
alt flash.enabled and hex_path provided
F->>X: HexFlasher(lin).flash_hex(hex_path)
X-->>F: Flash result (ok/fail)
end
opt power_supply.enabled and port provided
Note over PS: owon_psu_quick_demo may open PSU via ecu_framework.power.owon_psu
end
loop for each test
P->>PL: runtest_makereport(item, call)
Note over PL: Parse docstring and attach metadata
P->>L: send()/receive()/request()
L-->>P: Frames or None (timeout)
end
P->>R: Write HTML (with metadata columns)
P->>R: Write JUnit XML
```
```text
PowerShell → python -m pytest
↓
pytest loads pytest.ini
- addopts: --junitxml, --html, --self-contained-html, -p conftest_plugin
- markers registered
↓
pytest collects tests in tests/
↓
Session fixture: config()
→ calls ecu_framework.config.load_config(workspace_root)
→ determines config file path by precedence
→ merges YAML + overrides into dataclasses (EcuTestConfig)
→ optionally merges config/owon_psu.yaml (or OWON_PSU_CONFIG) into power_supply
↓
Session fixture: lin(config)
→ chooses interface by config.interface.type
- mock → ecu_framework.lin.mock.MockBabyLinInterface(...)
- babylin → ecu_framework.lin.babylin.BabyLinInterface(...)
→ lin.connect()
↓
Optional session fixture: flash_ecu(config, lin)
→ if config.flash.enabled and hex_path set
→ ecu_framework.flashing.HexFlasher(lin).flash_hex(hex_path)
↓
Test functions execute
→ use the lin fixture to send/receive/request
↓
Reporting plugin (conftest_plugin.py)
→ pytest_runtest_makereport parses test docstring
→ attaches user_properties: title, requirements, steps, expected_result
→ pytest-html hooks add Title and Requirements columns
↓
Reports written
→ reports/report.html (HTML with metadata columns)
→ reports/junit.xml (JUnit XML for CI)
```
## Where information is fetched from
- pytest configuration: `pytest.ini`
- YAML config (default): `config/test_config.yaml`
- YAML override via env var: `ECU_TESTS_CONFIG`
- BabyLIN SDK wrapper and SDF path: `interface.sdf_path` and `interface.schedule_nr` in YAML
- Test metadata: parsed from each test’s docstring
- Markers: declared in `pytest.ini`, attached in tests via `@pytest.mark.*`
## Key components involved
- `tests/conftest.py`: defines `config`, `lin`, and `flash_ecu` fixtures
- `ecu_framework/config.py`: loads and merges configuration into dataclasses
- `ecu_framework/lin/base.py`: abstract LIN interface contract and frame shape
- `ecu_framework/lin/mock.py`: mock behavior for send/receive/request
- `ecu_framework/lin/babylin.py`: BabyLIN SDK wrapper adapter (real hardware via BabyLIN_library.py)
- `ecu_framework/flashing/hex_flasher.py`: placeholder flashing logic
- `conftest_plugin.py`: report customization and metadata extraction
## Edge cases and behavior
- If `interface.type` is `babylin` but the SDK wrapper or libraries cannot be loaded, hardware tests are skipped
- If `flash.enabled` is true but `hex_path` is missing, flashing fixture skips
- Timeouts are honored in `receive()` and `request()` implementations
- Invalid frame IDs (outside 0x00–0x3F) or data > 8 bytes will raise in `LinFrame`

124
docs/02_configuration_resolution.md
View File

@ -1,124 +0,0 @@
# Configuration Resolution: What is read and when
This document explains how configuration is loaded, merged, and provided to tests and interfaces.
## Sources and precedence
From highest to lowest precedence:
1. In-code overrides (if `load_config(..., overrides=...)` is used)
2. Environment variable `ECU_TESTS_CONFIG` (absolute/relative path to YAML)
3. `config/test_config.yaml` (if present under the workspace root)
4. Built-in defaults
## Data model (dataclasses)
- `EcuTestConfig`
- `interface: InterfaceConfig`
- `type`: `mock` or `babylin`
- `channel`: LIN channel index (0-based in SDK wrapper)
- `bitrate`: LIN bitrate (e.g., 19200); usually defined by SDF
- `sdf_path`: Path to SDF file (hardware; required for typical operation)
- `schedule_nr`: Schedule number to start on connect (hardware)
- `node_name`: Optional node identifier (informational)
- `dll_path`, `func_names`: Legacy fields from the old ctypes adapter; not used with the SDK wrapper
- `flash: FlashConfig`
- `enabled`: whether to flash before tests
- `hex_path`: path to HEX file
- `power_supply: PowerSupplyConfig`
- `enabled`: whether PSU features/tests are active
- `port`: Serial device (e.g., `COM4`, `/dev/ttyUSB0`)
- `baudrate`, `timeout`, `eol`: line settings (e.g., `"\n"` or `"\r\n"`)
- `parity`: `N|E|O`
- `stopbits`: `1` or `2`
- `xonxoff`, `rtscts`, `dsrdtr`: flow control flags
- `idn_substr`: optional substring to assert in `*IDN?`
- `do_set`, `set_voltage`, `set_current`: optional demo/test actions
## YAML examples
Minimal mock configuration (default):
```yaml
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
```
Hardware (BabyLIN SDK wrapper) configuration:
```yaml
interface:
type: babylin
channel: 0 # 0-based channel index
bitrate: 19200 # optional; typically driven by SDF
node_name: "ECU_TEST_NODE"
sdf_path: "./vendor/Example.sdf"
schedule_nr: 0
flash:
enabled: true
hex_path: "firmware/ecu_firmware.hex"
Power supply configuration (either inline or merged from a dedicated YAML):
```yaml
power_supply:
enabled: true
port: COM4 # or /dev/ttyUSB0 on Linux
baudrate: 115200
timeout: 1.0
eol: "\n" # or "\r\n" if your device requires CRLF
parity: N # N|E|O
stopbits: 1 # 1|2
xonxoff: false
rtscts: false
dsrdtr: false
idn_substr: OWON
do_set: false
set_voltage: 5.0
set_current: 0.1
```
```
## Load flow
```text
tests/conftest.py: config() fixture
→ load_config(workspace_root)
→ check env var ECU_TESTS_CONFIG
→ else check config/test_config.yaml
→ else use defaults
→ convert dicts to EcuTestConfig dataclasses
→ provide to other fixtures/tests
Additionally, if present, a dedicated PSU YAML is merged into `power_supply`:
- Environment variable `OWON_PSU_CONFIG` (path to YAML), else
- `config/owon_psu.yaml` under the workspace root
This lets you keep machine-specific serial settings separate while still having
central defaults in `config/test_config.yaml`.
```
## How tests and adapters consume config
- `lin` fixture picks `mock` or `babylin` based on `interface.type`
- Mock adapter uses `bitrate` and `channel` to simulate timing/behavior
- BabyLIN adapter (SDK wrapper) uses `sdf_path`, `schedule_nr`, `channel` to open the device, load the SDF, and start a schedule. `bitrate` is informational unless explicitly applied via commands/SDF.
- `flash_ecu` uses `flash.enabled` and `flash.hex_path`
- PSU-related tests or utilities read `config.power_supply` for serial parameters
and optional actions (IDN assertions, on/off toggle, set/measure). The reference
implementation is `ecu_framework/power/owon_psu.py`, with a hardware test in
`tests/hardware/test_owon_psu.py` and a quick demo script in `vendor/Owon/owon_psu_quick_demo.py`.
## Tips
- Keep multiple YAMLs and switch via `ECU_TESTS_CONFIG`
- Check path validity for `sdf_path` and `hex_path` before running hardware tests
- Ensure `vendor/BabyLIN_library.py` and the platform-specific libraries from the SDK are available on `PYTHONPATH`
- Use environment-specific YAML files for labs vs. CI
- For PSU, prefer `OWON_PSU_CONFIG` or `config/owon_psu.yaml` to avoid committing
local COM port settings. Central defaults can live in `config/test_config.yaml`.

109
docs/03_reporting_and_metadata.md
View File

@ -1,109 +0,0 @@
# Reporting and Metadata: How your docs show up in reports
This document describes how test documentation is extracted and rendered into the HTML report, and what appears in JUnit XML.
## What the plugin does
File: `conftest_plugin.py`
- Hooks into `pytest_runtest_makereport` to parse the test’s docstring
- Extracts the following fields:
- Title
- Description
- Requirements
- Test Steps
- Expected Result
- Attaches them as `user_properties` on the test report
- Customizes the HTML results table to include Title and Requirements columns
## Docstring format to use
```python
"""
Title: Short, human-readable test name
Description: What is this test proving and why does it matter.
Requirements: REQ-001, REQ-00X
Test Steps:
1. Describe the first step
2. Next step
3. etc.
Expected Result:
- Primary outcome
- Any additional acceptance criteria
"""
```
## What appears in reports
- HTML (`reports/report.html`):
- Title and Requirements appear as columns in the table
- Other fields are available in the report payload and can be surfaced with minor tweaks
- JUnit XML (`reports/junit.xml`):
- Standard test results and timing
- Note: By default, the XML is compact and does not include custom properties; if you need properties in XML, we can extend the plugin to emit a custom JUnit format or produce an additional JSON artifact for traceability.
Open the HTML report on Windows PowerShell:
```powershell
start .\reports\report.html
```
Related artifacts written by the plugin:
- `reports/requirements_coverage.json` — requirement → test nodeids map and unmapped tests
- `reports/summary.md` — compact pass/fail/error/skip totals, environment info
To generate separate HTML/JUnit reports for unit vs non-unit test sets, use the helper script:
```powershell
./scripts/run_two_reports.ps1
```
## Parameterized tests and metadata
When using `@pytest.mark.parametrize`, each parameter set is treated as a distinct test case with its own nodeid, e.g.:
```
tests/test_babylin_wrapper_mock.py::test_babylin_master_request_with_mock_wrapper[wrapper0-True]
tests/test_babylin_wrapper_mock.py::test_babylin_master_request_with_mock_wrapper[wrapper1-False]
```
Metadata handling:
- The docstring on the test function is parsed once per case; the same Title/Requirements are attached to each parameterized instance.
- Requirement mapping (coverage JSON) records each parameterized nodeid under the normalized requirement keys, enabling fine-grained coverage.
- In the HTML table, you will see a row per parameterized instance with identical Title/Requirements but differing nodeids (and potentially differing outcomes if parameters influence behavior).
## Markers
Declared in `pytest.ini` and used via `@pytest.mark.<name>` in tests. They also appear in the HTML payload for each test (as user properties) and can be added as a column with a small change if desired.
## Extensibility
- Add more columns to HTML by updating `pytest_html_results_table_header/row`
- Persist full metadata (steps, expected) to a JSON file after the run for audit trails
- Populate requirement coverage map by scanning markers and aggregating results
## Runtime properties (record_property) and the `rp` helper fixture
Beyond static docstrings, you can attach dynamic key/value properties during a test.
- Built-in: `record_property("key", value)` in any test
- Convenience: use the shared `rp` fixture which wraps `record_property` and also prints a short line to captured output for quick scanning.
Example usage:
```python
def test_example(rp):
rp("device", "mock")
rp("tx_id", "0x12")
rp("rx_present", True)
```
Where they show up:
- HTML report: expand a test row to see a Properties table listing all recorded key/value pairs
- Captured output: look for lines like `[prop] key=value` emitted by the `rp` helper
Suggested standardized keys across suites live in `docs/15_report_properties_cheatsheet.md`.

58
docs/04_lin_interface_call_flow.md
View File

@ -1,58 +0,0 @@
# LIN Interface Call Flow
This document explains how LIN operations flow through the abstraction for both Mock and BabyLin adapters.
## Contract (base)
File: `ecu_framework/lin/base.py`
- `connect()` / `disconnect()`
- `send(frame: LinFrame)`
- `receive(id: int | None = None, timeout: float = 1.0) -> LinFrame | None`
- `request(id: int, length: int, timeout: float = 1.0) -> LinFrame | None`
- `flush()`
`LinFrame` validates:
- ID is 0x00–0x3F (6-bit LIN ID)
- Data length ≤ 8 bytes
## Mock adapter flow
File: `ecu_framework/lin/mock.py`
- `connect()`: initialize buffers and state
- `send(frame)`: enqueues the frame and (for echo behavior) schedules it for RX
- `receive(timeout)`: waits up to timeout for a frame in RX buffer
- `request(id, length, timeout)`: synthesizes a deterministic response of the given length for predictability
- `disconnect()`: clears state
Use cases:
- Fast local dev, deterministic responses, no hardware
- Timeout and boundary behavior validation
## BabyLIN adapter flow (SDK wrapper)
File: `ecu_framework/lin/babylin.py`
- `connect()`: import SDK `BabyLIN_library.py`, discover ports, open first, optionally `BLC_loadSDF`, get channel handle, and `BLC_sendCommand("start schedule N;")`
- `send(frame)`: calls `BLC_mon_set_xmit(channelHandle, frameId, data, slotTime=0)`
- `receive(timeout)`: calls `BLC_getNextFrameTimeout(channelHandle, timeout_ms)` and converts returned `BLC_FRAME` to `LinFrame`
- `request(id, length, timeout)`: prefers `BLC_sendRawMasterRequest(channel, id, length)`; falls back to `(channel, id, bytes)`; if unavailable, sends a header and waits on `receive()`
- `disconnect()`: calls `BLC_closeAll()`
- Error handling: uses `BLC_getDetailedErrorString` (if available)
Configuration:
- `interface.sdf_path` locates the SDF to load
- `interface.schedule_nr` sets the schedule to start upon connect
- `interface.channel` selects the channel index
## Edge considerations
- Ensure the correct architecture (x86/x64) of the DLL matches Python
- Channel/bitrate must match your network configuration
- Some SDKs require initialization/scheduling steps before transmit/receive
- Time synchronization and timestamp units vary per SDK — convert as needed
Note on master requests:
- Our mock wrapper returns a deterministic byte pattern when called with the `length` signature.
- When only the bytes signature is available, zeros of the requested length are used in tests.

77
docs/05_architecture_overview.md
View File

@ -1,77 +0,0 @@
# Architecture Overview
This document provides a high-level view of the framework’s components and how they interact, plus a Mermaid diagram for quick orientation.
## Components
- Tests (pytest) — test modules and functions under `tests/`
- Fixtures — defined in `tests/conftest.py` (config, lin, flash_ecu)
- Config Loader — `ecu_framework/config.py` (YAML → dataclasses)
- LIN Abstraction — `ecu_framework/lin/base.py` (`LinInterface`, `LinFrame`)
- Mock LIN Adapter — `ecu_framework/lin/mock.py`
- BabyLIN Adapter — `ecu_framework/lin/babylin.py` (SDK wrapper → BabyLIN_library.py)
- Flasher — `ecu_framework/flashing/hex_flasher.py`
- Power Supply (PSU) control — `ecu_framework/power/owon_psu.py` (serial SCPI)
- PSU quick demo script — `vendor/Owon/owon_psu_quick_demo.py`
- Reporting Plugin — `conftest_plugin.py` (docstring → report metadata)
- Reports — `reports/report.html`, `reports/junit.xml`
## Mermaid architecture diagram
```mermaid
flowchart TB
subgraph Tests & Pytest
T[tests/*]
CF[tests/conftest.py]
PL[conftest_plugin.py]
end
subgraph Framework
CFG[ecu_framework/config.py]
BASE[ecu_framework/lin/base.py]
MOCK[ecu_framework/lin/mock.py]
BABY[ecu_framework/lin/babylin.py]
FLASH[ecu_framework/flashing/hex_flasher.py]
POWER[ecu_framework/power/owon_psu.py]
end
subgraph Artifacts
REP[reports/report.html<br/>reports/junit.xml]
YAML[config/*.yaml<br/>babylin.example.yaml<br/>test_config.yaml]
PSU_YAML[config/owon_psu.yaml<br/>OWON_PSU_CONFIG]
SDK[vendor/BabyLIN_library.py<br/>platform-specific libs]
OWON[vendor/Owon/owon_psu_quick_demo.py]
end
T --> CF
CF --> CFG
CF --> BASE
CF --> MOCK
CF --> BABY
CF --> FLASH
T --> POWER
PL --> REP
CFG --> YAML
CFG --> PSU_YAML
BABY --> SDK
T --> OWON
T --> REP
```
## Data and control flow summary
- Tests use fixtures to obtain config and a connected LIN adapter
- Config loader reads YAML (or env override), returns typed dataclasses
- LIN calls are routed through the interface abstraction to the selected adapter
- Flasher (optional) uses the same interface to program the ECU
- Power supply control (optional) uses `ecu_framework/power/owon_psu.py` and reads
`config.power_supply` (merged with `config/owon_psu.yaml` or `OWON_PSU_CONFIG` when present);
the quick demo script under `vendor/Owon/` provides a quick manual flow
- Reporting plugin parses docstrings and enriches the HTML report
## Extending the architecture
- Add new bus adapters by implementing `LinInterface`
- Add new report sinks (e.g., JSON or a DB) by extending the plugin
- Add new fixtures for diagnostics or measurement tools (Scopes, power supplies, etc.)

60
docs/06_requirement_traceability.md
View File

@ -1,60 +0,0 @@
# Requirement Traceability
This document shows how requirements map to tests via pytest markers and docstrings, plus how to visualize coverage.
## Conventions
- Requirement IDs: `REQ-xxx`
- Use markers in tests: `@pytest.mark.req_001`, `@pytest.mark.req_002`, etc.
- Include readable requirement list in the test docstring under `Requirements:`
## Example
```python
@pytest.mark.req_001
@pytest.mark.req_003
"""
Title: Mock LIN Interface - Send/Receive Echo Test
Requirements: REQ-001, REQ-003
"""
```
## Mermaid: Requirement → Tests map
Note: This is illustrative; maintain it as your suite grows.
```mermaid
flowchart LR
R1[REQ-001: LIN Basic Ops]
R2[REQ-002: Master Request/Response]
R3[REQ-003: Frame Validation]
R4[REQ-004: Timeout Handling]
T1[test_mock_send_receive_echo]
T2[test_mock_request_synthesized_response]
T3[test_mock_receive_timeout_behavior]
T4[test_mock_frame_validation_boundaries]
R1 --> T1
R3 --> T1
R2 --> T2
R4 --> T3
R1 --> T4
R3 --> T4
```
## Generating a live coverage artifact (optional)
You can extend `conftest_plugin.py` to emit a JSON file with requirement-to-test mapping at the end of a run by scanning markers and docstrings. This can fuel dashboards or CI gates.
Suggested JSON shape:
```json
{
"requirements": {
"REQ-001": ["tests/test_smoke_mock.py::TestMockLinInterface::test_mock_send_receive_echo", "..."]
},
"uncovered": ["REQ-010", "REQ-012"]
}
```

57
docs/07_flash_sequence.md
View File

@ -1,57 +0,0 @@
# Flashing Sequence (ECU Programming)
This document outlines the expected flashing workflow using the `HexFlasher` scaffold over the LIN interface and where you can plug in your production flasher (UDS).
## Overview
- Flashing is controlled by configuration (`flash.enabled`, `flash.hex_path`)
- The `flash_ecu` session fixture invokes the flasher before tests
- The flasher uses the same `LinInterface` as tests
## Mermaid sequence
```mermaid
sequenceDiagram
autonumber
participant P as pytest
participant F as flash_ecu fixture
participant H as HexFlasher
participant L as LinInterface (mock/babylin)
participant E as ECU
P->>F: Evaluate flashing precondition
alt flash.enabled == true and hex_path provided
F->>H: HexFlasher(lin).flash_hex(hex_path)
H->>L: connect (ensure session ready)
H->>E: Enter programming session (UDS)
H->>E: Erase memory (as required)
loop For each block in HEX
H->>L: Transfer block via LIN frames
L-->>H: Acks / flow control
end
H->>E: Verify checksum / signature
H->>E: Exit programming, reset if needed
H-->>F: Return success/failure
else
F-->>P: Skip flashing
end
```
## Implementation notes
- `ecu_framework/flashing/hex_flasher.py` is a stub — replace with your protocol implementation (UDS)
- Validate timing requirements and chunk sizes per ECU
- Consider power-cycle/reset hooks via programmable poewr supply.
## Error handling
- On failure, the fixture calls `pytest.fail("ECU flashing failed")`
- Make flashing idempotent when possible (can retry or detect current version)
## Configuration example
```yaml
flash:
enabled: true
hex_path: "firmware/ecu_firmware.hex"
```

103
docs/08_babylin_internals.md
View File

@ -1,103 +0,0 @@
# BabyLIN Adapter Internals (SDK Python wrapper)
This document describes how the real hardware adapter binds to the BabyLIN SDK via the official Python wrapper `BabyLIN_library.py` and how frames move across the boundary.
## Overview
- Location: `ecu_framework/lin/babylin.py`
- Uses the SDK's `BabyLIN_library.py` (place under `vendor/` or on `PYTHONPATH`)
- Discovers and opens a BabyLIN device using `BLC_getBabyLinPorts` and `BLC_openPort`
- Optionally loads an SDF via `BLC_loadSDF(handle, sdf_path, 1)` and starts a schedule with `BLC_sendCommand("start schedule N;")`
- Converts between Python `LinFrame` and the wrapper's `BLC_FRAME` structure for receive
## Mermaid: SDK connect sequence
```mermaid
sequenceDiagram
autonumber
participant T as Tests/Fixture
participant A as BabyLinInterface (SDK)
participant BL as BabyLIN_library (BLC_*)
T->>A: connect()
A->>BL: BLC_getBabyLinPorts(100)
BL-->>A: [port0, ...]
A->>BL: BLC_openPort(port0)
A->>BL: BLC_loadSDF(handle, sdf_path, 1)
A->>BL: BLC_getChannelHandle(handle, channelIndex)
A->>BL: start schedule N
A-->>T: connected
```
## Mermaid: Binding and call flow
```mermaid
sequenceDiagram
autonumber
participant T as Test
participant L as LinInterface (BabyLin)
participant D as BabyLIN_library (BLC_*)
T->>L: connect()
L->>D: BLC_getBabyLinPorts()
L->>D: BLC_openPort(port)
D-->>L: handle/ok
T->>L: send(frame)
L->>D: BLC_mon_set_xmit(channelHandle, frameId, data, slotTime=0)
D-->>L: code (0=ok)
T->>L: receive(timeout)
L->>D: BLC_getNextFrameTimeout(channelHandle, timeout_ms)
D-->>L: code, frame
L->>L: convert BLC_FRAME to LinFrame
L-->>T: LinFrame or None
T->>L: disconnect()
L->>D: BLC_closeAll()
```
## Master request behavior
When performing a master request, the adapter tries the SDK method in this order:
1. `BLC_sendRawMasterRequest(channel, id, length)` — preferred
2. `BLC_sendRawMasterRequest(channel, id, dataBytes)` — fallback
3. Send a header with zeros and wait on `receive()` — last resort
Mock behavior notes:
- The provided mock (`vendor/mock_babylin_wrapper.py`) synthesizes a deterministic response for the `length` signature (e.g., data[i] = (id + i) & 0xFF).
- For the bytes-only signature, the adapter sends zero-filled bytes of the requested length and validates by length.
## Wrapper usage highlights
```python
from BabyLIN_library import create_BabyLIN
bl = create_BabyLIN()
ports = bl.BLC_getBabyLinPorts(100)
h = bl.BLC_openPort(ports[0])
bl.BLC_loadSDF(h, "Example.sdf", 1)
ch = bl.BLC_getChannelHandle(h, 0)
bl.BLC_sendCommand(ch, "start schedule 0;")
# Transmit and receive
bl.BLC_mon_set_xmit(ch, 0x10, bytes([1,2,3,4]), 0)
frm = bl.BLC_getNextFrameTimeout(ch, 100)
print(frm.frameId, list(frm.frameData)[:frm.lenOfData])
bl.BLC_closeAll()
```
## Notes and pitfalls
- Architecture: Ensure Python (x86/x64) matches the platform library bundled with the SDK
- Timeouts: SDKs typically want milliseconds; convert Python seconds accordingly
- Error handling: On non-zero return codes, use `BLC_getDetailedErrorString` (if available) for human-readable messages
- Threading: If you use background receive threads, protect buffers with locks
- Performance: Avoid excessive allocations in tight loops; reuse frame structs when possible
## Extending
- Add bitrate/channel setup functions as exposed by the SDK
- Implement schedule tables or diagnostics passthrough if provided by the SDK
- Wrap more SDK errors into typed Python exceptions for clarity

144
docs/09_raspberry_pi_deployment.md
View File

@ -1,144 +0,0 @@
# Raspberry Pi Deployment Guide
This guide explains how to run the ECU testing framework on a Raspberry Pi (Debian/Raspberry Pi OS). It covers environment setup, optional BabyLin hardware integration, running tests headless, and installing as a systemd service.
> Note: If you plan to use BabyLin hardware on a Pi, verify vendor driver support for ARM Linux. If BabyLin provides only Windows DLLs, use the Mock interface on Pi or deploy a different hardware interface that supports Linux/ARM.
## 1) Choose your interface
- Mock (recommended for headless/dev on Pi): `interface.type: mock`
- BabyLIN (only if ARM/Linux support is available): `interface.type: babylin` and ensure the SDK's `BabyLIN_library.py` and corresponding Linux/ARM shared libraries are available under `vendor/` or on PYTHONPATH/LD_LIBRARY_PATH.
## 2) Install prerequisites
```bash
sudo apt update
sudo apt install -y python3 python3-venv python3-pip git
```
Optional (for BabyLin or USB tools):
```bash
sudo apt install -y libusb-1.0-0 udev
```
## 3) Clone and set up
```bash
# clone your repo
git clone <your-repo-url> ~/ecu_tests
cd ~/ecu_tests
# create venv
python3 -m venv .venv
source .venv/bin/activate
# install deps
pip install -r requirements.txt
```
## 4) Configure
Create or edit `config/test_config.yaml`:
```yaml
interface:
type: mock # or babylin (if supported on ARM/Linux)
channel: 1
bitrate: 19200
flash:
enabled: false
```
Optionally point to another config file via env var:
```bash
export ECU_TESTS_CONFIG=$(pwd)/config/test_config.yaml
```
If using BabyLIN on Linux/ARM with the SDK wrapper, set:
```yaml
interface:
type: babylin
channel: 0
sdf_path: "/home/pi/ecu_tests/vendor/Example.sdf"
schedule_nr: 0
```
## 5) Run tests on Pi
```bash
source .venv/bin/activate
python -m pytest -m "not hardware" -v
```
Artifacts are in `reports/` (HTML, JUnit, JSON, summary MD).
## 6) Run as a systemd service (headless)
This section lets the Pi run the test suite on boot or on demand.
### Create a runner script
Create `scripts/run_tests.sh`:
```bash
#!/usr/bin/env bash
set -euo pipefail
cd "$(dirname "$0")/.."
source .venv/bin/activate
# optionally set custom config
# export ECU_TESTS_CONFIG=$(pwd)/config/test_config.yaml
python -m pytest -v
```
Make it executable:
```bash
chmod +x scripts/run_tests.sh
```
### Create a systemd unit
Create `scripts/ecu-tests.service`:
```ini
[Unit]
Description=ECU Tests Runner
After=network-online.target
Wants=network-online.target
[Service]
Type=oneshot
WorkingDirectory=/home/pi/ecu_tests
ExecStart=/home/pi/ecu_tests/scripts/run_tests.sh
User=pi
Group=pi
Environment=ECU_TESTS_CONFIG=/home/pi/ecu_tests/config/test_config.yaml
# Capture output to a log file
StandardOutput=append:/home/pi/ecu_tests/reports/service.log
StandardError=append:/home/pi/ecu_tests/reports/service.err
[Install]
WantedBy=multi-user.target
```
Install and run:
```bash
sudo mkdir -p /home/pi/ecu_tests/reports
sudo cp scripts/ecu-tests.service /etc/systemd/system/ecu-tests.service
sudo systemctl daemon-reload
sudo systemctl enable ecu-tests.service
# Start manually
sudo systemctl start ecu-tests.service
# Check status
systemctl status ecu-tests.service
```
## 7) USB and permissions (if using hardware)
- Create udev rules for your device (if required by vendor)
- Add user to dialout or plugdev groups if serial/USB access is needed
- Confirm your hardware library is found by Python and the dynamic linker:
- Ensure `vendor/BabyLIN_library.py` is importable (add `vendor/` to PYTHONPATH if needed)
- Ensure `.so` files are discoverable (e.g., place in `/usr/local/lib` and run `sudo ldconfig`, or set `LD_LIBRARY_PATH`)
## 8) Tips
- Use the mock interface on Pi for quick smoke tests and documentation/report generation
- For full HIL, ensure vendor SDK supports Linux/ARM and provide a shared object (`.so`) and headers
- If only Windows is supported, run the hardware suite on a Windows host and use the Pi for lightweight tasks (archiving, reporting, quick checks)

80
docs/10_build_custom_image.md
View File

@ -1,80 +0,0 @@
# Build a Custom Raspberry Pi Image with ECU Tests
This guide walks you through building your own Raspberry Pi OS image that already contains this framework, dependencies, config, and services. It uses the official pi-gen tool (used by Raspberry Pi OS) or the simpler pi-gen-lite alternatives.
> Important: BabyLin support on ARM/Linux depends on vendor SDKs. If no `.so` is provided for ARM, either use the Mock interface on the Pi, or keep hardware tests on Windows.
## Approach A: Using pi-gen (official)
1. Prepare a build host (Debian/Ubuntu)
```bash
sudo apt update && sudo apt install -y git coreutils quilt parted qemu-user-static debootstrap zerofree \
pxz zip dosfstools libcap2-bin grep rsync xz-utils file bc curl jq
```
2. Clone pi-gen
```bash
git clone https://github.com/RPi-Distro/pi-gen.git
cd pi-gen
```
3. Create a custom stage for ECU Tests (e.g., `stage2/02-ecu-tests/`):
- `00-packages` (optional OS deps like python3, libusb-1.0-0)
- `01-run.sh` to clone your repo, create venv, install deps, and set up systemd units
Example `01-run.sh` contents:
```bash
#!/bin/bash -e
REPO_DIR=/home/pi/ecu_tests
sudo -u pi git clone <your-repo-url> "$REPO_DIR"
cd "$REPO_DIR"
sudo -u pi python3 -m venv .venv
sudo -u pi bash -lc "source .venv/bin/activate && pip install --upgrade pip && pip install -r requirements.txt"
sudo mkdir -p "$REPO_DIR/reports"
sudo chown -R pi:pi "$REPO_DIR/reports"
sudo install -Dm644 "$REPO_DIR/scripts/ecu-tests.service" /etc/systemd/system/ecu-tests.service
sudo install -Dm644 "$REPO_DIR/scripts/ecu-tests.timer" /etc/systemd/system/ecu-tests.timer
sudo systemctl enable ecu-tests.service
sudo systemctl enable ecu-tests.timer || true
# Optional udev rules
if [ -f "$REPO_DIR/scripts/99-babylin.rules" ]; then
sudo install -Dm644 "$REPO_DIR/scripts/99-babylin.rules" /etc/udev/rules.d/99-babylin.rules
fi
```
4. Configure build options (`config` file in pi-gen root):
```bash
IMG_NAME=ecu-tests-os
ENABLE_SSH=1
STAGE_LIST="stage0 stage1 stage2" # include your custom stage2 additions
```
5. Build
```bash
sudo ./build.sh
```
6. Flash the resulting `.img` to SD card with `Raspberry Pi Imager` or `dd`.
## Approach B: Preseed on first boot (lighter)
- Ship a minimal Raspberry Pi OS image and a cloud-init/user-data or first-boot script that pulls your repo and runs `scripts/pi_install.sh`.
- Pros: Faster iteration; you control repo URL at install time.
- Cons: Requires internet on first boot.
## CI Integration (optional)
- You can automate image builds with GitHub Actions or GitLab CI using a Docker runner that executes pi-gen.
- Upload the `.img` as a release asset or pipeline artifact.
- Optionally, bake environment-specific `config/test_config.yaml` or keep it external and set `ECU_TESTS_CONFIG` in the systemd unit.
## Hardware Notes
- If using BabyLin, ensure: `.so` for ARM, udev rules, and any kernel modules.
- Validate the SDK wrapper and libraries are present under `/opt/ecu_tests/vendor/` (or your chosen path). Ensure `.so` files are on the linker path (run `sudo ldconfig`) and `BabyLIN_library.py` is importable.
## Boot-time Behavior
- The `ecu-tests.timer` can schedule daily or hourly test runs; edit `OnUnitActiveSec` as needed.
- Logs are written to `reports/service.log` and `reports/service.err` on the Pi.
## Security
- Consider read-only root filesystem for robustness.
- Use a dedicated user with limited privileges for test execution.
- Keep secrets (if any) injected via environment and not committed.

91
docs/11_conftest_plugin_overview.md
View File

@ -1,91 +0,0 @@
# Pytest Plugin: Reporting & Traceability Overview
This guide explains the custom pytest plugin in `conftest_plugin.py` that enriches reports with business-facing metadata and builds requirements traceability artifacts.
## What it does
- Extracts metadata (Title, Description, Requirements, Test Steps, Expected Result) from test docstrings and markers.
- Attaches this metadata as `user_properties` on each test report.
- Adds custom columns (Title, Requirements) to the HTML report.
- Produces two artifacts under `reports/` at the end of the run:
- `requirements_coverage.json`: a traceability matrix mapping requirement IDs to test nodeids, plus unmapped tests.
- `summary.md`: a compact summary of results suitable for CI dashboards or PR comments.
## Inputs and sources
- Test docstrings prefixed lines:
- `Title:` one-line title
- `Description:` free-form text until the next section
- `Requirements:` comma- or space-separated tokens such as `REQ-001`, `req_002`
- `Test Steps:` numbered list (1., 2., 3., ...)
- `Expected Result:` free-form text
- Pytest markers on tests: `@pytest.mark.req_001` etc. are normalized to `REQ-001`.
## Normalization logic
Requirement IDs are normalized to the canonical form `REQ-XYZ` using:
- `req_001` → `REQ-001`
- `REQ-1` / `REQ-001` / `REQ_001` → `REQ-001`
This ensures consistent keys in the coverage JSON and HTML.
## Hook call sequence
Below is the high-level call sequence of relevant plugin hooks during a typical run:
```mermaid
sequenceDiagram
autonumber
participant Pytest
participant Plugin as conftest_plugin
participant FS as File System
Pytest->>Plugin: pytest_configure(config)
Note right of Plugin: Ensure ./reports exists
Pytest->>Plugin: pytest_collection_modifyitems(session, config, items)
Note right of Plugin: Track all collected nodeids for unmapped detection
loop For each test phase
Pytest->>Plugin: pytest_runtest_makereport(item, call)
Note right of Plugin: hookwrapper
Plugin-->>Pytest: yield to get report
Plugin->>Plugin: parse docstring & markers
Plugin->>Plugin: attach user_properties (Title, Requirements, ...)
Plugin->>Plugin: update _REQ_TO_TESTS, _MAPPED_TESTS
end
Pytest->>Plugin: pytest_terminal_summary(terminalreporter, exitstatus)
Plugin->>Plugin: compile stats, coverage map, unmapped tests
Plugin->>FS: write reports/requirements_coverage.json
Plugin->>FS: write reports/summary.md
```
## HTML report integration
- `pytest_html_results_table_header`: inserts Title and Requirements columns.
- `pytest_html_results_table_row`: fills in values from `report.user_properties`.
The HTML plugin reads `user_properties` to render the extra metadata per test row.
## Artifacts
- `reports/requirements_coverage.json`
- `generated_at`: ISO timestamp
- `results`: counts of passed/failed/skipped/etc.
- `requirements`: map of `REQ-XXX` to an array of test nodeids
- `unmapped_tests`: tests with no requirement mapping
- `files`: relative locations of key artifacts
- `reports/summary.md`
- Human-readable summary with counts and quick artifact links
## Error handling
Artifact writes are wrapped in try/except to avoid failing the test run if the filesystem is read-only or unavailable. Any write failure is logged to the terminal.
## Extensibility ideas
- Add more normalized marker families (e.g., `capability_*`, `risk_*`).
- Emit CSV or Excel in addition to JSON/Markdown.
- Include per-test durations and flakiness stats in the summary.
- Support a `--requirement` CLI filter that selects tests by normalized req IDs.

188
docs/12_using_the_framework.md
View File

@ -1,188 +0,0 @@
# Using the ECU Test Framework
This guide shows common ways to run the test framework: from fast local mock runs to full hardware loops, CI, and Raspberry Pi deployments. Commands use Windows PowerShell (as your default shell).
## Prerequisites
- Python 3.x and a virtual environment
- Dependencies installed (see `requirements.txt`)
- Optional: BabyLIN SDK files placed under `vendor/` as described in `vendor/README.md` when running hardware tests
## Configuring tests
- Configuration is loaded from YAML files and can be selected via the environment variable `ECU_TESTS_CONFIG`.
- See `docs/02_configuration_resolution.md` for details and examples.
Example PowerShell:
```powershell
# Use a mock-only config for fast local runs
$env:ECU_TESTS_CONFIG = ".\config\mock.yml"
# Use a hardware config with BabyLIN SDK wrapper
$env:ECU_TESTS_CONFIG = ".\config\hardware_babylin.yml"
```
Quick try with provided examples:
```powershell
# Point to the combined examples file
$env:ECU_TESTS_CONFIG = ".\config\examples.yaml"
# The 'active' section defaults to the mock profile; run non-hardware tests
pytest -m "not hardware" -v
# Edit 'active' to the babylin profile (or point to babylin.example.yaml) and run hardware tests
```
```
## Running locally (mock interface)
Use the mock interface to develop tests quickly without hardware:
```powershell
# Run all mock tests with HTML and JUnit outputs (see pytest.ini defaults)
pytest
# Run only smoke tests (mock) and show progress
pytest -m smoke -q
# Filter by test file or node id
pytest tests\test_smoke_mock.py::TestMockLinInterface::test_mock_send_receive_echo -q
```
What you get:
- Fast execution, deterministic results
- Reports in `reports/` (HTML, JUnit, coverage JSON, CI summary)
Open the HTML report on Windows:
```powershell
start .\reports\report.html
```
## Running on hardware (BabyLIN SDK wrapper)
1) Place SDK files per `vendor/README.md`.
2) Select a config that defines `interface.type: babylin`, `sdf_path`, and `schedule_nr`.
3) Markers allow restricting to hardware tests.
```powershell
# Example environment selection
$env:ECU_TESTS_CONFIG = ".\config\babylin.example.yaml"
# Run only hardware tests
pytest -m "hardware and babylin"
# Run the schedule smoke only
pytest tests\test_babylin_hardware_schedule_smoke.py -q
```
Tips:
- If multiple devices are attached, update your config to select the desired port (future enhancement) or keep only one connected.
- On timeout, tests often accept None to avoid flakiness; increase timeouts if your bus is slow.
- Master request behavior: the adapter prefers `BLC_sendRawMasterRequest(channel, id, length)`; it falls back to the bytes variant or a header+receive strategy as needed. The mock covers both forms.
## Selecting tests with markers
Markers in use:
- `smoke`: quick confidence tests
- `hardware`: needs real device
- `babylin`: targets the BabyLIN SDK adapter
- `req_XXX`: requirement mapping (e.g., `@pytest.mark.req_001`)
Examples:
```powershell
# Only smoke tests (mock + hardware smoke)
pytest -m smoke
# Requirements-based selection (docstrings and markers are normalized)
pytest -k REQ-001
```
## Enriched reporting
- HTML report includes custom columns (Title, Requirements)
- JUnit XML written for CI
- `reports/requirements_coverage.json` maps requirement IDs to tests and lists unmapped tests
- `reports/summary.md` aggregates key counts (pass/fail/etc.)
See `docs/03_reporting_and_metadata.md` and `docs/11_conftest_plugin_overview.md`.
To verify the reporting pipeline end-to-end, run the plugin self-test:
```powershell
python -m pytest tests\plugin\test_conftest_plugin_artifacts.py -q
```
To generate two separate HTML/JUnit reports (unit vs non-unit):
```powershell
./scripts/run_two_reports.ps1
```
## Writing well-documented tests
Use a docstring template so the plugin can extract metadata:
```python
"""
Title: <short title>
Description:
<what the test validates and why>
Requirements: REQ-001, REQ-002
Test Steps:
1. <step one>
2. <step two>
Expected Result:
<succinct expected outcome>
"""
```
Tip: For runtime properties in reports, prefer the shared `rp` fixture (wrapper around `record_property`) and use standardized keys from `docs/15_report_properties_cheatsheet.md`.
## Continuous Integration (CI)
- Run `pytest` with your preferred markers in your pipeline.
- Publish artifacts from `reports/` (HTML, JUnit, coverage JSON, summary.md).
- Optionally parse `requirements_coverage.json` to power dashboards and gates.
Example PowerShell (local CI mimic):
```powershell
# Run smoke tests and collect reports
pytest -m smoke --maxfail=1 -q
```
## Raspberry Pi / Headless usage
- Follow `docs/09_raspberry_pi_deployment.md` to set up a venv and systemd service
- For a golden image approach, see `docs/10_build_custom_image.md`
Running tests headless via systemd typically involves:
- A service that sets `ECU_TESTS_CONFIG` to a hardware YAML
- Running `pytest -m "hardware and babylin"` on boot or via timer
## Troubleshooting quick hits
- ImportError for `BabyLIN_library`: verify placement under `vendor/` and native library presence.
- No BabyLIN devices found: check USB connection, drivers, and permissions.
- Timeouts on receive: increase `timeout` or verify schedule activity and SDF correctness.
- Missing reports: ensure `pytest.ini` includes the HTML/JUnit plugins and the custom plugin is loaded.
## Power supply (Owon) hardware test
Enable `power_supply` in your config and set the serial port, then run the dedicated test or the quick demo script.
```powershell
copy .\config\owon_psu.example.yaml .\config\owon_psu.yaml
# edit COM port in .\config\owon_psu.yaml or set values in config\test_config.yaml
pytest -k test_owon_psu_idn_and_optional_set -m hardware -q
python .\vendor\Owon\owon_psu_quick_demo.py
```
See also: `docs/14_power_supply.md` for details and troubleshooting.

125
docs/13_unit_testing_guide.md
View File

@ -1,125 +0,0 @@
# Unit Testing Guide
This guide explains how the project's unit tests are organized, how to run them (with and without markers), how coverage is generated, and tips for writing effective tests.
## Why unit tests?
- Fast feedback without hardware
- Validate contracts (config loader, frames, adapters, flashing scaffold)
- Keep behavior stable as the framework evolves
## Test layout
- `tests/unit/` — pure unit tests (no hardware, no external I/O)
- `test_config_loader.py` — config precedence and defaults
- `test_linframe.py` — `LinFrame` validation
- `test_babylin_adapter_mocked.py` — BabyLIN adapter error paths with a mocked SDK wrapper
- `test_hex_flasher.py` — flashing scaffold against a stub LIN interface
- `tests/plugin/` — plugin self-tests using `pytester`
- `test_conftest_plugin_artifacts.py` — verifies JSON coverage and summary artifacts
- `tests/` — existing smoke/mock/hardware tests
## Markers and selection
A `unit` marker is provided for easy selection:
- By marker (recommended):
```powershell
pytest -m unit -q
```
- By path:
```powershell
pytest tests\unit -q
```
- Exclude hardware:
```powershell
pytest -m "not hardware" -v
```
## Coverage
Coverage is enabled by default via `pytest.ini` addopts:
- `--cov=ecu_framework --cov-report=term-missing`
You’ll see a summary with missing lines directly in the terminal. To disable coverage locally, override addopts on the command line:
```powershell
pytest -q -o addopts=""
```
(Optional) To produce an HTML coverage report, you can add `--cov-report=html` and open `htmlcov/index.html`.
## Writing unit tests
- Prefer small, focused tests
- For BabyLIN adapter logic, inject `wrapper_module` with the mock:
```python
from ecu_framework.lin.babylin import BabyLinInterface
from vendor import mock_babylin_wrapper as mock_bl
lin = BabyLinInterface(wrapper_module=mock_bl)
lin.connect()
# exercise send/receive/request
```
- To simulate specific SDK signatures, use a thin shim (see `_MockBytesOnly` in `tests/test_babylin_wrapper_mock.py`).
- Include a docstring with Title/Description/Requirements/Steps/Expected Result so the reporting plugin can extract metadata (this also helps the HTML report).
- When testing the plugin itself, use the `pytester` fixture to generate a temporary test run and validate artifacts exist and contain expected entries.
## Typical commands (Windows PowerShell)
- Run unit tests with coverage:
```powershell
pytest -m unit -q
```
- Run only plugin self-tests:
```powershell
pytest tests\plugin -q
```
- Run the specific plugin artifact test (verifies HTML/JUnit, summary, and coverage JSON under `reports/`):
```powershell
python -m pytest tests\plugin\test_conftest_plugin_artifacts.py -q
```
- Run all non-hardware tests with verbose output:
```powershell
pytest -m "not hardware" -v
```
- Open the HTML report:
```powershell
start .\reports\report.html
```
- Generate two separate reports (unit vs non-unit):
```powershell
./scripts/run_two_reports.ps1
```
## CI suggestions
- Run `-m unit` and `tests/plugin` on every PR
- Optionally run mock integration/smoke on PR
- Run hardware test matrix on a nightly or on-demand basis (`-m "hardware and babylin"`)
- Publish artifacts from `reports/`: HTML/JUnit/coverage JSON/summary MD
## Troubleshooting
- Coverage not showing: ensure `pytest-cov` is installed (see `requirements.txt`) and `pytest.ini` addopts include `--cov`.
- Import errors: activate the venv and reinstall requirements.
- Plugin artifacts missing under `pytester`: verify tests write to `reports/` (our plugin creates the folder automatically in `pytest_configure`).

103
docs/14_power_supply.md
View File

@ -1,103 +0,0 @@
# Power Supply (Owon) — control, configuration, tests, and quick demo
This guide covers using the Owon bench power supply via SCPI over serial with the framework.
- Library: `ecu_framework/power/owon_psu.py`
- Hardware test: `tests/hardware/test_owon_psu.py`
- quick demo script: `vendor/Owon/owon_psu_quick_demo.py`
- Configuration: `config/test_config.yaml` (`power_supply`), optionally merged from `config/owon_psu.yaml` or env `OWON_PSU_CONFIG`
## Install dependencies
```powershell
pip install -r .\requirements.txt
```
## Configure
You can keep PSU settings centrally or in a machine-specific YAML.
- Central: `config/test_config.yaml` → `power_supply` section
- Separate: `config/owon_psu.yaml` (or `OWON_PSU_CONFIG` env var)
Supported keys:
```yaml
power_supply:
enabled: true
port: COM4 # e.g., COM4 (Windows) or /dev/ttyUSB0 (Linux)
baudrate: 115200
timeout: 1.0
eol: "\n" # or "\r\n" if required
parity: N # N|E|O
stopbits: 1 # 1|2
xonxoff: false
rtscts: false
dsrdtr: false
idn_substr: OWON
do_set: false
set_voltage: 5.0
set_current: 0.1
```
The central config loader automatically merges `config/owon_psu.yaml` (or the path in `OWON_PSU_CONFIG`) into `power_supply`.
## Run the hardware test
Skips unless `power_supply.enabled` is true and `port` is set.
```powershell
pytest -k test_owon_psu_idn_and_optional_set -m hardware -q
```
What it does:
- Opens serial with your configured line params
- Queries `*IDN?` (checks `idn_substr` if provided)
- If `do_set` is true, sets voltage/current, enables output briefly, then disables
## Use the library programmatically
```python
from ecu_framework.power import OwonPSU, SerialParams
params = SerialParams(baudrate=115200, timeout=1.0)
with OwonPSU("COM4", params, eol="\n") as psu:
print(psu.idn())
psu.set_voltage(1, 5.0)
psu.set_current(1, 0.1)
psu.set_output(True)
# ... measure, etc.
psu.set_output(False)
```
Notes:
- Commands use newline-terminated writes; reads use `readline()`
- SCPI forms: `SOUR:VOLT`, `SOUR:CURR`, `MEAS:VOLT?`, `MEAS:CURR?`, `output 0/1`, `output?`
## quick demo script
The quick demo reads `OWON_PSU_CONFIG` or `config/owon_psu.yaml` and performs a small sequence.
```powershell
python .\vendor\Owon\owon_psu_quick_demo.py
```
It also scans ports with `*IDN?` using `scan_ports()`.
## Troubleshooting
- Empty `*IDN?` or timeouts:
- Verify COM port and exclusivity (no other program holding it)
- Try `eol: "\r\n"`
- Adjust `parity` and `stopbits` per your device manual
- Windows COM > 9:
- Most Python code accepts `COM10` directly; if needed in other tools, use `\\.\\COM10`
- Flow control:
- Keep `xonxoff`, `rtscts`, `dsrdtr` false unless required
## Related files
- `ecu_framework/power/owon_psu.py` — PSU controller (pyserial)
- `tests/hardware/test_owon_psu.py` — Hardware test using central config
- `vendor/Owon/owon_psu_quick_demo.py` — Quick demo runner
- `config/owon_psu.example.yaml` — Example machine-specific YAML

53
docs/15_report_properties_cheatsheet.md
View File

@ -1,53 +0,0 @@
# Report properties cheatsheet (record_property / rp)
Use these standardized keys when calling `record_property("key", value)` or the `rp("key", value)` helper.
This keeps reports consistent and easy to scan across suites.
## General
- test_phase: setup | call | teardown (if you want to distinguish)
- environment: local | ci | lab
- config_source: defaults | file | env | env+overrides (already used in unit tests)
## LIN (common)
- lin_type: mock | babylin
- tx_id: hex string or int (e.g., "0x12")
- tx_data: list of ints (bytes)
- rx_present: bool
- rx_id: hex string or int
- rx_data: list of ints
- timeout_s: float seconds
## BabyLIN specifics
- sdf_path: string
- schedule_nr: int
- receive_result: frame | timeout
- wrapper: mock_bl | _MockBytesOnly | real (for future)
## Mock-specific
- expected_data: list of ints
## Power supply (PSU)
- psu_idn: string from `*IDN?`
- output_status_before: bool
- output_status_after: bool
- set_voltage: float (V)
- set_current: float (A)
- measured_voltage: float (V)
- measured_current: float (A)
- psu_port: e.g., COM4 or /dev/ttyUSB0 (if helpful)
## Flashing
- hex_path: string
- sent_count: int (frames sent by stub/mock)
- flash_result: ok | fail (for future real flashing)
## Configuration highlights
- interface_type: mock | babylin
- interface_channel: int
- flash_enabled: bool
## Tips
- Prefer simple, lowercase snake_case keys
- Use lists for byte arrays so they render clearly in JSON and HTML
- Log both expected and actual when asserting patterns (e.g., deterministic responses)
- Keep units in the key name when helpful (voltage/current include V/A in the name)

71
docs/DEVELOPER_COMMIT_GUIDE.md
View File

@ -1,71 +0,0 @@
# Developer Commit Guide
This guide explains exactly what to commit to source control for this repository, and what to keep out. It also includes a suggested commit message and safe commands to stage changes.
## Commit these files
### Core framework (source)
- `ecu_framework/config.py`
- `ecu_framework/lin/base.py`
- `ecu_framework/lin/mock.py`
- `ecu_framework/lin/babylin.py`
- `ecu_framework/flashing/hex_flasher.py`
### Pytest plugin and config
- `conftest_plugin.py`
Generates HTML columns, requirements coverage JSON, and CI summary
- `pytest.ini`
- `requirements.txt`
### Tests and fixtures
- `tests/conftest.py`
- `tests/test_smoke_mock.py`
- `tests/test_babylin_hardware_smoke.py` (if present)
- `tests/test_hardware_placeholder.py` (if present)
### Documentation
- `README.md`
- `TESTING_FRAMEWORK_GUIDE.md`
- `docs/README.md`
- `docs/01_run_sequence.md`
- `docs/02_configuration_resolution.md`
- `docs/03_reporting_and_metadata.md`
- `docs/04_lin_interface_call_flow.md`
- `docs/05_architecture_overview.md`
- `docs/06_requirement_traceability.md`
- `docs/07_flash_sequence.md`
- `docs/08_babylin_internals.md`
### Vendor guidance (no binaries)
- `vendor/README.md`
- Any headers in `vendor/` (if added per SDK)
### Housekeeping
- `.gitignore`
Ignores reports and vendor binaries
- `reports/.gitkeep`
Retains folder structure without committing artifacts
## Do NOT commit (ignored or should be excluded)
- Virtual environments: `.venv/`, `venv/`, etc.
- Generated test artifacts:
`reports/report.html`, `reports/junit.xml`, `reports/summary.md`, `reports/requirements_coverage.json`
<!-- - Vendor binaries: anything under `vendor/**` with `.dll`, `.lib`, `.pdb` keep them for now -->
- Python caches: `__pycache__/`, `.pytest_cache/`
- Local env files: `.env`
## Safe commit commands (PowerShell)
```powershell
# Stage everything except what .gitignore already excludes
git add -A
# Commit with a helpful message
git commit -m "ECU framework: docs, reporting plugin (HTML metadata + requirements JSON + CI summary), .gitignore updates"
```
## Notes
<!-- - Do not commit BabyLin DLLs or proprietary binaries. Keep only the placement/readme and headers. Keep them for now -->
- The plugin writes CI-friendly artifacts into `reports/`; they’re ignored by default but published in CI.

26
docs/README.md
View File

@ -1,26 +0,0 @@
# Documentation Index
A guided tour of the ECU testing framework. Start here:
1. `01_run_sequence.md` — End-to-end run sequence and call flow
2. `02_configuration_resolution.md` — How configuration is loaded and merged
3. `03_reporting_and_metadata.md` — How test documentation becomes report metadata
4. `11_conftest_plugin_overview.md` — Custom pytest plugin: hooks, call sequence, and artifacts
5. `04_lin_interface_call_flow.md` — LIN abstraction and adapter behavior (Mock vs BabyLIN SDK wrapper)
6. `05_architecture_overview.md` — High-level architecture and components
7. `06_requirement_traceability.md` — Requirement markers and coverage visuals
8. `07_flash_sequence.md` — ECU flashing workflow and sequence diagram
9. `08_babylin_internals.md` — BabyLIN SDK wrapper internals and call flow
9. `DEVELOPER_COMMIT_GUIDE.md` — What to commit vs ignore, commands
10. `09_raspberry_pi_deployment.md` — Run on Raspberry Pi (venv, service, hardware notes)
11. `10_build_custom_image.md` — Build a custom Raspberry Pi OS image with the framework baked in
12. `12_using_the_framework.md` — Practical usage: local, hardware, CI, and Pi
13. `13_unit_testing_guide.md` — Unit tests layout, markers, coverage, and tips
14. `14_power_supply.md` — Owon PSU control, configuration, tests, and quick demo script
15. `15_report_properties_cheatsheet.md` — Standardized keys for record_property/rp across suites
Related references:
- Root project guide: `../README.md`
- Full framework guide: `../TESTING_FRAMEWORK_GUIDE.md`
- BabyLIN placement and integration: `../vendor/README.md`
- PSU quick demo and scripts: `../vendor/Owon/`

15
ecu_framework/__init__.py
View File

@ -1,15 +0,0 @@
"""
ECU Tests framework package.
Provides:
- config: YAML configuration loader and types
- lin: LIN interface abstraction and adapters (mock and BabyLIN)
Package version is exposed as __version__.
"""
__all__ = [
"config",
"lin",
]
__version__ = "0.1.0"

236
ecu_framework/config.py
View File

@ -1,236 +0,0 @@
from __future__ import annotations # Postponed annotations for forward references and speed
import os # For environment variables and filesystem checks
import pathlib # Path handling across platforms
from dataclasses import dataclass, field # Lightweight typed containers
from typing import Any, Dict, Optional # Type hints for clarity
import yaml # Safe YAML parsing for configuration files
@dataclass
class FlashConfig:
"""Flashing-related configuration.
enabled: Whether to trigger flashing at session start.
hex_path: Path to the firmware HEX file (if any).
"""
enabled: bool = False # Off by default
hex_path: Optional[str] = None # No default file path
@dataclass
class InterfaceConfig:
"""LIN interface configuration.
type: Adapter type name: "mock" for the simulated adapter, "babylin" for real hardware via SDK.
channel: Channel index to use (0-based in most SDKs); default chosen by project convention.
bitrate: Informational; typically SDF/schedule defines effective bitrate for BabyLIN.
dll_path: Legacy/optional pointer to vendor DLLs when using ctypes (not used by SDK wrapper).
node_name: Optional friendly name for display/logging.
func_names: Legacy mapping for ctypes function names; ignored by SDK wrapper.
sdf_path: Path to the SDF to load on connect (BabyLIN only).
schedule_nr: Schedule index to start after connect (BabyLIN only).
"""
type: str = "mock" # "mock" or "babylin"
channel: int = 1 # Default channel index (project-specific default)
bitrate: int = 19200 # Typical LIN bitrate; SDF may override
dll_path: Optional[str] = None # Legacy ctypes option; not used with SDK wrapper
node_name: Optional[str] = None # Optional label for node/adapter
func_names: Dict[str, str] = field(default_factory=dict) # Legacy ctypes mapping; safe to leave empty
# SDK wrapper options
sdf_path: Optional[str] = None # Path to SDF file to load (BabyLIN)
schedule_nr: int = 0 # Schedule number to start after connect (BabyLIN)
@dataclass
class EcuTestConfig:
"""Top-level, fully-typed configuration for the framework.
interface: Settings for LIN communication (mock or BabyLIN).
flash: Optional flashing behavior configuration.
"""
interface: InterfaceConfig = field(default_factory=InterfaceConfig)
flash: FlashConfig = field(default_factory=FlashConfig)
# Serial power supply (e.g., Owon) configuration
# Test code can rely on these values to interact with PSU if enabled
power_supply: "PowerSupplyConfig" = field(default_factory=lambda: PowerSupplyConfig())
@dataclass
class PowerSupplyConfig:
"""Serial power supply configuration (e.g., Owon PSU).
enabled: Whether PSU tests/features should be active.
port: Serial device (e.g., COM4 on Windows, /dev/ttyUSB0 on Linux).
baudrate/timeout/eol: Basic line settings; eol often "\n" or "\r\n".
parity: One of "N", "E", "O".
stopbits: 1 or 2.
xonxoff/rtscts/dsrdtr: Flow control flags.
idn_substr: Optional substring to assert in *IDN? responses.
do_set/set_voltage/set_current: Optional demo/test actions.
"""
enabled: bool = False
port: Optional[str] = None
baudrate: int = 115200
timeout: float = 1.0
eol: str = "\n"
parity: str = "N"
stopbits: float = 1.0
xonxoff: bool = False
rtscts: bool = False
dsrdtr: bool = False
idn_substr: Optional[str] = None
do_set: bool = False
set_voltage: float = 1.0
set_current: float = 0.1
DEFAULT_CONFIG_RELATIVE = pathlib.Path("config") / "test_config.yaml" # Default config path relative to repo root
ENV_CONFIG_PATH = "ECU_TESTS_CONFIG" # Env var to override config file location
def _deep_update(base: Dict[str, Any], updates: Dict[str, Any]) -> Dict[str, Any]:
"""Recursively merge dict 'updates' into dict 'base'.
- Nested dicts are merged by key
- Scalars/collections at any level are replaced entirely
- Mutation occurs in-place on 'base' and the same object is returned
"""
for k, v in updates.items(): # Iterate all update keys
if isinstance(v, dict) and isinstance(base.get(k), dict): # Both sides dict → recurse
base[k] = _deep_update(base[k], v)
else: # Otherwise replace
base[k] = v
return base # Return the mutated base for chaining
def _to_dataclass(cfg: Dict[str, Any]) -> EcuTestConfig:
"""Convert a merged plain dict config into strongly-typed dataclasses.
Defensive casting is used to ensure correct types even if YAML contains strings.
"""
iface = cfg.get("interface", {}) # Sub-config for interface
flash = cfg.get("flash", {}) # Sub-config for flashing
psu = cfg.get("power_supply", {}) # Sub-config for power supply
return EcuTestConfig(
interface=InterfaceConfig(
type=str(iface.get("type", "mock")).lower(), # Normalize to lowercase
channel=int(iface.get("channel", 1)), # Coerce to int
bitrate=int(iface.get("bitrate", 19200)), # Coerce to int
dll_path=iface.get("dll_path"), # Optional legacy field
node_name=iface.get("node_name"), # Optional friendly name
func_names=dict(iface.get("func_names", {}) or {}), # Ensure a dict
sdf_path=iface.get("sdf_path"), # Optional SDF path
schedule_nr=int(iface.get("schedule_nr", 0)), # Coerce to int
),
flash=FlashConfig(
enabled=bool(flash.get("enabled", False)), # Coerce to bool
hex_path=flash.get("hex_path"), # Optional hex path
),
power_supply=PowerSupplyConfig(
enabled=bool(psu.get("enabled", False)),
port=psu.get("port"),
baudrate=int(psu.get("baudrate", 115200)),
timeout=float(psu.get("timeout", 1.0)),
eol=str(psu.get("eol", "\n")),
parity=str(psu.get("parity", "N")),
stopbits=float(psu.get("stopbits", 1.0)),
xonxoff=bool(psu.get("xonxoff", False)),
rtscts=bool(psu.get("rtscts", False)),
dsrdtr=bool(psu.get("dsrdtr", False)),
idn_substr=psu.get("idn_substr"),
do_set=bool(psu.get("do_set", False)),
set_voltage=float(psu.get("set_voltage", 1.0)),
set_current=float(psu.get("set_current", 0.1)),
),
)
def load_config(workspace_root: Optional[str] = None, overrides: Optional[Dict[str, Any]] = None) -> EcuTestConfig:
"""Load configuration from YAML file, environment, overrides, or defaults.
Precedence (highest to lowest):
1. in-memory 'overrides' dict
2. YAML file specified by env var ECU_TESTS_CONFIG
3. YAML at ./config/test_config.yaml (relative to workspace_root)
4. built-in defaults in this function
"""
# Start with built-in defaults; minimal, safe baseline
base: Dict[str, Any] = {
"interface": {
"type": "mock", # mock by default for developer friendliness
"channel": 1,
"bitrate": 19200,
},
"flash": {
"enabled": False,
"hex_path": None,
},
"power_supply": {
"enabled": False,
"port": None,
"baudrate": 115200,
"timeout": 1.0,
"eol": "\n",
"parity": "N",
"stopbits": 1.0,
"xonxoff": False,
"rtscts": False,
"dsrdtr": False,
"idn_substr": None,
"do_set": False,
"set_voltage": 1.0,
"set_current": 0.1,
},
}
cfg_path: Optional[pathlib.Path] = None # Resolved configuration file path
# 2) Environment variable can point to any YAML file
env_path = os.getenv(ENV_CONFIG_PATH)
if env_path:
candidate = pathlib.Path(env_path)
if candidate.is_file(): # Only accept existing files
cfg_path = candidate
# 3) Fallback to default path under the provided workspace root
if cfg_path is None and workspace_root:
candidate = pathlib.Path(workspace_root) / DEFAULT_CONFIG_RELATIVE
if candidate.is_file():
cfg_path = candidate
# Load YAML file if we have one
if cfg_path and cfg_path.is_file():
with open(cfg_path, "r", encoding="utf-8") as f:
file_cfg = yaml.safe_load(f) or {} # Parse YAML safely; empty → {}
if isinstance(file_cfg, dict): # Only merge dicts
_deep_update(base, file_cfg)
# Optionally merge a dedicated PSU YAML if present (or env var path)
# This allows users to keep sensitive or machine-specific serial settings separate
psu_env = os.getenv("OWON_PSU_CONFIG")
psu_default = None
if workspace_root:
candidate = pathlib.Path(workspace_root) / "config" / "owon_psu.yaml"
if candidate.is_file():
psu_default = candidate
psu_path: Optional[pathlib.Path] = pathlib.Path(psu_env) if psu_env else psu_default
if psu_path and psu_path.is_file():
with open(psu_path, "r", encoding="utf-8") as f:
psu_cfg = yaml.safe_load(f) or {}
if isinstance(psu_cfg, dict):
base.setdefault("power_supply", {})
# Merge PSU YAML into power_supply section
base["power_supply"] = _deep_update(base["power_supply"], psu_cfg)
# 1) In-memory overrides always win
if overrides:
_deep_update(base, overrides)
# Convert to typed dataclasses for ergonomic downstream usage
return _to_dataclass(base)

9
ecu_framework/flashing/__init__.py
View File

@ -1,9 +0,0 @@
"""
Flashing package.
Exports:
- HexFlasher: scaffold class to wire up UDS-based ECU programming over LIN.
"""
from .hex_flasher import HexFlasher
__all__ = ["HexFlasher"]

25
ecu_framework/flashing/hex_flasher.py
View File

@ -1,25 +0,0 @@
from __future__ import annotations
import pathlib
from typing import Optional
from ..lin.base import LinInterface
class HexFlasher:
"""Stubbed ECU flasher over LIN.
Replace with your actual UDS flashing sequence. For now, just validates the file exists
and pretends to flash successfully.
"""
def __init__(self, lin: LinInterface) -> None:
self.lin = lin
def flash_hex(self, hex_path: str, *, erase: bool = True, verify: bool = True, timeout_s: float = 120.0) -> bool:
path = pathlib.Path(hex_path)
if not path.is_file():
raise FileNotFoundError(f"HEX file not found: {hex_path}")
# TODO: Implement real flashing over LIN (UDS). This is a placeholder.
# You might send specific frames or use a higher-level protocol library.
return True

17
ecu_framework/lin/__init__.py
View File

@ -1,17 +0,0 @@
"""
LIN interface package.
Exports:
- LinInterface, LinFrame: core abstraction and frame type
- MockBabyLinInterface: mock implementation for fast, hardware-free tests
Real hardware adapter (BabyLIN) is available in babylin.py.
"""
from .base import LinInterface, LinFrame
from .mock import MockBabyLinInterface
__all__ = [
"LinInterface",
"LinFrame",
"MockBabyLinInterface",
]

220
ecu_framework/lin/babylin.py
View File

@ -1,220 +0,0 @@
from __future__ import annotations # Enable postponed evaluation of annotations (PEP 563/649 style)
from typing import Optional # For optional type hints
from .base import LinInterface, LinFrame # Base abstraction and frame dataclass used by all LIN adapters
class BabyLinInterface(LinInterface):
"""LIN adapter that uses the vendor's BabyLIN Python SDK wrapper.
- Avoids manual ctypes; relies on BabyLIN_library.py BLC_* functions.
- Keeps the same LinInterface contract for send/receive/request/flush.
"""
def __init__(
self,
dll_path: Optional[str] = None, # Not used by SDK wrapper (auto-selects platform libs)
bitrate: int = 19200, # Informational; typically defined by SDF/schedule
channel: int = 0, # Channel index used with BLC_getChannelHandle (0-based)
node_name: Optional[str] = None, # Optional friendly name (not used by SDK calls)
func_names: Optional[dict] = None, # Legacy (ctypes) compatibility; unused here
sdf_path: Optional[str] = None, # Optional SDF file to load after open
schedule_nr: int = 0, # Schedule number to start after connect
wrapper_module: Optional[object] = None, # Inject a wrapper (e.g., mock) for tests
) -> None:
self.bitrate = bitrate # Store configured (informational) bitrate
self.channel_index = channel # Desired channel index
self.node_name = node_name or "ECU_TEST_NODE" # Default node name if not provided
self.sdf_path = sdf_path # SDF to load (if provided)
self.schedule_nr = schedule_nr # Schedule to start on connect
# Choose the BabyLIN wrapper module to use:
# - If wrapper_module provided (unit tests with mock), use it
# - Else dynamically import the real SDK wrapper (BabyLIN_library.py)
if wrapper_module is not None:
_bl = wrapper_module
else:
import importlib, sys, os # Local import to avoid global dependency during unit tests
_bl = None # Placeholder for resolved module
import_errors = [] # Accumulate import errors for diagnostics
for modname in ("BabyLIN_library", "vendor.BabyLIN_library"):
try:
_bl = importlib.import_module(modname)
break
except Exception as e: # pragma: no cover
import_errors.append((modname, str(e)))
if _bl is None:
# Try adding the common 'vendor' folder to sys.path then retry import
repo_root = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))
vendor_dir = os.path.join(repo_root, "vendor")
if os.path.isdir(vendor_dir) and vendor_dir not in sys.path:
sys.path.insert(0, vendor_dir)
try:
_bl = importlib.import_module("BabyLIN_library")
except Exception as e: # pragma: no cover
import_errors.append(("BabyLIN_library", str(e)))
if _bl is None:
# Raise a helpful error with all attempted import paths
details = "; ".join([f"{m}: {err}" for m, err in import_errors]) or "not found"
raise RuntimeError(
"Failed to import BabyLIN_library. Ensure the SDK's BabyLIN_library.py is present in the project (e.g., vendor/BabyLIN_library.py). Details: "
+ details
)
# Create the BabyLIN SDK instance (module exposes create_BabyLIN())
self._BabyLIN = _bl.create_BabyLIN()
# Small helper to call BLC_* functions by name (keeps call sites concise)
self._bl_call = lambda name, *args, **kwargs: getattr(self._BabyLIN, name)(*args, **kwargs)
self._handle = None # Device handle returned by BLC_openPort
self._channel_handle = None # Per-channel handle returned by BLC_getChannelHandle
self._connected = False # Internal connection state flag
def _err(self, rc: int) -> None:
"""Raise a RuntimeError with a readable SDK error message for rc != BL_OK."""
if rc == self._BabyLIN.BL_OK:
return
# Prefer a human-friendly error string if the SDK provides it
try:
get_str = getattr(self._BabyLIN, 'BLC_getDetailedErrorString', None)
msg = get_str(rc) if get_str else f"rc={rc}"
if not isinstance(msg, str):
msg = str(msg)
except Exception:
msg = f"rc={rc}"
raise RuntimeError(f"BabyLIN error: {msg}")
def connect(self) -> None:
"""Open device, optionally load SDF, select channel, and start schedule."""
# Discover BabyLIN devices (returns a list of port identifiers)
ports = self._bl_call('BLC_getBabyLinPorts', 100)
if not ports:
raise RuntimeError("No BabyLIN devices found")
# Open the first available device port (you could extend to select by config)
self._handle = self._bl_call('BLC_openPort', ports[0])
if not self._handle:
raise RuntimeError("Failed to open BabyLIN port")
# Load SDF onto the device, if configured (3rd arg '1' often means 'download')
if self.sdf_path:
rc = self._bl_call('BLC_loadSDF', self._handle, self.sdf_path, 1)
if rc != self._BabyLIN.BL_OK:
self._err(rc)
# Get channel count and pick the configured channel index (default 0)
ch_count = self._bl_call('BLC_getChannelCount', self._handle)
if ch_count <= 0:
raise RuntimeError("No channels reported by device")
ch_idx = int(self.channel_index)
if ch_idx < 0 or ch_idx >= ch_count:
ch_idx = 0
# Resolve a channel handle used for all subsequent Tx/Rx commands
self._channel_handle = self._bl_call('BLC_getChannelHandle', self._handle, ch_idx)
# Start a schedule if configured (common requirement for regular polling/masters)
if self.schedule_nr is not None:
cmd = f"start schedule {int(self.schedule_nr)};"
rc = self._bl_call('BLC_sendCommand', self._channel_handle, cmd)
if rc != self._BabyLIN.BL_OK:
self._err(rc)
self._connected = True # Mark interface as connected
def disconnect(self) -> None:
"""Close device handles and reset internal state (best-effort)."""
try:
self._bl_call('BLC_closeAll') # Close all device connections via SDK
except Exception:
pass # Ignore SDK exceptions during shutdown
self._connected = False
self._handle = None
self._channel_handle = None
def send(self, frame: LinFrame) -> None:
"""Transmit a LIN frame using BLC_mon_set_xmit."""
if not self._connected or not self._channel_handle:
raise RuntimeError("BabyLIN not connected")
# slotTime=0 means use default timing configured by schedule/SDF
rc = self._bl_call('BLC_mon_set_xmit', self._channel_handle, int(frame.id), bytes(frame.data), 0)
if rc != self._BabyLIN.BL_OK:
self._err(rc)
def receive(self, id: Optional[int] = None, timeout: float = 1.0):
"""Receive a LIN frame with optional ID filter and timeout (seconds)."""
if not self._connected or not self._channel_handle:
raise RuntimeError("BabyLIN not connected")
ms = max(0, int(timeout * 1000)) # SDK expects milliseconds
try:
frame = self._bl_call('BLC_getNextFrameTimeout', self._channel_handle, ms)
except Exception:
# Many wrappers raise on timeout; unify as 'no data'
return None
if not frame:
return None
# Convert SDK frame to our LinFrame (mask to classic 6-bit LIN ID range)
fid = int(frame.frameId & 0x3F)
data = bytes(list(frame.frameData)[: int(frame.lenOfData)])
lin_frame = LinFrame(id=fid, data=data)
if id is None or fid == id:
return lin_frame
# If a different ID was received and caller requested a filter, return None
return None
def flush(self) -> None:
"""Flush RX buffers if the SDK exposes such a function (optional)."""
if not self._connected or not self._channel_handle:
return
try:
# Some SDKs may not expose flush; no-op if missing
flush = getattr(self._BabyLIN, 'BLC_flush', None)
if flush:
flush(self._channel_handle)
except Exception:
pass
def request(self, id: int, length: int, timeout: float = 1.0):
"""Perform a LIN master request and wait for response.
Strategy:
- Prefer SDK method `BLC_sendRawMasterRequest` if present (bytes or length variants).
- Fallback: transmit a header with zeroed payload; then wait for response.
- Always attempt to receive a frame with matching ID within 'timeout'.
"""
if not self._connected or not self._channel_handle:
raise RuntimeError("BabyLIN not connected")
sent = False # Track whether a request command was successfully issued
# Attempt to use raw master request if provided by SDK
# Preference: try (channel, frameId, length) first because our mock wrapper
# synthesizes a deterministic payload for this form (see vendor/mock_babylin_wrapper.py),
# then fall back to (channel, frameId, dataBytes) if the SDK only supports that.
raw_req = getattr(self._BabyLIN, 'BLC_sendRawMasterRequest', None)
if raw_req:
# Prefer the (channel, frameId, length) variant first if supported
try:
rc = raw_req(self._channel_handle, int(id), int(length))
if rc == self._BabyLIN.BL_OK:
sent = True
else:
self._err(rc)
except TypeError:
# Fallback to (channel, frameId, dataBytes)
try:
payload = bytes([0] * max(0, min(8, int(length))))
rc = raw_req(self._channel_handle, int(id), payload)
if rc == self._BabyLIN.BL_OK:
sent = True
else:
self._err(rc)
except Exception:
sent = False
except Exception:
sent = False
if not sent:
# Fallback: issue a transmit; many stacks will respond on the bus
self.send(LinFrame(id=id, data=bytes([0] * max(0, min(8, int(length))))))
# Wait for the response frame with matching ID (or None on timeout)
return self.receive(id=id, timeout=timeout)

60
ecu_framework/lin/base.py
View File

@ -1,60 +0,0 @@
from __future__ import annotations
from abc import ABC, abstractmethod
from dataclasses import dataclass
from typing import Optional
@dataclass
class LinFrame:
"""Represents a LIN frame.
id: Frame identifier (0x00 - 0x3F typical for classic LIN IDs)
data: Up to 8 bytes payload.
"""
id: int
data: bytes
def __post_init__(self) -> None:
if not (0 <= self.id <= 0x3F):
raise ValueError(f"LIN ID out of range: {self.id}")
if not isinstance(self.data, (bytes, bytearray)):
# allow list of ints
try:
self.data = bytes(self.data) # type: ignore[arg-type]
except Exception as e: # pragma: no cover - defensive
raise TypeError("data must be bytes-like") from e
if len(self.data) > 8:
raise ValueError("LIN data length must be <= 8")
class LinInterface(ABC):
"""Abstract interface for LIN communication."""
@abstractmethod
def connect(self) -> None:
"""Open the interface connection."""
@abstractmethod
def disconnect(self) -> None:
"""Close the interface connection."""
@abstractmethod
def send(self, frame: LinFrame) -> None:
"""Send a LIN frame."""
@abstractmethod
def receive(self, id: Optional[int] = None, timeout: float = 1.0) -> Optional[LinFrame]:
"""Receive a LIN frame, optionally filtered by ID. Returns None on timeout."""
def request(self, id: int, length: int, timeout: float = 1.0) -> Optional[LinFrame]:
"""Default request implementation: send header then wait a frame.
Override in concrete implementation if different behavior is needed.
"""
# By default, just wait for any frame with this ID
return self.receive(id=id, timeout=timeout)
def flush(self) -> None:
"""Optional: flush RX buffers."""
pass

73
ecu_framework/lin/mock.py
View File

@ -1,73 +0,0 @@
from __future__ import annotations
import queue
import threading
import time
from typing import Optional
from .base import LinInterface, LinFrame
class MockBabyLinInterface(LinInterface):
"""A mock LIN interface that echoes frames and synthesizes responses.
Useful for local development without hardware. Thread-safe.
"""
def __init__(self, bitrate: int = 19200, channel: int = 1) -> None:
self.bitrate = bitrate
self.channel = channel
self._rx: "queue.Queue[LinFrame]" = queue.Queue()
self._lock = threading.RLock()
self._connected = False
def connect(self) -> None:
with self._lock:
self._connected = True
def disconnect(self) -> None:
with self._lock:
self._connected = False
# drain queue
try:
while True:
self._rx.get_nowait()
except queue.Empty:
pass
def send(self, frame: LinFrame) -> None:
if not self._connected:
raise RuntimeError("Mock interface not connected")
# echo back the frame as a received event
self._rx.put(frame)
def receive(self, id: Optional[int] = None, timeout: float = 1.0) -> Optional[LinFrame]:
if not self._connected:
raise RuntimeError("Mock interface not connected")
deadline = time.time() + max(0.0, timeout)
while time.time() < deadline:
try:
frm = self._rx.get(timeout=max(0.0, deadline - time.time()))
if id is None or frm.id == id:
return frm
# not matching, requeue tail-safe
self._rx.put(frm)
except queue.Empty:
break
return None
def request(self, id: int, length: int, timeout: float = 1.0) -> Optional[LinFrame]:
if not self._connected:
raise RuntimeError("Mock interface not connected")
# synthesize a deterministic response payload of requested length
payload = bytes((id + i) & 0xFF for i in range(max(0, min(8, length))))
frm = LinFrame(id=id, data=payload)
self._rx.put(frm)
return self.receive(id=id, timeout=timeout)
def flush(self) -> None:
while not self._rx.empty():
try:
self._rx.get_nowait()
except queue.Empty: # pragma: no cover - race guard
break

13
ecu_framework/power/__init__.py
View File

@ -1,13 +0,0 @@
"""Power control helpers for ECU tests.
Currently includes Owon PSU serial SCPI controller.
"""
from .owon_psu import SerialParams, OwonPSU, scan_ports, auto_detect
__all__ = [
"SerialParams",
"OwonPSU",
"scan_ports",
"auto_detect",
]

193
ecu_framework/power/owon_psu.py
View File

@ -1,193 +0,0 @@
"""Owon PSU SCPI control over raw serial (pyserial).
This module provides a small, programmatic API suitable for tests:
- OwonPSU: context-manageable controller class
- scan_ports(): find devices responding to *IDN?
- auto_detect(): select the first matching device by IDN substring
Behavior follows the working quick demo example (serial):
- Both commands and queries are terminated with a newline ("\n" by default).
- Queries use readline() to fetch a single-line response.
- Command set uses: 'output 0/1', 'output?', 'SOUR:VOLT <V>', 'SOUR:CURR <A>', 'MEAS:VOLT?', 'MEAS:CURR?', '*IDN?'
"""
from __future__ import annotations
from dataclasses import dataclass
from time import sleep
from typing import Iterable, Optional
import serial
from serial import Serial
from serial.tools import list_ports
@dataclass
class SerialParams:
baudrate: int = 115200
timeout: float = 1.0 # seconds
bytesize: int = serial.EIGHTBITS
parity: str = serial.PARITY_NONE
stopbits: float = serial.STOPBITS_ONE
xonxoff: bool = False
rtscts: bool = False
dsrdtr: bool = False
write_timeout: float = 1.0 # seconds
class OwonPSU:
def __init__(self, port: str, params: SerialParams | None = None, eol: str = "\n") -> None:
self.port = port
self.params = params or SerialParams()
self.eol = eol
self._ser: Optional[Serial] = None
def open(self) -> None:
if self._ser and self._ser.is_open:
return
ser = Serial()
ser.port = self.port
ser.baudrate = self.params.baudrate
ser.bytesize = self.params.bytesize
ser.parity = self.params.parity
ser.stopbits = self.params.stopbits
ser.xonxoff = self.params.xonxoff
ser.rtscts = self.params.rtscts
ser.dsrdtr = self.params.dsrdtr
ser.timeout = self.params.timeout
ser.write_timeout = self.params.write_timeout
ser.open()
self._ser = ser
def close(self) -> None:
if self._ser and self._ser.is_open:
try:
self._ser.close()
finally:
self._ser = None
def __enter__(self) -> "OwonPSU":
self.open()
return self
def __exit__(self, exc_type, exc, tb) -> None:
self.close()
@property
def is_open(self) -> bool:
return bool(self._ser and self._ser.is_open)
# ---- low-level ops ----
def write(self, cmd: str) -> None:
"""Write a SCPI command (append eol)."""
if not self._ser:
raise RuntimeError("Port is not open")
data = (cmd + self.eol).encode("ascii", errors="ignore")
self._ser.write(data)
self._ser.flush()
def query(self, q: str) -> str:
"""Send a query with terminator and return a single-line response using readline()."""
if not self._ser:
raise RuntimeError("Port is not open")
# clear buffers to avoid stale data
try:
self._ser.reset_input_buffer()
self._ser.reset_output_buffer()
except Exception:
pass
self._ser.write((q + self.eol).encode("ascii", errors="ignore"))
self._ser.flush()
line = self._ser.readline().strip()
return line.decode("ascii", errors="ignore")
# ---- high-level ops ----
def idn(self) -> str:
return self.query("*IDN?")
def set_voltage(self, channel: int, volts: float) -> None:
# Using SOUR:VOLT <V> per working example
self.write(f"SOUR:VOLT {volts:.3f}")
def set_current(self, channel: int, amps: float) -> None:
# Using SOUR:CURR <A> per working example
self.write(f"SOUR:CURR {amps:.3f}")
def set_output(self, on: bool) -> None:
# Using 'output 1/0' per working example
self.write("output 1" if on else "output 0")
def output_status(self) -> str:
return self.query("output?")
def measure_voltage(self) -> str:
return self.query("MEAS:VOLT?")
def measure_current(self) -> str:
return self.query("MEAS:CURR?")
# ------- discovery helpers -------
def try_idn_on_port(port: str, params: SerialParams) -> str:
dev: Optional[Serial] = None
try:
dev = Serial()
dev.port = port
dev.baudrate = params.baudrate
dev.bytesize = params.bytesize
dev.parity = params.parity
dev.stopbits = params.stopbits
dev.xonxoff = params.xonxoff
dev.rtscts = params.rtscts
dev.dsrdtr = params.dsrdtr
dev.timeout = params.timeout
dev.write_timeout = params.write_timeout
dev.open()
# Query with newline terminator and read a single line
dev.reset_input_buffer(); dev.reset_output_buffer()
dev.write(b"*IDN?\n"); dev.flush()
line = dev.readline().strip()
return line.decode("ascii", errors="ignore")
except Exception:
return ""
finally:
if dev and dev.is_open:
try:
dev.close()
except Exception:
pass
def scan_ports(params: SerialParams | None = None) -> list[tuple[str, str]]:
"""Return [(port, idn_response), ...] for ports that responded."""
params = params or SerialParams()
results: list[tuple[str, str]] = []
for p in list_ports.comports():
dev = p.device
resp = try_idn_on_port(dev, params)
if resp:
results.append((dev, resp))
return results
def auto_detect(params: SerialParams | None = None, idn_substr: str | None = None) -> Optional[str]:
"""Return the first port whose *IDN? contains idn_substr (case-insensitive), else first responder."""
params = params or SerialParams()
matches = scan_ports(params)
if not matches:
return None
if idn_substr:
isub = idn_substr.lower()
for port, idn in matches:
if isub in idn.lower():
return port
return matches[0][0]
__all__ = [
"SerialParams",
"OwonPSU",
"scan_ports",
"auto_detect",
]

30
pytest.ini
View File

@ -1,30 +0,0 @@
[pytest]
# addopts: Default CLI options applied to every pytest run.
# -ra → Show extra test summary info for skipped, xfailed, etc.
# --junitxml=... → Emit JUnit XML for CI systems (machines can parse it).
# --html=... → Generate a human-friendly HTML report after each run.
# --self-contained-html → Inline CSS/JS in the HTML report for easy sharing.
# --tb=short → Short tracebacks to keep logs readable.
# Plugin note: We no longer force-load via `-p conftest_plugin` to avoid ImportError
# on environments where the file might be missing. Instead, `conftest.py` will
# register the plugin if present. The plugin:
# - extracts Title/Description/Requirements/Steps from test docstrings
# - adds custom columns to the HTML report
# - writes requirements_coverage.json and summary.md in reports/
addopts = -ra --junitxml=reports/junit.xml --html=reports/report.html --self-contained-html --tb=short --cov=ecu_framework --cov-report=term-missing
# markers: Document all custom markers so pytest doesn't warn and so usage is clear.
# Use with: pytest -m "markername"
markers =
hardware: requires real hardware (BabyLIN device and ECU); excluded by default in mock runs
babylin: tests that use the BabyLIN interface (may require hardware)
unit: fast, isolated tests (no hardware, no external I/O)
req_001: REQ-001 - Mock interface shall echo transmitted frames for local testing
req_002: REQ-002 - Mock interface shall synthesize deterministic responses for request operations
req_003: REQ-003 - Mock interface shall support frame filtering by ID
req_004: REQ-004 - Mock interface shall handle timeout scenarios gracefully
smoke: Basic functionality validation tests
boundary: Boundary condition and edge case tests
# testpaths: Where pytest looks for tests by default.
testpaths = tests

17
requirements.txt
View File

@ -1,17 +0,0 @@
# Core testing and utilities
pytest>=8,<9 # Test runner and framework (parametrize, fixtures, markers)
pyyaml>=6,<7 # Parse YAML config files under ./config/
pyserial>=3,<4 # Serial communication for Owon PSU and hardware tests
# BabyLIN SDK wrapper requires 'six' on some platforms
six>=1.16,<2
# Test productivity
pytest-xdist>=3.6,<4 # Parallel test execution (e.g., pytest -n auto)
pytest-html>=4,<5 # Generate HTML test reports for CI and sharing
pytest-cov>=5,<6 # Coverage reports for Python packages
# Logging and config extras
configparser>=6,<7 # Optional INI-based config support if you add .ini configs later
colorlog>=6,<7 # Colored logging output for readable test logs
typing-extensions>=4.12,<5 # Typing backports for older Python versions

5
scripts/99-babylin.rules
View File

@ -1,5 +0,0 @@
# Example udev rules for BabyLin-like USB device
# Replace ATTRS{idVendor} and ATTRS{idProduct} with actual values
# Find values with: lsusb
SUBSYSTEM=="usb", ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678", MODE="0660", GROUP="plugdev", TAG+="uaccess"

17
scripts/ecu-tests.service
View File

@ -1,17 +0,0 @@
[Unit]
Description=ECU Tests Runner
After=network-online.target
Wants=network-online.target
[Service]
Type=oneshot
WorkingDirectory=/home/pi/ecu_tests
ExecStart=/home/pi/ecu_tests/scripts/run_tests.sh
User=pi
Group=pi
Environment=ECU_TESTS_CONFIG=/home/pi/ecu_tests/config/test_config.yaml
StandardOutput=append:/home/pi/ecu_tests/reports/service.log
StandardError=append:/home/pi/ecu_tests/reports/service.err
[Install]
WantedBy=multi-user.target

10
scripts/ecu-tests.timer
View File

@ -1,10 +0,0 @@
[Unit]
Description=Schedule ECU Tests Runner
[Timer]
OnBootSec=2min
OnUnitActiveSec=24h
Persistent=true
[Install]
WantedBy=timers.target

63
scripts/pi_install.sh
View File

@ -1,63 +0,0 @@
#!/usr/bin/env bash
set -euo pipefail
# This script installs prerequisites, sets up a venv, installs deps,
# and wires up systemd units on a Raspberry Pi.
# Run as: sudo bash scripts/pi_install.sh /home/pi/ecu_tests
TARGET_DIR="${1:-/home/pi/ecu_tests}"
REPO_URL="${2:-}" # optional; if empty assumes repo already present at TARGET_DIR
PI_USER="${PI_USER:-pi}"
log() { echo "[pi_install] $*"; }
if [[ $EUID -ne 0 ]]; then
echo "Please run as root (sudo)." >&2
exit 1
fi
log "Installing OS packages..."
apt-get update -y
apt-get install -y --no-install-recommends \
python3 python3-venv python3-pip git ca-certificates \
libusb-1.0-0 udev
mkdir -p "$TARGET_DIR"
chown -R "$PI_USER":"$PI_USER" "$TARGET_DIR"
if [[ -n "$REPO_URL" ]]; then
log "Cloning repo: $REPO_URL"
sudo -u "$PI_USER" git clone "$REPO_URL" "$TARGET_DIR" || true
fi
cd "$TARGET_DIR"
log "Creating Python venv..."
sudo -u "$PI_USER" python3 -m venv .venv
log "Installing Python dependencies..."
sudo -u "$PI_USER" bash -lc "source .venv/bin/activate && pip install --upgrade pip && pip install -r requirements.txt"
log "Preparing reports directory..."
mkdir -p reports
chown -R "$PI_USER":"$PI_USER" reports
log "Installing systemd units..."
install -Dm644 scripts/ecu-tests.service /etc/systemd/system/ecu-tests.service
if [[ -f scripts/ecu-tests.timer ]]; then
install -Dm644 scripts/ecu-tests.timer /etc/systemd/system/ecu-tests.timer
fi
systemctl daemon-reload
systemctl enable ecu-tests.service || true
if [[ -f /etc/systemd/system/ecu-tests.timer ]]; then
systemctl enable ecu-tests.timer || true
fi
log "Installing udev rules (if provided)..."
if [[ -f scripts/99-babylin.rules ]]; then
install -Dm644 scripts/99-babylin.rules /etc/udev/rules.d/99-babylin.rules
udevadm control --reload-rules || true
udevadm trigger || true
fi
log "Done. You can start the service with: systemctl start ecu-tests.service"

6
scripts/run_tests.sh
View File

@ -1,6 +0,0 @@
#!/usr/bin/env bash
set -euo pipefail
cd "$(dirname "$0")/.."
source .venv/bin/activate
# optional: export ECU_TESTS_CONFIG=$(pwd)/config/test_config.yaml
python -m pytest -v

29
scripts/run_two_reports.ps1
View File

@ -1,29 +0,0 @@
# Runs two pytest invocations to generate separate HTML/JUnit reports
# - Unit tests → reports/report-unit.html, reports/junit-unit.xml
# - All non-unit tests → reports/report-tests.html, reports/junit-tests.xml
#
# Usage (from repo root, PowerShell):
# .\scripts\run_two_reports.ps1
#
# Notes:
# - We override pytest.ini addopts to avoid duplicate --html/--junitxml and explicitly
# load our custom plugin.
# - Adjust the second marker to exclude hardware if desired (see commented example).
# Ensure reports directory exists
if (-not (Test-Path -LiteralPath "reports")) { New-Item -ItemType Directory -Path "reports" | Out-Null }
# 1) Unit tests report
pytest -q -o addopts="" -p conftest_plugin -ra --tb=short --self-contained-html `
--cov=ecu_framework --cov-report=term-missing `
--html=reports/report-unit.html `
--junitxml=reports/junit-unit.xml `
-m unit
# 2) All non-unit tests (integration/smoke/hardware) report
# To exclude hardware here, change the marker expression to: -m "not unit and not hardware"
pytest -q -o addopts="" -p conftest_plugin -ra --tb=short --self-contained-html `
--cov=ecu_framework --cov-report=term-missing `
--html=reports/report-tests.html `
--junitxml=reports/junit-tests.xml `
-m "not unit"

83
tests/conftest.py
View File

@ -1,83 +0,0 @@
import os
import pathlib
import typing as t
import pytest
from ecu_framework.config import load_config, EcuTestConfig
from ecu_framework.lin.base import LinInterface
from ecu_framework.lin.mock import MockBabyLinInterface
try:
from ecu_framework.lin.babylin import BabyLinInterface # type: ignore
except Exception:
BabyLinInterface = None # type: ignore
WORKSPACE_ROOT = pathlib.Path(__file__).resolve().parents[1]
@pytest.fixture(scope="session")
def config() -> EcuTestConfig:
cfg = load_config(str(WORKSPACE_ROOT))
return cfg
@pytest.fixture(scope="session")
def lin(config: EcuTestConfig) -> t.Iterator[LinInterface]:
iface_type = config.interface.type
if iface_type == "mock":
lin = MockBabyLinInterface(bitrate=config.interface.bitrate, channel=config.interface.channel)
elif iface_type == "babylin":
if BabyLinInterface is None:
pytest.skip("BabyLin interface not available in this environment")
lin = BabyLinInterface(
dll_path=config.interface.dll_path,
bitrate=config.interface.bitrate,
channel=config.interface.channel,
node_name=config.interface.node_name,
func_names=config.interface.func_names,
sdf_path=config.interface.sdf_path,
schedule_nr=config.interface.schedule_nr,
)
else:
raise RuntimeError(f"Unknown interface type: {iface_type}")
lin.connect()
yield lin
lin.disconnect()
@pytest.fixture(scope="session", autouse=False)
def flash_ecu(config: EcuTestConfig, lin: LinInterface) -> None:
if not config.flash.enabled:
pytest.skip("Flashing disabled in config")
# Lazy import to avoid dependency during mock-only runs
from ecu_framework.flashing import HexFlasher
if not config.flash.hex_path:
pytest.skip("No HEX path provided in config")
flasher = HexFlasher(lin)
ok = flasher.flash_hex(config.flash.hex_path)
if not ok:
pytest.fail("ECU flashing failed")
@pytest.fixture
def rp(record_property: "pytest.RecordProperty"):
"""Convenience reporter: attaches a key/value as a test property and echoes to captured output.
Usage in tests:
def test_something(rp):
rp("key", value)
"""
def _rp(key: str, value):
# Attach property (pytest-html will show in Properties table)
record_property(str(key), value)
# Echo to captured output for quick scanning in report details
try:
print(f"[prop] {key}={value}")
except Exception:
pass
return _rp

102
tests/hardware/test_owon_psu.py
View File

@ -1,102 +0,0 @@
import time
import pytest
import serial
from ecu_framework.power import OwonPSU, SerialParams
from ecu_framework.config import EcuTestConfig
pytestmark = [pytest.mark.hardware]
def test_owon_psu_idn_and_optional_set(config: EcuTestConfig, rp):
"""
Title: Owon PSU - IDN, Output Status, Set/Measure Verification
Description:
Validates serial SCPI control of an Owon PSU: IDN retrieval, output status query,
and optional set/measure cycle using values from central configuration.
Test Steps:
1. Load PSU config from EcuTestConfig.power_supply
2. Open serial connection and query *IDN?
3. Query output status (output?) and record initial state
4. If configured, set voltage/current, enable output briefly, measure V/I, then disable output
5. Record IDN, output status before/after, set values, and measured values in the report
Expected Result:
*IDN? returns a non-empty string (containing idn_substr if configured), serial operations succeed,
and, when enabled, the output toggles on then off with measurements returned.
"""
psu_cfg = config.power_supply
if not psu_cfg.enabled:
pytest.skip("Power supply tests disabled in config.power_supply.enabled")
if not psu_cfg.port:
pytest.skip("No power supply 'port' configured (config.power_supply.port)")
# Serial params (with sensible defaults via central config)
baud = int(psu_cfg.baudrate)
timeout = float(psu_cfg.timeout)
parity = psu_cfg.parity or "N"
stopbits = psu_cfg.stopbits or 1
xonxoff = bool(psu_cfg.xonxoff)
rtscts = bool(psu_cfg.rtscts)
dsrdtr = bool(psu_cfg.dsrdtr)
eol = psu_cfg.eol or "\n"
ps = SerialParams(
baudrate=baud,
timeout=timeout,
parity={"N": serial.PARITY_NONE, "E": serial.PARITY_EVEN, "O": serial.PARITY_ODD}.get(str(parity).upper(), serial.PARITY_NONE),
stopbits={1: serial.STOPBITS_ONE, 2: serial.STOPBITS_TWO}.get(int(float(stopbits)), serial.STOPBITS_ONE),
xonxoff=xonxoff,
rtscts=rtscts,
dsrdtr=dsrdtr,
)
want_substr = psu_cfg.idn_substr
do_set = bool(psu_cfg.do_set)
set_v = float(psu_cfg.set_voltage)
set_i = float(psu_cfg.set_current)
port = str(psu_cfg.port).strip()
with OwonPSU(port, ps, eol=eol) as psu:
# Step 2: IDN
idn = psu.idn()
rp("psu_idn", idn)
print(f"PSU IDN: {idn}")
assert isinstance(idn, str)
assert idn != "", "*IDN? returned empty response"
if want_substr:
assert str(want_substr).lower() in idn.lower(), f"IDN does not contain expected substring: {want_substr}. Got: {idn}"
# Step 3: Output status before
out_before = psu.output_status()
rp("output_status_before", str(out_before))
print(f"Output status (before): {out_before}")
if do_set:
# Step 4: Set and measure
rp("set_voltage", set_v)
rp("set_current", set_i)
print(f"Setting: voltage={set_v}V, current={set_i}A")
psu.set_voltage(1, set_v)
psu.set_current(1, set_i)
psu.set_output(True)
time.sleep(1.0) # allow settling
try:
mv = psu.measure_voltage()
mi = psu.measure_current()
rp("measured_voltage", mv)
rp("measured_current", mi)
print(f"Measured: voltage={mv}V, current={mi}A")
finally:
psu.set_output(False)
out_after = psu.output_status()
rp("output_status_after", str(out_after))
print(f"Output status (after): {out_after}")

61
tests/plugin/test_conftest_plugin_artifacts.py
View File

@ -1,61 +0,0 @@
import json
from pathlib import Path
import pytest
# Enable access to the built-in 'pytester' fixture
pytest_plugins = ("pytester",)
@pytest.mark.unit
def test_plugin_writes_artifacts(pytester):
# Make the project root importable so '-p conftest_plugin' works inside pytester
project_root = Path(__file__).resolve().parents[2]
pytester.syspathinsert(str(project_root))
# Create a minimal test file that includes a rich docstring
pytester.makepyfile(
test_sample='''
import pytest
@pytest.mark.req_001
def test_docstring_metadata():
"""
Title: Example Test
Description:
Small sample to exercise the reporting plugin.
Requirements: REQ-001
Test Steps:
1. do it
Expected Result:
- done
"""
assert True
'''
)
# Run pytest in the temporary test environment, loading our reporting plugin
result = pytester.runpytest(
"-q",
"-p",
"conftest_plugin",
"--html=reports/report.html",
"--self-contained-html",
"--junitxml=reports/junit.xml",
)
result.assert_outcomes(passed=1)
# Check for the JSON coverage artifact
cov = pytester.path / "reports" / "requirements_coverage.json"
assert cov.is_file()
data = json.loads(cov.read_text())
# Validate REQ mapping and presence of artifacts
assert "REQ-001" in data["requirements"]
assert data["files"]["html"].endswith("report.html")
assert data["files"]["junit"].endswith("junit.xml")
# Check that the CI summary exists
summary = pytester.path / "reports" / "summary.md"
assert summary.is_file()

48
tests/test_babylin_hardware_schedule_smoke.py
View File

@ -1,48 +0,0 @@
import os
import pathlib
import pytest
# Hardware + babylin + smoke: this is the canonical end-to-end schedule flow
pytestmark = [pytest.mark.hardware, pytest.mark.babylin, pytest.mark.smoke]
WORKSPACE_ROOT = pathlib.Path(__file__).resolve().parents[1]
def test_babylin_sdk_example_flow(config, lin, rp):
"""
Title: BabyLIN SDK Example Flow - Open, Load SDF, Start Schedule, Rx Timeout
Description:
Mirrors the vendor example flow: discover/open, load SDF, start a
schedule, and attempt a receive. Validates that the adapter can perform
the essential control sequence without exceptions and that the receive
path is operational even if it times out.
Requirements: REQ-HW-OPEN, REQ-HW-SDF, REQ-HW-SCHEDULE
Preconditions:
- ECU_TESTS_CONFIG points to a hardware YAML with interface.sdf_path and schedule_nr
- BabyLIN_library.py and native libs placed per vendor/README.md
Test Steps:
1. Verify hardware config requests the BabyLIN SDK with SDF path
2. Connect via fixture (opens device, loads SDF, starts schedule)
3. Try to receive a frame with a short timeout
4. Assert no crash; accept None or a LinFrame (environment-dependent)
Expected Result:
- No exceptions during open/load/start
- Receive returns None (timeout) or a LinFrame
"""
# Step 1: Ensure config is set for hardware with SDK wrapper
assert config.interface.type == "babylin"
assert config.interface.sdf_path is not None
rp("sdf_path", str(config.interface.sdf_path))
rp("schedule_nr", int(config.interface.schedule_nr))
# Step 3: Attempt a short receive to validate RX path while schedule runs
rx = lin.receive(timeout=0.2)
rp("receive_result", "timeout" if rx is None else "frame")
# Step 4: Accept timeout or a valid frame object depending on bus activity
assert rx is None or hasattr(rx, "id")

34
tests/test_babylin_hardware_smoke.py
View File

@ -1,34 +0,0 @@
import pytest
# Mark entire module as hardware + babylin so it's easy to select/deselect via -m
pytestmark = [pytest.mark.hardware, pytest.mark.babylin]
def test_babylin_connect_receive_timeout(lin, rp):
"""
Title: BabyLIN Hardware Smoke - Connect and Timed Receive
Description:
Minimal hardware sanity check that relies on the configured fixtures to
connect to a BabyLIN device and perform a short receive call.
The test is intentionally permissive: it accepts either a valid LinFrame
or a None (timeout) as success, focusing on verifying that the adapter
is functional and not crashing.
Requirements: REQ-HW-SMOKE
Test Steps:
1. Use the 'lin' fixture to connect to the BabyLIN SDK adapter
2. Call receive() with a short timeout
3. Assert the outcome is either a LinFrame or None (timeout)
Expected Result:
- No exceptions are raised
- Return value is None (timeout) or an object with an 'id' attribute
"""
# Step 2: Perform a short receive to verify operability
rx = lin.receive(timeout=0.2)
rp("receive_result", "timeout" if rx is None else "frame")
# Step 3: Accept either a timeout (None) or a frame-like object
assert rx is None or hasattr(rx, "id")

145
tests/test_babylin_wrapper_mock.py
View File

@ -1,145 +0,0 @@
import pytest
from ecu_framework.lin.base import LinFrame
from ecu_framework.lin.babylin import BabyLinInterface
# Inject the pure-Python mock wrapper to run SDK adapter tests without hardware
from vendor import mock_babylin_wrapper as mock_bl
class _MockBytesOnly:
"""Shim exposing BLC_sendRawMasterRequest(bytes) only, to test bytes signature.
We wrap the existing mock but override BLC_sendRawMasterRequest to accept
only the bytes payload form. The response still uses the deterministic pattern
implied by the payload length (zeros are fine; we assert by length here).
"""
@staticmethod
def create_BabyLIN():
base = mock_bl.create_BabyLIN()
def bytes_only(channel, frame_id, payload):
# Delegate to the base mock's bytes variant by ensuring we pass bytes
if not isinstance(payload, (bytes, bytearray)):
raise TypeError("expected bytes payload")
return base.BLC_sendRawMasterRequest(channel, frame_id, bytes(payload))
# Monkey-patch the method to raise TypeError when a length is provided
def patched_raw_req(*args):
# Expected signature: (channel, frame_id, payload_bytes)
if len(args) != 3 or not isinstance(args[2], (bytes, bytearray)):
raise TypeError("bytes signature only")
return bytes_only(*args)
base.BLC_sendRawMasterRequest = patched_raw_req
return base
@pytest.mark.babylin
@pytest.mark.smoke
@pytest.mark.req_001
def test_babylin_sdk_adapter_with_mock_wrapper(rp):
"""
Title: SDK Adapter - Send/Receive with Mock Wrapper
Description:
Validate that the BabyLIN SDK-based adapter can send and receive using
a mocked wrapper exposing BLC_* APIs. The mock implements loopback by
echoing transmitted frames into the receive queue.
Requirements: REQ-001
Test Steps:
1. Construct BabyLinInterface with injected mock wrapper
2. Connect (discovers port, opens, loads SDF, starts schedule)
3. Send a frame via BLC_mon_set_xmit
4. Receive the same frame via BLC_getNextFrameTimeout
5. Disconnect
Expected Result:
- Received frame matches sent frame (ID and payload)
"""
# Step 1-2: Create adapter with wrapper injection and connect
lin = BabyLinInterface(sdf_path="./vendor/Example.sdf", schedule_nr=0, wrapper_module=mock_bl)
rp("wrapper", "mock_bl")
lin.connect()
try:
# Step 3: Transmit a known payload on a chosen ID
tx = LinFrame(id=0x12, data=bytes([0xAA, 0x55, 0x01]))
lin.send(tx)
# Step 4: Receive from the mock's RX queue (loopback)
rx = lin.receive(timeout=0.1)
rp("tx_id", f"0x{tx.id:02X}")
rp("tx_data", list(tx.data))
rp("rx_present", rx is not None)
# Step 5: Validate ID and payload integrity
assert rx is not None, "Expected a frame from mock loopback"
assert rx.id == tx.id
assert rx.data == tx.data
finally:
# Always disconnect to leave the mock in a clean state
lin.disconnect()
@pytest.mark.babylin
@pytest.mark.smoke
@pytest.mark.req_001
@pytest.mark.parametrize("wrapper,expect_pattern", [
(mock_bl, True), # length signature available: expect deterministic pattern
(_MockBytesOnly, False), # bytes-only signature: expect zeros of requested length
])
def test_babylin_master_request_with_mock_wrapper(wrapper, expect_pattern, rp):
"""
Title: SDK Adapter - Master Request using Mock Wrapper
Description:
Verify that request() prefers the SDK's BLC_sendRawMasterRequest when
available. The mock wrapper enqueues a deterministic response where
data[i] = (id + i) & 0xFF, allowing predictable assertions.
Requirements: REQ-001
Test Steps:
1. Construct BabyLinInterface with injected mock wrapper
2. Connect (mock open/initialize)
3. Issue a master request for a specific ID and length
4. Receive the response frame
5. Validate ID and deterministic payload pattern
Expected Result:
- Response frame ID matches request ID
- Response data length matches requested length
- Response data follows deterministic pattern
"""
# Step 1-2: Initialize mock-backed adapter
lin = BabyLinInterface(wrapper_module=wrapper)
rp("wrapper", getattr(wrapper, "__name__", str(wrapper)))
lin.connect()
try:
# Step 3: Request 4 bytes for ID 0x22
req_id = 0x22
length = 4
rp("req_id", f"0x{req_id:02X}")
rp("req_len", length)
rx = lin.request(id=req_id, length=length, timeout=0.1)
# Step 4-5: Validate response
assert rx is not None, "Expected a response from mock master request"
assert rx.id == req_id
if expect_pattern:
# length-signature mock returns deterministic pattern
expected = bytes(((req_id + i) & 0xFF) for i in range(length))
rp("expected_data", list(expected))
rp("rx_data", list(rx.data))
assert rx.data == expected
else:
# bytes-only mock returns exactly the bytes we sent (zeros of requested length)
expected = bytes([0] * length)
rp("expected_data", list(expected))
rp("rx_data", list(rx.data))
assert rx.data == expected
finally:
lin.disconnect()

19
tests/test_hardware_placeholder.py
View File

@ -1,19 +0,0 @@
import pytest
# This module is gated by 'hardware' and 'babylin' markers to only run in hardware jobs
pytestmark = [pytest.mark.hardware, pytest.mark.babylin]
def test_babylin_placeholder():
"""
Title: Hardware Test Placeholder
Description:
Minimal placeholder to verify hardware selection and CI plumbing. It
ensures that -m hardware pipelines and marker-based selection work as
expected even when no specific hardware assertions are needed.
Expected Result:
- Always passes.
"""
assert True

190
tests/test_smoke_mock.py
View File

@ -1,190 +0,0 @@
import pytest
from ecu_framework.lin.base import LinFrame
class TestMockLinInterface:
"""Test suite validating the pure-Python mock LIN interface behavior.
Coverage goals:
- REQ-001: Echo loopback for local testing (send -> receive same frame)
- REQ-002: Deterministic master request responses (no randomness)
- REQ-003: Frame ID filtering in receive()
- REQ-004: Graceful handling of timeout when no frame is available
Notes:
- These tests run entirely without hardware and should be fast and stable.
- The injected mock interface enqueues frames on transmit to emulate a bus.
- Deterministic responses allow exact byte-for-byte assertions.
"""
@pytest.mark.smoke
@pytest.mark.req_001
@pytest.mark.req_003
def test_mock_send_receive_echo(self, lin, rp):
"""
Title: Mock LIN Interface - Send/Receive Echo Test
Description:
Validates that the mock LIN interface correctly echoes frames sent on the bus,
enabling loopback testing without hardware dependencies.
Requirements: REQ-001, REQ-003
Test Steps:
1. Create a LIN frame with specific ID and data payload
2. Send the frame via the mock interface
3. Attempt to receive the echoed frame with ID filtering
4. Verify the received frame matches the transmitted frame exactly
Expected Result:
- Frame is successfully echoed by mock interface
- Received frame ID matches transmitted frame ID (0x12)
- Received frame data payload matches transmitted data [1, 2, 3]
"""
# Step 1: Create test frame with known ID and payload
test_frame = LinFrame(id=0x12, data=bytes([1, 2, 3]))
rp("lin_type", "mock")
rp("tx_id", f"0x{test_frame.id:02X}")
rp("tx_data", list(test_frame.data))
# Step 2: Transmit frame via mock interface (mock will enqueue to RX)
lin.send(test_frame)
# Step 3: Receive echoed frame with ID filtering and timeout
received_frame = lin.receive(id=0x12, timeout=0.5)
rp("rx_present", received_frame is not None)
if received_frame is not None:
rp("rx_id", f"0x{received_frame.id:02X}")
rp("rx_data", list(received_frame.data))
# Step 4: Validate echo functionality and payload integrity
assert received_frame is not None, "Mock interface should echo transmitted frames"
assert received_frame.id == test_frame.id, f"Expected ID {test_frame.id:#x}, got {received_frame.id:#x}"
assert received_frame.data == test_frame.data, f"Expected data {test_frame.data!r}, got {received_frame.data!r}"
@pytest.mark.smoke
@pytest.mark.req_002
def test_mock_request_synthesized_response(self, lin, rp):
"""
Title: Mock LIN Interface - Master Request Response Test
Description:
Validates that the mock interface synthesizes deterministic responses
for master request operations, simulating slave node behavior.
Requirements: REQ-002
Test Steps:
1. Issue a master request for specific frame ID and data length
2. Verify mock interface generates a response frame
3. Validate response frame ID matches request ID
4. Verify response data length matches requested length
5. Confirm response data is deterministic (not random)
Expected Result:
- Mock interface generates response within timeout period
- Response frame ID matches request ID (0x21)
- Response data length equals requested length (4 bytes)
- Response data follows deterministic pattern: [id+0, id+1, id+2, id+3]
"""
# Step 1: Issue master request with specific parameters
request_id = 0x21
requested_length = 4
# Step 2: Execute request operation; mock synthesizes deterministic bytes
rp("lin_type", "mock")
rp("req_id", f"0x{request_id:02X}")
rp("req_len", requested_length)
response_frame = lin.request(id=request_id, length=requested_length, timeout=0.5)
# Step 3: Validate response generation
assert response_frame is not None, "Mock interface should generate response for master requests"
# Step 4: Verify response frame properties (ID and length)
assert response_frame.id == request_id, f"Response ID {response_frame.id:#x} should match request ID {request_id:#x}"
assert len(response_frame.data) == requested_length, f"Response length {len(response_frame.data)} should match requested length {requested_length}"
# Step 5: Validate deterministic response pattern
expected_data = bytes((request_id + i) & 0xFF for i in range(requested_length))
rp("rx_data", list(response_frame.data) if response_frame else None)
rp("expected_data", list(expected_data))
assert response_frame.data == expected_data, f"Response data {response_frame.data!r} should follow deterministic pattern {expected_data!r}"
@pytest.mark.smoke
@pytest.mark.req_004
def test_mock_receive_timeout_behavior(self, lin, rp):
"""
Title: Mock LIN Interface - Receive Timeout Test
Description:
Validates that the mock interface properly handles timeout scenarios
when no matching frames are available for reception.
Requirements: REQ-004
Test Steps:
1. Attempt to receive a frame with non-existent ID
2. Use short timeout to avoid blocking test execution
3. Verify timeout behavior returns None rather than blocking indefinitely
Expected Result:
- Receive operation returns None when no matching frames available
- Operation completes within specified timeout period
- No exceptions or errors during timeout scenario
"""
# Step 1: Attempt to receive frame with ID that hasn't been transmitted
non_existent_id = 0xFF
short_timeout = 0.1 # 100ms timeout
# Step 2: Execute receive with timeout (should return None quickly)
rp("lin_type", "mock")
rp("rx_id", f"0x{non_existent_id:02X}")
rp("timeout_s", short_timeout)
result = lin.receive(id=non_existent_id, timeout=short_timeout)
rp("rx_present", result is not None)
# Step 3: Verify proper timeout behavior (no exceptions, returns None)
assert result is None, "Receive operation should return None when no matching frames available"
@pytest.mark.boundary
@pytest.mark.req_001
@pytest.mark.req_003
@pytest.mark.parametrize("frame_id,data_payload", [
(0x01, bytes([0x55])),
(0x3F, bytes([0xAA, 0x55])),
(0x20, bytes([0x01, 0x02, 0x03, 0x04, 0x05])),
(0x15, bytes([0xFF, 0x00, 0xCC, 0x33, 0xF0, 0x0F, 0xA5, 0x5A])),
])
def test_mock_frame_validation_boundaries(self, lin, rp, frame_id, data_payload):
"""
Title: Mock LIN Interface - Frame Validation Boundaries Test
Description:
Validates mock interface handling of various frame configurations
including boundary conditions for frame IDs and data lengths.
Requirements: REQ-001, REQ-003
Test Steps:
1. Test various valid frame ID values (0x01 to 0x3F)
2. Test different data payload lengths (1 to 8 bytes)
3. Verify proper echo behavior for all valid combinations
Expected Result:
- All valid frame configurations are properly echoed
- Frame ID and data integrity preserved across echo operation
"""
# Step 1: Create frame with parameterized values
test_frame = LinFrame(id=frame_id, data=data_payload)
rp("lin_type", "mock")
rp("tx_id", f"0x{frame_id:02X}")
rp("tx_len", len(data_payload))
# Step 2: Send and receive frame
lin.send(test_frame)
received_frame = lin.receive(id=frame_id, timeout=0.5)
# Step 3: Validate frame integrity across IDs and payload sizes
assert received_frame is not None, f"Frame with ID {frame_id:#x} should be echoed"
assert received_frame.id == frame_id, f"Frame ID should be preserved: expected {frame_id:#x}"
assert received_frame.data == data_payload, f"Frame data should be preserved for ID {frame_id:#x}"

22
tests/unit/test_babylin_adapter_mocked.py
View File

@ -1,22 +0,0 @@
import pytest
from ecu_framework.lin.babylin import BabyLinInterface
from vendor import mock_babylin_wrapper as mock_bl
class _ErrMock:
@staticmethod
def create_BabyLIN():
bl = mock_bl.create_BabyLIN()
# Force loadSDF to return a non-OK code
def fail_load(*args, **kwargs):
return 1 # non BL_OK
bl.BLC_loadSDF = fail_load
return bl
@pytest.mark.unit
def test_connect_sdf_error_raises():
lin = BabyLinInterface(sdf_path="dummy.sdf", wrapper_module=_ErrMock)
with pytest.raises(RuntimeError):
lin.connect()

40
tests/unit/test_config_loader.py
View File

@ -1,40 +0,0 @@
import os
import json
import pathlib
import pytest
from ecu_framework.config import load_config
@pytest.mark.unit
def test_config_precedence_env_overrides(monkeypatch, tmp_path, rp):
# Create a YAML file to use via env var
yaml_path = tmp_path / "cfg.yaml"
yaml_path.write_text("interface:\n type: babylin\n channel: 7\n")
# Point ECU_TESTS_CONFIG to env YAML
monkeypatch.setenv("ECU_TESTS_CONFIG", str(yaml_path))
# Apply overrides on top
cfg = load_config(workspace_root=str(tmp_path), overrides={"interface": {"channel": 9}})
rp("config_source", "env+overrides")
rp("interface_type", cfg.interface.type)
rp("interface_channel", cfg.interface.channel)
# Env file applied
assert cfg.interface.type == "babylin"
# Overrides win
assert cfg.interface.channel == 9
@pytest.mark.unit
def test_config_defaults_when_no_file(monkeypatch, rp):
# Ensure no env path
monkeypatch.delenv("ECU_TESTS_CONFIG", raising=False)
cfg = load_config(workspace_root=None)
rp("config_source", "defaults")
rp("interface_type", cfg.interface.type)
rp("flash_enabled", cfg.flash.enabled)
assert cfg.interface.type == "mock"
assert cfg.flash.enabled is False

32
tests/unit/test_hex_flasher.py
View File

@ -1,32 +0,0 @@
import pytest
from ecu_framework.flashing.hex_flasher import HexFlasher
from ecu_framework.lin.base import LinFrame
class _StubLin:
def __init__(self):
self.sent = []
def connect(self):
pass
def disconnect(self):
pass
def send(self, frame: LinFrame):
self.sent.append(frame)
def receive(self, id=None, timeout=1.0):
return None
@pytest.mark.unit
def test_hex_flasher_sends_basic_sequence(tmp_path, rp):
# Minimal valid Intel HEX file (EOF record)
hex_path = tmp_path / "fw.hex"
hex_path.write_text(":00000001FF\n")
lin = _StubLin()
flasher = HexFlasher(lin)
flasher.flash_hex(str(hex_path))
rp("hex_path", str(hex_path))
rp("sent_count", len(lin.sent))
# Placeholder assertion; refine as the flasher gains functionality
assert isinstance(lin.sent, list)

25
tests/unit/test_linframe.py
View File

@ -1,25 +0,0 @@
import pytest
from ecu_framework.lin.base import LinFrame
@pytest.mark.unit
def test_linframe_accepts_valid_ranges(record_property: "pytest.RecordProperty"): # type: ignore[name-defined]
f = LinFrame(id=0x3F, data=bytes([0] * 8))
record_property("valid_id", f"0x{f.id:02X}")
record_property("data_len", len(f.data))
assert f.id == 0x3F and len(f.data) == 8
@pytest.mark.unit
@pytest.mark.parametrize("bad_id", [-1, 0x40])
def test_linframe_invalid_id_raises(bad_id, record_property: "pytest.RecordProperty"): # type: ignore[name-defined]
record_property("bad_id", bad_id)
with pytest.raises(ValueError):
LinFrame(id=bad_id, data=b"\x00")
@pytest.mark.unit
def test_linframe_too_long_raises(record_property: "pytest.RecordProperty"): # type: ignore[name-defined]
record_property("data_len", 9)
with pytest.raises(ValueError):
LinFrame(id=0x01, data=bytes(range(9)))

326
vendor/BLCInterfaceExample.py vendored
View File

@ -1,326 +0,0 @@
#!/usr/bin/python3
####
# This is a sample program, which introduces the functions and applications of the Baby-LIN-DLL. To run this program you need the current LINWorks software and
# a Baby-LIN device from Lipowsky Industrie-Elektronik GmbH. Make sure that there is a USB connection between your PC and the Baby-LIN-Device and
# that a voltage of 8-26 VDC is applied to the LIN-Bus.
#
# Table of Contents:
# 1. Display Version of Baby-LIN-DLL und Wrapper
# 2. Connection with the Baby-LIN-Device
# 3. Connection to the LIN-Channel
# 4. Write SerialNumber to signal
# 5. Excecute macro and processing MacroResultString
# 6. Use of getsig/setsig for signal handling
# 7. Frame registration and display of the framecallbacks
# 8. Error handling
####
from __future__ import unicode_literals
from asyncio.windows_events import NULL
from ctypes import *
from hashlib import new
import os, sys, argparse, six
try:
# import the BabyLIN Python wrapper
import BabyLIN_library
except ImportError as e:
six.print_(e)
def parse_arguments():
""" """
# get sdf file from the path where the executable is
parser = argparse.ArgumentParser(description="run `main.py` on sdf file")
parser.add_argument("-s", "--sdf", help="sdf file to load",
default="Example.sdf")
parser.add_argument("-v", "--verbose", action="count", default=0)
args = parser.parse_args()
return args.sdf, args.verbose
def main(sdf_name, verbose):
""" Standard example. """
def framecallback(handle, frame):
""" frame callback to be used later."""
six.print_(frame)
return 0
if verbose == 1:
six.print_("Using dynamic library " + BabyLIN.BABYLIN_DLL_PATH_NAME)
# create the BabyLIN class contained in BabyLIN_DLL.py
BabyLIN = BabyLIN_library.create_BabyLIN()
# inject BabyLIN names into local namespace, so you can, e.g. write
# BLC_getVersion instead of BabyLIN.BLC_getVersion
for k, v in BabyLIN.__dict__['_libNames'].items():
globals()[k] = getattr(BabyLIN, k)
if verbose == 1:
six.print_("Using sdf file " + sdf_name)
try:
six.print_("Test programm started")
six.print_("#####################################")
six.print_("")
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 1. Display Version of Baby-LIN-DLL und Wrapper
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Display the version of the BabyLIN DLL and the .net Wrapper
six.print_("DLL and wrapper version are read out")
six.print_("")
dllVersion = BLC_getVersionString()
wrapperVersion = BLC_getWrapperVersion()
six.print_("BabyLIN version: ", dllVersion)
six.print_("BabyLIN python Wrapper version: ", wrapperVersion)
six.print_("")
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 2. Connection with the Baby-LIN-Device
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Search for Baby-LIN devices
# The BLC_getBabyLinPortsTimeout() function is also searching for network devices
# If you are using only Baby-LIN devices with USB port, you can use BLC_getBabyLinPorts()
portCount = 100 # Find up to 100 devices
six.print_("Search for Baby-LIN-Devices for connection...")
portList = BLC_getBabyLinPorts(portCount)
if portList == 0:
six.print_("Could not find any Baby-LIN devices.")
sys.exit(-1)
six.print_(str(len(portList)) + " devices were found for the connection")
six.print_("")
portList = BLC_getBabyLinPortsTimout(portCount, 3000)
if portList == 0:
six.print_("Could not find any Baby-LIN devices.")
sys.exit(-1)
# In this example, we will be using the first found Baby-LIN device
if len(portList) < 1:
six.print_("Could not find any Baby-LIN devices.")
sys.exit(-1)
port = portList[0]
# Open a connection to the first found BabyLIN
six.print_("The connection to the first Baby-LIN-Device of the portlist is established.")
handle = BLC_openPort(port)
if handle == NULL:
six.print_("The connection to the BabyLIN could not be opened. Please check, that the COM Port is correct.")
sys.exit(-1)
# Download the SDF file into the BabyLIN device
six.print_("SDF download...")
six.print_("")
rc = BLC_loadSDF(handle, sdf_name, 1)
if rc != 0:
six.print_("The SDF file could not be loaded into the BabyLIN. Please check, that the filename is correct.")
sys.exit(-1)
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 3. Connection to the LIN-Channel
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Get the number of available channels
six.print_("Output of the channel info")
channelCount = BLC_getChannelCount(handle)
six.print_("available channels: " + str(channelCount))
# the example will open the first device with an included
# LIN channel, download the sdf to it, start the LIN bus,
# register a frame-callback and watch the incoming LIN-frames
# in the callback.
# open the device(s)
conHandle = (handle for port in portList)
# get the device's number of channels
channelCount = ((BLC_getChannelCount(h), h) for h in conHandle)
# among these, look for the first LIN channel:
channelRange = ((range(chNr), h) for chNr, h in channelCount)
# first, get the corresponding channel handles
channelHandle = ((BLC_getChannelHandle(h, channelIndex), h)
for r, h in channelRange for channelIndex in r)
# for each channel (handle), get the channel info
chInfo = ((BLC_getChannelInfo(ch), h, ch) for ch, h in channelHandle)
# using the channel info, filter the LIN channels
# using 'info.type == 0'
conH_chH = ((h, ch) for info, h, ch in chInfo if info.type == 0)
for conHandle, channelHandle in conH_chH:
# for debugging, print ChannelInfo
channelInfos = BLC_getChannelInfo(channelHandle)
six.print_("Channel info: Name=" + str(channelInfos.name) + " , Type=" + str(channelInfos.type) + " , MaxBaudrate=" + str(channelInfos.maxbaudrate))
# start the LIN bus
six.print_("Connect to channel number 1 and start the schedule number 0")
six.print_("")
scheduleNr = 0
rc = BLC_sendCommand(channelHandle, "start schedule " + str(scheduleNr) + ";")
if rc != 0:
six.print_("Could not start the LIN bus.")
sys.exit(-1)
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 4. Write SerialNumber to signal
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Write Signal Serial_Number
# The SDF provides the following signals: SN_Byte_0, SN_Byte_1, SN_Byte_2 ,SN_Byte_3, SN_Byte_4, SN_Byte_5, SN_Byte_6, SN_Byte_7
# With the BLCvarWrite() command the signals can all be written with one operation. The varible data_len determines the number of signals to be set.
# Exactly one byte is assigned to each signal
six.print_("Precessing the serial number")
signal_nr = 0
data_len = 8
data = bytes([83, 78, 48, 49, 50, 51, 52, 53]) # ASCII-Code: "SN012345"
rc = BLC_varWrite(channelHandle, signal_nr, data, data_len)
if rc != 0:
six.print_("Could not write into signal Serial_Number.")
sys.exit(-1)
# Read signal Serial_number for control
# The BLC_varRead() command reads a certain number of signals and stores them in a byte buffer, which is passed to the function when it is called.
# The number of signals to be read is determined by the variable lenght.
lenght = 8
SignalValue = BLC_varRead(channelHandle, signal_nr, lenght)
if SignalValue == 0:
six.print_("Could not read the signal Serial_Number.")
sys.exit(-1)
six.print_("Serial number set via BLC_varWrite command")
six.print_("")
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 5. Excecute macro and processing MacroResultString
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Execute 01_process_SerialNumber
# In this macro the data from the SN_Byte signals are read out and combined to a result string.
# The Baby_LIN_DLL provides a set of Baby_LIN commands which can be executed with the BLC_sendCommand().
#
# The macro_exec command executes the macro with the passed macro number. The BLC command does not wait until the macro is fully executed.
# This must be implemented by the user with the function BLC_macro_result. As long as the macro is still executed, the BLC function returns the value 150.
six.print_("Create MacroResultString out of serial number bytes")
macro_nr = 0
return_value = 0
timeout_ms = 250
rc = BLC_sendCommand(channelHandle, "macro_exec " + str(macro_nr) + ";")
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
rc = BLC_macro_result(channelHandle, macro_nr, timeout_ms)
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
# Get MacroResultString
# When executing a macro it returns a result string after successful completion.This can be set additionally by MAcro command print.
# With parameter passing the values from the signals can be put together to a result string easily. The encoding of the output can also be set,
# which is shown by the two outputs in ASCII code and HEXByte code.
MacroResultStringASCII = BLC_getMacroResultString(channelHandle, macro_nr)
six.print_("Serial number: " + MacroResultStringASCII + "(ASCII Code)")
six.print_("")
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 6. Use of getsig/setsig for signal handling
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Use of getsig and setsig with BLC_sendCommand()
# The BabyLIN commands getsig and setsig are responsible for reading and setting individual signals.
# The signal used is determined by the signal number. This can be found in the bus description of the SDF.
# The signal_flag can be used to determine at which time or event the signal is to be read out:
# signal_flag = 0x00, returns the last value written to the bus signal.
# signal_flag = 0x01, reset fresh flag and wait for fresh signal value appearing on bus.
# signal_flag = 0x02, return signal value as result, if fresh value is availble, otherwise returns RETCODE_OPERATION_PENDING
six.print_("Set the bus signals of brightness by setsig and getsig command")
signal_nr = 8
signal_flag = 0
index = 0
luminanceValue = 100
BLC_sendCommand(channelHandle, "getsig " + str(signal_nr) + " " + str(signal_flag) + ";")
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
rc = BLC_lastAnswerHasData(channelHandle)
if rc == 0:
ByteValue = BLC_getAnswerByIndex(channelHandle, index)
six.print_("Current luminance configuration: " + str(ord(ByteValue)))
# Signal value luminance is set to 100 with BLC_sendCommand "setsig"
rc = BLC_sendCommand(channelHandle, "setsig " + str(signal_nr) + " " + str(luminanceValue) + ";")
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
# Control setsig Command with readout the Signal value again via getsig
rc = BLC_sendCommand(channelHandle, "getsig " + str(signal_nr) + " " + str(signal_flag) + ";")
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
rc = BLC_lastAnswerHasData(channelHandle)
if rc == 0:
ByteValue = BLC_getAnswerByIndex(channelHandle, index)
six.print_("Luminance increased to 100")
six.print_("Current luminance configuration: " + str(ord(ByteValue)))
six.print_("")
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 7. Frame registration and display of the framecallbacks
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Here we will subscribe to get frames and write their data
# The disframe command can be used to subscribe to specific frames. These are determined by the frame ID.
# If you pass 0xff as parameter, a special case is executed and all frames defined in the SDf are subscribed.
# The frames are defined as a structure in the DLL and thus offer the possibility to display all information, such as the FrameID or the timestamp.
six.print_("Subscribe to Frames")
# Subscribe to frames
FrameIDForAllFrames = 0xff
rc = BLC_sendCommand(channelHandle, "disframe " + str(FrameIDForAllFrames) + " 1;")
if rc != 0:
six.print_("BLC command could not be executed.")
sys.exit(-1)
# the output of the callback will fill up the screen quickly
# press <ENTER> to see the incoming frames, and <ENTER> again
# to stop the output
try:
p = "Starting frame callback now...\n"
p += "Press <Enter> to start and stop"
input(p)
except Exception as e:
pass
# register the frame-callback
BLC_registerFrameCallback(channelHandle, framecallback)
try:
input("") # waiting for the next <enter>
except Exception as e:
pass
# de-register the frame-callback
BLC_registerFrameCallback(channelHandle, None)
# stop the LIN-bus
BLC_sendCommand(channelHandle, "stop;")
# close all devices. end of example.
BLC_closeAll()
break
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# 8. Error handling
# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
except BabyLIN.BabyLINException as e:
six.print_(e)
if __name__ == '__main__':
sdf, verbose = parse_arguments()
try:
main(sdf, verbose)
except KeyboardInterrupt:
pass

BIN
vendor/BabyLIN library/BabyLINDLL.chm vendored
View File

Binary file not shown.

1015
vendor/BabyLIN library/Linux_PC/include/BabyLIN.h vendored
View File

File diff suppressed because it is too large Load Diff

2351
vendor/BabyLIN library/Linux_PC/include/BabyLINCAN.h vendored
View File

File diff suppressed because it is too large Load Diff

88
vendor/BabyLIN library/Linux_PC/include/BabyLINCANSDF.h vendored
View File

@ -1,88 +0,0 @@
#ifndef BABYLINCANSDF_H
#define BABYLINCANSDF_H
#include "BabyLINReturncodes.h"
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup sdf_functions
* @{
*/
/**
* @brief Get the SDF's number for node by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getNodeNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for signal by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getSignalNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for frame by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getFrameNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for schedule by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the number of schedule tables in the SDF.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BLC_SDF_getNumSchedules(BL_HANDLE handle);
/**
* @brief Get the SDF's name of schedule by number.
*
* @param handle Handle representing the connection; returned previously by
* getChannelHandle().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BLC_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
/**
* @brief Get the SDF's number for macro by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCANSDF_H

692
vendor/BabyLIN library/Linux_PC/include/BabyLINCAN_nostruct.h vendored
View File

@ -1,692 +0,0 @@
#ifndef BABYLINCAN_NOSTRUCT_H
#define BABYLINCAN_NOSTRUCT_H
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef> // get "size_t", used by function BL_encodeSignal())
#include <cstdint>
extern "C" {
#else
#include <stddef.h> // get "size_t", used by function BL_encodeSignal())
#include <stdint.h>
#endif
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device of the BLC_PORTINFO information, i.e. works as a
* wrapper for @ref BLC_open and @ref BLC_openNet which automatically decides which connection to
* establish.
*
* \note Platform independent way of connecting to BabyLIN-devices found by @ref BLC_getBabyLinPorts
* or @ref BLC_getBabyLinPortsTimout.
*
* \note the BLC_PORTINFO-structure of the BabyLIN to connect to ( see @ref BLC_getBabyLinPorts ) is
* divided in its members here.
*
* @param portNr The Comport number on Windows for serial devices or the TCP port for network
* devices.
* @param type The type of the connection to establish refer to @ref BLC_PORTINFO 's type field
* for value descriptions.
* @param name A 256 character array. name is not yet used and has to have a '\0' as first
* character.
* @param device A 256 character array. device is the path to the serial connection under Linux
* (e.g. /dev/ttyUSB0) or the TCP IP address of the device to connect to.
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not
* be established. You may fetch the corresponding (textual) error with @ref
* BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openPort(int portNr, int type, char* name, char* device);
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device specified by the BLC_PORTINFO derived from the
* given URL.
*
* @param url The device URL to convert might be a system path (/dev/ttyUSB1) for Unix based
* systems, a comport (COM1) as is used for windows or a network address
* (tcp://127.0.0.1:2048) to connect to a network device.
*
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not be
* established or the given URL is malformed. You may fetch the corresponding (textual)
* error with @ref BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openURL(char* url);
/**
* @brief Requests the information about the target
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the connection (see @ref BLC_open )
* @param type The target type refer to @ref BLC_TARGETID for value description.
* @param version The firmware version of the device.
* @param flags The flags as described in @ref BLC_TARGETID.
* @param serial Devices serial number.
* @param heapsize The devices heap size.
* @param numofchannels The number of channels as described in @ref BLC_TARGETID.
* @param name The product name, has to be preallocated.
* @param nameLength Length of the product name array.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getTargetID(BL_HANDLE handle,
unsigned short* type,
unsigned short* version,
unsigned short* flags,
long* serial,
long* heapsize,
long* numofchannels,
char* name,
int nameLength);
/** @brief Retrieve informations about the Channel
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Channel-handle representing the Channel. (see @ref BLC_getChannelHandle)
* @param id The channel id.
* @param type The channel type as described in @ref BLC_CHANNELINFO.
* @param name The channel name, has to be preallocated.
* @param nameLength The size of the name array.
* @param maxbaudrate The maximal baud-rate as described in @ref BLC_CHANNELINFO.
* @param reserved1 Reserved for future use.
* @param reserved2 Reserved for future use.
* @param reserved3 Reserved for future use.
* @param associatedWithSectionNr The index of the section as described in @ref BLC_CHANNELINFO.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getChannelInfo(BL_HANDLE handle,
unsigned short* id,
unsigned short* type,
char* name,
int nameLength,
long* maxbaudrate,
long* reserved1,
long* reserved2,
long* reserved3,
int* associatedWithSectionNr);
/** @brief Get the version string of the library
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function returns the version string of the library.
*
* @param buffer A preallocated buffer to store the version string in.
* @param bufferlen The length of the preallocated buffer.
* @return Returns a C-string with the version information.
*/
int BL_DLLIMPORT BLCns_getVersionString(char* buffer, int bufferlen);
/** @brief Retrieve the last framedata available for a frame
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "disframe" or "mon_on" is sent
* before ( see @ref babylin_commands )
*
* @param handle Is the Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param frameNr Zero based index of requested frame entry.
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled with the frames data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getLastFrame(BL_HANDLE handle,
int frameNr,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value.
* @return The actual number of retrieved BLC_FRAMEs, which might be less than *size on
* input. Status of operation; '=0' means successful, '!=0' otherwise. See
* standard return values for error, or for textual representation (for return
* values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds for new data before it returns with a BL_TIMEOUT return
* code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_FRAMEs, which might be less than *size on input.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next jumbp frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return values
* for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAME to be fetched,
* which must be a positive value.
* @return The actual number of retrieved BLC_JUMBO_FRAMEs, which might be less than
* *size on input. Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual representation (for
* return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next jumbo frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next jumbo frame received from the BabyLIN. If no frame-data is available, the
* function will wait _up to_ timeout_ms milliseconds for new data before it returns with a
* BL_TIMEOUT return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAMEs to be fetched,
* which must be a positive value. On output, the actual number of retrieved
* BLC_JUMBO_FRAMEEs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next signal from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index The signal number of the received signal.
* @param isArray != 0 if the signal is marked as array signal.
* @param value The signal value for non array signals only.
* @param arrayLength The length of the given array and the amount of bytes copied into it.
* @param array The signal data of array signals.
* @param timestamp The timestamp given the signal report by the device.
* @param chId The id of the channel that did report the signal value.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignal(BL_HANDLE handle,
int* index,
int* isArray,
unsigned long long* value,
int* arrayLength,
unsigned char* array,
unsigned long* timestamp,
unsigned short* chId);
/** @brief Fetches the next signals from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retreived signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignals(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int* size);
/** @brief Fetches the next signals for a signal number from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retrieved signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
* @param signalNumber The signal number to return signals for
* @return Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual
* representation (for return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignalsForNumber(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int size,
int signalNumber);
/** @brief Fetches the next Bus error from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the error data from (see @ref
* BLC_getChannelHandle )
* @param timestamp The timestamp when the error was recorded by the device.
* @param type The error type.
* @param status The error status.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextBusError(BL_HANDLE handle,
unsigned long* timestamp,
unsigned short* type,
unsigned short* status);
/** @brief Fetches the next complete DTL request from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL request.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLRequest(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Fetches the next complete DTL response from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL response.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLResponse(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Retrieve further Information about a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* Need a loaded SDF (see @ref BLC_loadSDF or @ref BLC_loadLDF )
* @param handle Handle to a valid connection
* @param filename The loaded SDFs file name.
* @param sectionCount The amount of sections in that SDF.
* @param version_major The SDFs major version.
* @param version_minor The SDFs minor version.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getSDFInfo(BL_HANDLE handle,
char* filename,
short* sectionCount,
short* version_major,
short* version_minor);
/** @brief Retrieve informations about a SDF-Section from a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle handle of a valid connection
* @param infoAboutSectionNr The section number to retrieve information of. Ranges from 0 to the
* number of sections in the loaded SDF (see @ref BLC_getSDFInfo and @ref
* BLC_SDFINFO.sectionCount )
* @param name The sections name.
* @param type The section type e.g. LIN.
* @param nr The section number.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT
BLCns_getSectionInfo(BL_HANDLE handle, int infoAboutSectionNr, char* name, int* type, short* nr);
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCAN_NOSTRUCT_H

859
vendor/BabyLIN library/Linux_PC/include/BabyLINCAN_types.h vendored
View File

@ -1,859 +0,0 @@
#ifndef BABYLINCAN_TYPES_H
#define BABYLINCAN_TYPES_H
#include "BabyLINReturncodes.h"
/** @addtogroup structures
* @brief List of BabyLIN structures
*
* The following structures are used to retrieve data from a running BabyLIN device like frame- and
* signal-reports or error and debug information
* @{
*/
/** @brief Information about a BabyLIN port on the host operating system
*
* The structure holds information about a BabyLIN device connected to the PC Use @ref
* BLC_getBabyLinPorts to retrieve a list of connected BabyLIN-Devices
*
* */
typedef struct _BLC_PORTINFO {
/** @brief The COM-port number the device is connected to (windows only), use this value for
* BLC_open. For Network devices this is the TCP port to connect to.
*/
int portNr;
/** @brief The type of interface of the connected device (0=USBSerial, 1=Not Connectable(Network
* UDP), 2=Network TCP).
*
* Devices of type 1 can not be Connected to via BLC_open...(...).
*/
int type;
/** @brief The name of the connected device (f.ex. BabyLIN RM-II). For Network devices this is the
* hostname of the device.
*/
char name[256];
/** @brief The linux device file the BabyLIN is connected to (linux only) For Network devices this
* is the ip in dot notation.
*/
char device[256];
} BLC_PORTINFO;
/** @brief Information about a connected BabyLIN device
*
* The structure holds information about a connected BabyLIN device retreive informations using
* @ref BLC_getTargetID or request by using @ref BLC_sendCommand with command "targetid"
*
*/
typedef struct _BLC_TARGETID {
/** @brief Type of the hardware
*
* | Value | Device |
* |------:|--------|
* |0x100 |Baby-LIN|
* |0x102 |Baby-LIN-RC |
* |0x103 |Baby-LIN-KS01 |
* |0x200 |Baby-LIN-RM |
* |0x510 |Baby-LIN-MB |
* |0x300 |HARP |
* |0x503 |Baby-LIN-II |
* |0x501 |Baby-LIN-RC-II |
* |0x500 |Baby-LIN-RM-II |
* |0x700 |Baby-LIN-MB-II |
* |0x502 |HARP-4 |
* |0x511 |HARP-5 |
* |0x508 |Baby-LIN-RM-III |
* |0x509 |Baby-LIN-RC-II-B |
* |0x504 |MIF_LIN-II |
* |0x507 |MIF_CAN_FD |
* |0x600 |Virtual_CAN |
* */
unsigned short type;
// ! Firmware version of the device
unsigned short version;
// ! Firmware build number
unsigned short build;
/** @brief Software related flags
*
* |Value|Description|
* |----:|:----------|
* |0x01 |Testversion|
* */
unsigned short flags;
// ! Device's serial number
long serial;
// ! Remaining heap size on device (memory available for SDF dowload)
long heapsize;
// ! number of channels
long numofchannels;
// ! Textual name of the device (zero-terminated C-string)
char name[128];
} BLC_TARGETID;
/**
* @brief Information about a channel on a BabyLIN device
*
* Return data of the command '@ref BLC_getChannelInfo' providing information about a channel
* (BUS-type, speed etc.)
*/
typedef struct _BLC_CHANNELINFO {
/// Channel-id(i.e. 0 = device channel)
unsigned short id;
/// Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
unsigned short type;
/// Textual name of the Channel (zero-terminated C-string)
char name[128];
/// Maximum Baudrate of Channel
long maxbaudrate;
/**
* @brief Flags describing the State of the Channel.
*
* Bit0 : Indicates, whether the channel is disabled, due to missing licences.<br>
* Bit1 : Indicates, that SDFs of version 3 may be uploaded onto this Channel.<br>
* Bit2 : Deprecated: ignore the state of this bit.<br>
* Bit3 : Indicates, that the Channel is initialized (SDF/Section was loaded or Monitor Mode is
* active).<br>
* Bit4 : Indicates, that the channel has the ability and license to send and receive
* CAN FD frames.<br>
* Bit5 : Indicates, that the channel has the ability and license to send and
* receive CAN HS frames.<br>
* Bit6 : Indicates, that the channel has the ability and license to
* send and receive CAN LS frames.
*
* @remark Some bits may not be set by older firmware version.<br>Please consider a firmware
* update.
*/
long reserved1;
/// Reserved value (ignore for now)
long reserved2;
/// Reserved value (ignore for now)
long reserved3;
/// the number of the section of the loaded sdf associated with this channel >= 0 means valid
/// section number, -1: no mapping or no sdf loaded
int associatedWithSectionNr;
} BLC_CHANNELINFO;
// ! Return data of the command @ref BLC_getSDFInfo
typedef struct _BLC_SDFINFO {
// ! Filename of the loaded sdf
char filename[256];
// ! number of sections in the SDF. A file consists of at least one Section (LIN, CAN or DEVICE)
short sectionCount;
// ! SDF-version
short version_major, version_minor;
} BLC_SDFINFO;
// ! Return data of the command @ref BLC_getSectionInfo
typedef struct _BLC_SECTIONINFO {
// ! Textual name of the Section (zero-terminated C-string) as defined using SessionConf
char name[128];
// ! Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
// ! Number of the section within the SDF ( zero-based index )
short nr;
} BLC_SECTIONINFO;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned char lenOfData;
// ! Databytes of the frame
unsigned char frameData[8];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame (only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular CAN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
* */
// clang-format on
short busFlags;
/** @brief Checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_FRAME;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_JUMBO_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned int lenOfData;
// ! Databytes of the frame
unsigned char frameData[1024];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
* | 0x40 | The frame was not actually on the bus, only been mapped as its a SDF like inject |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame ( only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto|
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular LIN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
**/
// clang-format on
short busFlags;
/** @brief checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_JUMBO_FRAME;
/**
* @brief status of a macro
*
* Information about a macro, used as parameter of a callback function registered by @ref
* BLC_registerMacroStateCallback
* */
typedef struct _BLC_MACROSTATE {
// ! channel number this information belongs to
int channelid;
/** @brief Macro-number the information is about
* */
int macronr;
/** @brief The macro command number currently executed
*
* denotes the command-number in the macro @ref macronr which is currently executed
*
* valid if @ref state denotes a running macro
* */
int cmdnr;
/**
* @brief state of the macro execution
*
* |Value|Description|
* |----:|:----------|
* |0x00 |Macro execution ended|
* |0x01 |Macro execution started|
* |0x02 |Macro execution running|
* |0x03 |Macro execution error|
*/
int state;
/**
* @brief Timestamp of the macro state
* @remark Previous BabyLIN DLL v10.22.0 this value was long!
* We recommend to recompile your app using BabyLIN library if you have linked against a
* version previous v10.22.0.
*/
unsigned long timestamp;
} BLC_MACROSTATE;
// ! Carries information about one signal.
typedef struct _BLC_SIGNAL {
// ! Index number of signal; see the SDF for the adequate number
int index;
// ! Defines whether this signal is a normal, value-based one (0) or LIN2.0 array signal (1).
int isArray;
// ! Value of the signal.
unsigned long long value;
// ! Length of the array.
int arrayLength;
// ! Value(s) of the signal, if isArray == 1.
unsigned char array[8];
// ! Global time index of frame transmission start (in usec).
unsigned long timestamp;
// ! Current Channelid
unsigned short chId;
} BLC_SIGNAL;
/* clang-format off */
// ! Represents a BUS error message
typedef struct _BLC_ERROR{
/** @brief Time of occurence.
* The timestamp when the error occurred.
*
* device-timstamp in us if error @ref type is a device error (1-16)
*
* pc timestamp in ms if error @ref type is dll error (65535)
* */
unsigned long timestamp;
/** @brief Error type
*
* | Value | Name | Description | Status |
* |------:|:-----|:------------|:-------|
* |1|ERRTYPE_ID|Parity error in ID||
* |2|ERRTYPE_DATA|Read data from BUS does not match send data|Frame-ID|
* |3|ERRTYPE_FRAMING|Framing error in data reception|Frame-ID|
* |4|ERRTYPE_CHECKSUM|Checksum failed|Frame-ID|
* |5|ERRTYPE_DATATO|Data timed out (incomplete msg reception)|Frame-ID|
* |6|ERRTYPE_SEQ|Unexpected state sequencing|internal status|
* |8|ERRTYPE_MACRO|Error in macro execution|internal status|
* |9|ERRTYPE_BUSBUSY|Bus is already used|internal status|
* |10|ERRTYPE_BUSOFF|Bus is offline (no bus power) |internal status|
* |11|ERRTYPE_BUSSPEED_DIFFERS|Actual bus-speed differs from LDF bus speed (Warning) |actual speed|
* |12|ERRTYPE_RX_FRAME_LEN|Frame length error|Frame-ID|
* |13|ERRTYPE_RX_INCOMPLETE|Incomplete frame received|Frame-ID|
* |14|ERRTYPE_RESP_LOST|Response send buffer overflow occured|unused|
* |15|ERRTYPE_CAN_NOERR|CAN error disappeared|unused|
* |16|ERRTYPE_CAN_ERR|CAN error| bitmap 0x01 noAck<br>bitmap 0x02 stuffing error<br>bitmap 0x04 framing error<br>bitmap 0x08 recessive bit error<br>bitmap 0x10 dominant bit error<br>bitmap 0x20 checksum error|
* |17|ERRTYPE_FRAME_ERR|A received Frame does not match its definition in the SDF|The Frame number in the SDF|
* |18|ERRTYPE_LIN_SHORT_GND|LIN master Bus Low level too lang (master pull-up destroying danger)|unused|
* |19|ERRTYPE_INTERNAL_OVERFLOW|Queue overflow of an internal buffer/queue|internal status|
* |20|ERRTYPE_FLASH_SDF_LOAD|Error while loading SDF from persistent memory|internal status|
* |21|ERRTYPE_TX_HEADER_FAIL|An error occurred during the sending of a frame header|Frame-ID|
* |22|ERRTYPE_NO_CANPHY_SELECT|Bus was started without an activated CAN-Transceiver||
* |23|ERRTYPE_SLAVE_PROTOCOL_TIMEOUT|Slave protocol timeout||
* |24|ERRTYPE_CAN_STUFFERR|A CAN stuff error occurred||
* |25|ERRTYPE_CAN_FORMERR|A CAN form error occurred||
* |26|ERRTYPE_CAN_ACKERR|A CAN ack error occurred||
* |27|ERRTYPE_CAN_RECESSIVEBITERR|A CAN bit recessive error occurred||
* |28|ERRTYPE_CAN_DOMINANTBITERR|A CAN bit dominant error occurred||
* |29|ERRTYPE_CAN_CRCERR|A CAN CRC error occurred||
* |30|ERRTYPE_CAN_SETBYSWERR|A CAN frame can't be send on the bus||
* |31|ERRTYPE_CAN_BUSOFF|The CAN Bus is off||
* |32|ERRTYPE_SDF_LOG_COMMAND|Log file error|0=An internal error occurred<br>1=The log command is unknown<br>2=The log command has too few parameters<br>3=The log command has too many parameters<br>4=The log file handle is invalid<br>10=A parameter is invalid<br>11=The first parameter is mandatory<br>12=The first parameter is no unsigned integer<br>13=The first parameter is no handle<br>14=The first parameter is no valid handle<br>21=The second parameter is mandatory<br>22=The second parameter is no unsigned integer<br>23=The second parameter is no handle<br>24=The second parameter is no valid handle<br>31=The third parameter is mandatory<br>32=The third parameter is no unsigned integer<br>33=The third parameter is no handle<br>34=The third parameter is no valid handle<br>100=Could not create log file<br>101=Could not close log file<br>102=Could not start log file<br>103=Could not stop log file<br>104=Could not pause log file<br>105=Could not resume log file<br>106=Could not write to file|
* |33|ERRTYPE_SD_SDF_LOAD|The SDF could not be loaded from the SD card||
* |34|ERRTYPE_PROTOCOL_DEFINITION|Error on protocol definition|0=Error on CAN ID size<br>1=CAN flags mismatch<br>2=frame size too large|
* |35|ERRTYPE_PROTOCOL_SLAVE|Error on slave protocol||
* |36|ERRTYPE_PROTOCOL_MASTER|Error on master protocol|See macro error codes|
* |256|ERRTYPE_WARN_CANFD_FRAME|Warning: CAN-FD baudrate and flags are inconsistent||
* |257|ERRTYPE_WARN_MISSING_SYSCFG204|Warning: SYSCFG204 not defined||
* |258|ERRTYPE_WARN_CANID_MULTIPLE_USE|CAN ID used in more than one frame definitions||
* |512|ERRTYPE_SLAVE_PROTOCOL_SKIPPED_MIXED_PROTOCOLTYPES|Skipped execution of slave protocol||
* |513|ERRTYPE_SLAVE_PROTOCOL_USE_FIRST|The first of multiple possible services is executed||
* |514|ERRTYPE_LOGGER|A logging error occurred|0=No SD Card in device or no SD Card license<br>1=Log file number 99999 reached, please empty log directory<br>2=No free space on SD card<br>3=Can not open log file|
* |999|ERRTYPE_RUNTIME_SDFCODES|A runtime error occurred in the SDF||
* |61166|ERRTYPE_RUNTIME_DLLCONMBII|MB-II DLL-Connector error|1=Connection lost<br>2=Message lost<br>3=Message dropped|
* |65535|ERRTYPE_RUNTIME_LIBRARY|Error in DLL occurred|1=Connection lost<br>2=Message lost<br>3=Message dropped<br>4=Message was no report and not an answer to a transaction<br>5=The Baby-LIN library was not active for more than 2s<br>6=The Baby-LIN library was not active for more than 3s<br>7=The Baby-LIN library was not active for more than 4s<br>8=The Baby-LIN library was not active for more than 5s|
**/
unsigned short type;
/** @brief Additional error information
*
* Depends on @ref type descriptions.
* for "dll status code":
* |status|description|
* |-----:|:----------|
* |1|Lost connection to device|
**/
unsigned short status;
} BLC_ERROR;
/* clang-format on */
// ! Carries information about DTL protocol (both requests and responses).
typedef struct _BLC_DTL {
// ! Status of protocol frame
BL_DTL_STATUS status;
// ! NAD of protocol frame
unsigned char nad;
// ! Length of the data-array.
int length;
// ! frame data, beginning with the (R)SID.
unsigned char data[4 * 1024];
} BLC_DTL;
// ! Events from a device
typedef struct _BLC_EVENT {
/** @brief Time of occurence.
* The timestamp (of the device (us)) when the error occurred.
* */
unsigned int timestamp;
/** @brief Time of occurence.
* The timestamp (of the PC (ms)) when the error occurred.
* */
unsigned int pc_timestamp;
/* clang-format off */
/** @brief The event that occured
*
* | Value | Name | Description | data |
* |------:|:-----|:------------|:-------|
* |0|EVENTID_REBOOT|The device was rebootet.| |
* |1|EVENTID_HWSTATE|The state of the LIN bus voltage has changed|0: LIN bus voltage missing.\n: LIN bus voltage detected.|
* |3|EVENTID_DIRECT_MODE|||
* |4|EVENTID_BOOTLOADER_START|The bootloader is starting after a reboot.|The second parameter contains the hardware type.|
* |5|EVENTID_FIRMWARE_START|The firmware is starting after a reboot.|The second parameter contains the hardware type.|
* |6|EVENTID_BUSSPEED_CHANGE|The bus speed has changed.|The second parameter is the bus speed.|
* |7|EVENTID_ENLARGE_TIMEOUT_REQ|The firmware requests a change of the default timeout.|For internal use only.|
* |8|EVENTID_REBOOT_TO_FOLLOW|Is sent before the device executes a reboot.||
* |9|EVENTID_INJECTREJECT_BY_FRAMEID|An inject command was rejected.|A protocol with the same RX ID was actually executed.|
* |10|EVENTID_DISCONNECT|Device disconnected from host.|The parameter contains the reason: 0: No command was received from the host and triggered a timeout. 1: A channel crashed and was reset.|
* |999|EVENTID_RUNTIME_ERROR|A runtime error occurred.|The second parameter contains the error code.|
*/
int event;
/* clang-format on */
/** @brief Additional information of an event
*/
long long data;
} BLC_EVENT;
/**
* @brief Type of an ad hoc protocol
*/
typedef enum {
TYPE_RAW = 0,
TYPE_DTL_ISOTP = 1,
TYPE_ISOTP_WITHOUT_NAD = 2,
TYPE_WEBASTO_UHW2 = 3,
TYPE_WEBASTO_STD = 5,
TYPE_KLINE_RAW = 6,
} ADHOC_PROTOCOL_TYPE;
typedef union {
struct {
// any value of PROTOCOL_TYPE
// 0: Raw
// 1: DTL/ISO-TP with NAD
// 2: ISO-TP without NAD (CAN only)
// 3: Webasto KLine UHW V2 (LIN only)
// 4: Raw Jumbo (LIN only)
// 5: Webasto KLine Standard (LIN only)
//
int protocoltype : 6;
unsigned int unused_1 : 5;
// shorten sf (single frame) on transmission
unsigned int tx_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int tx_shortenlcf : 1;
unsigned int unused_2 : 3;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 1;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 1;
// this bit is set for a slave protocol definition
unsigned int slaveprotocol : 1;
// 0: no (Only full frames are accepted) Default bei V0
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted) Default bei V0
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// accept any containersize on reception
unsigned int accept_any_csize : 1;
// send shortened FloawCtrl frame (for CAN only)
unsigned int xmit_shortenflowctrl : 1;
} generic;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
unsigned int unused_1 : 2;
// classic or enhanced checksum
unsigned int xmit_chksumtype : 1;
// classic or enhanced checksum or both
unsigned int expect_chksumtype : 2;
// See generic definition above.
unsigned int xmit_shortensf : 1;
// See generic definition above.
unsigned int xmit_shortenlcf : 1;
unsigned int unused_2 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// See generic definition above.
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} lin;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
// use can FD baudswitch on transmission
unsigned int xmit_canfd_switch : 1;
// use can FD frame on transmission
unsigned int xmit_canfd_frame : 1;
// use can 29 bit frame id if set on transmission
unsigned int xmit_can_11_29bit : 1;
// expect can 29 bit frame id if set on reception
unsigned int expect_can_11_29bit : 2;
// shorten sf (single frame) on transmission
unsigned int xmit_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int xmit_shortenlcf : 1;
unsigned int unused_1 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedlcf : 2;
// 0: no (Only CAN-FD frames without baudswitch are accepted)
// 1: yes (Only CAN-FD frames with baudswitch are accepted)
// 2: ignore, accept both (All CAN-FD frames are accepted)
unsigned int expect_canfd_switch : 2;
// 0: no (Only normal CAN frames are accepted)
// 1: yes (Only CAN-FD frames are accepted)
// 2: ignore, accept both (All CAN frames are accepted)
unsigned int expect_canfd_frame : 2;
// 1: don't wait for FlowControl on IsoTp transmissions
unsigned int xmit_no_flowctrl_wait : 1;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} can;
} ADHOC_PROTOCOL_FLAGS;
// ! Ad-Hoc protocol
typedef struct _BLC_ADHOC_PROTOCOL {
const char* name;
ADHOC_PROTOCOL_FLAGS flags;
unsigned char active;
int req_slot_time;
int rsp_slot_time;
int rsp_delay;
unsigned char fill_byte;
} BLC_ADHOC_PROTOCOL;
typedef union {
struct {
unsigned int unused_1 : 2;
unsigned int unused_2 : 2;
// shorten sf (single frame) on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortensf_txd : 2;
// expect shorten sf (single frame) on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortensf_rcv : 2;
// shorten last consecutive frame on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortenlcf_txd : 2;
// shorten last consecutive frame on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortenlcf_rcv : 2;
unsigned int unused_3 : 8;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 2;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 2;
// Service does not expect a answer, if set
unsigned int requestonly : 1;
unsigned int unused_4 : 2;
// accept any containersize on reception
unsigned int accept_any_csize : 2;
unsigned int unused_5 : 3;
} generic;
struct {
// Checksum type for transmission
// 0: classic
// 1: enhanced
// 2: protocol default
unsigned int checksum_txd : 2;
// Checksum type for reception
// 0: classic
// 1: enhanced
// 2: ignore
unsigned int checksum_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
unsigned int unused_1 : 8;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int unused_2 : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_3 : 3;
} lin;
struct {
// CAN frame id type for transmission
// 0: 11 Bit
// 1: 29 Bit
// 2: Protocol default
unsigned int id_11_29_txd : 2;
// CAN frame id type for reception
// 0: 11 Bit
// 1: 29 Bit
// 2: ignore
unsigned int id_11_29_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
// CAN FD baudrate switching for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdbaudswitch_txd : 2;
// CAN FD baudrate switching for reception
// 0: off
// 1: on
// 2: ignore
unsigned int fdbaudswitch_rcv : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdframe_txd : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: ignore
unsigned int fdframe_rcv : 2;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int no_flowctrl_wait : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_1 : 3;
} can;
} ADHOC_SERVICE_FLAGS;
// ! Ad-Hoc service
typedef struct {
const char* name;
ADHOC_SERVICE_FLAGS flags;
int req_frame_id;
long long req_container_size;
long long req_payload_size;
int req_slot_time;
int rsp_frame_id;
long long rsp_container_size;
long long rsp_payload_size;
int rsp_slot_time;
int rsp_delay;
} BLC_ADHOC_SERVICE;
typedef struct {
int nad;
int p2_extended;
int flow_control_st_min;
int flow_control_block_size;
} BLC_ADHOC_EXECUTE;
// ! Carries information about one signal.
typedef struct _BLC_LOG {
// ! Index number of signal; see the SDF for the adequate number
int format_version;
// ! (0) channel source: channel.id / channel.signal_index, (1) group source: group.id / group.sub_index
unsigned int source_type;
// ! Information about the source of the log
union {
struct {
// ! the channel id
int id;
// ! the signal id
int signal_index;
} channel;
struct {
// ! the group id
int id;
// ! the sub index
int sub_index;
} group;
} source;
// ! unix time index of the log (in sec).
unsigned long long timestamp_unix;
// ! Global time index of the log (in usec).
unsigned long timestamp_usec;
// ! Value type of the value content 0x0 unsigned, 0x1 signed
unsigned int value_signed;
// ! byte size of one element (possible values are one of {1, 2, 4, 8})
unsigned int value_element_size;
// ! array size of the value (is always greater then 0)
unsigned int value_array_size;
// ! values as single value if value_array_size == 1 or as array of values for value_array_size > 1
unsigned char value_data[4 * 1024];
} BLC_LOG;
/** @}*/
/** @addtogroup callback_handling Callback Handling
* @brief List of functions to manage callback functions
*
* The following functions are used to register callback functions for a BabyLIN connection.
* A callback will be called whenever a corresponding message is received on the connection it is
* registered to ( push method ). If you want to use a pull method to retrieve the data, have a look
* at the @ref pull_handling section of the documentation
*
* The device, that generated the callback must not be closed from within the callback.
* @{
*/
// !these Callbacks will tell you the data(as done with old callbacks) AND the Channel which send
// the Data !to find out which Device send the data use => !BL_HANDLE hConnection =
// BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func)(BL_HANDLE, BLC_FRAME frame);
typedef void(BLC_jumboframe_callback_func)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame);
typedef void(BLC_signal_callback_func)(BL_HANDLE, BLC_SIGNAL signal);
typedef void(BLC_macrostate_callback_func)(BL_HANDLE, BLC_MACROSTATE macroState);
typedef void(BLC_error_callback_func)(BL_HANDLE, BLC_ERROR error);
typedef void(BLC_debug_callback_func)(BL_HANDLE, const char* text);
typedef void(BLC_dtl_request_callback_func)(BL_HANDLE, BLC_DTL dtl_request);
typedef void(BLC_dtl_response_callback_func)(BL_HANDLE, BLC_DTL dtl_response);
typedef void(BLC_event_callback_func)(BL_HANDLE, BLC_EVENT event);
// !these Callbacks will tell you the data(as done with old callbacks), plus the Channel which send
// the Data and a user data pointer !added when registering the function !to find out which Device
// send the data use => !BL_HANDLE hConnection = BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func_ptr)(BL_HANDLE, BLC_FRAME frame, void*);
typedef void(BLC_jumboframe_callback_func_ptr)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame, void*);
typedef void(BLC_signal_callback_func_ptr)(BL_HANDLE, BLC_SIGNAL signal, void*);
typedef void(BLC_macrostate_callback_func_ptr)(BL_HANDLE, BLC_MACROSTATE macroState, void*);
typedef void(BLC_error_callback_func_ptr)(BL_HANDLE, BLC_ERROR error, void*);
typedef void(BLC_debug_callback_func_ptr)(BL_HANDLE, const char* text, void*);
typedef void(BLC_dtl_request_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_request, void*);
typedef void(BLC_dtl_response_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_response, void*);
typedef void(BLC_event_callback_func_ptr)(BL_HANDLE, BLC_EVENT event, void*);
typedef void(BLC_log_callback_func_ptr)(BL_HANDLE, BLC_LOG log, void*);
typedef void(BLC_lua_print_func_ptr)(const char* msg, void* userdata);
#endif // BABYLINCAN_TYPES_H

309
vendor/BabyLIN library/Linux_PC/include/BabyLINReturncodes.h vendored
View File

@ -1,309 +0,0 @@
#ifndef BABYLINRETURNCODES_H
#define BABYLINRETURNCODES_H
#if !defined(BL_DLLIMPORT)
#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __declspec(dllexport)
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#else
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __attribute__((visibility("protected")))
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#endif
#else
// #undef BL_DLLIMPORT
// #define BL_DLLIMPORT
#endif
#ifndef DEPRECATED
#ifdef _MSC_VER
#define DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__) | defined(__clang__)
#define DEPRECATED __attribute__((__deprecated__))
#else
#define DEPRECATED
#endif
#endif
// ! @brief represents a connection to a BabyLIN-device or one of the channels
typedef void* BL_HANDLE;
typedef int BL_ADHOC_HANDLE;
typedef const char* CPCHAR;
/** @addtogroup return_values Return Values
* @brief List of possible return values of BabyLINDLL functions
*
* The following values may be returned by BL_ and BLC_ functions to indicate the success or failure
* of an operation. Mostly, the functions will return BL_OK as an indicator for success. However,
* some functions use positive values to return the result of the function on success ( for example
* BL_getFrameCount will return the number of frames ).
* @{
*/
/** Function successfully completed. */
#define BL_OK 0
#define SDF_OK 0
/** Limit for separating BabyLIN- and PC-side errors; below there are all PC-side ones. */
#define BL_PC_SIDE_ERRORS -100000
/** Internal resource allocation problem. Maybe out of memory/handles/etc. */
#define BL_RESOURCE_ERROR -100001
/** Specified handle invalid. */
#define BL_HANDLE_INVALID -100002
/** There is no connection open. */
#define BL_NO_CONNECTION -100003
/** Serial port couldn't be opened or closed. */
#define BL_SERIAL_PORT_ERROR -100004
/** BabyLIN command syntax error. */
#define BL_CMD_SYNTAX_ERROR -100005
/** BabyLIN doesn't answer within timeout. */
#define BL_NO_ANSWER -100006
/** Unable to open a file. */
#define BL_FILE_ERROR -100007
/** Wrong parameter given to function. */
#define BL_WRONG_PARAMETER -100008
/** No data available upon request. */
#define BL_NO_DATA -100009
/** No SDF was loaded previously */
#define BL_NO_SDF -100010
/** Internal message format error */
#define BL_DP_MSG_ERROR -100011
/** The given signal_nr or name does not exist in loaded SDF */
#define BL_SIGNAL_NOT_EXISTENT -100012
/** The signal chosen is a scalar, but an array function was called */
#define BL_SIGNAL_IS_SCALAR -100013
/** The signal chosen is an array, but an scalar function was called */
#define BL_SIGNAL_IS_ARRAY -100014
/** The SDF is unsupported by connected Baby-LIN due to insufficient firmware version */
#define BL_SDF_INSUFFICIENT_FIRMWARE -100015
/** The given signal has no encoding */
#define BL_ENCODING_NOT_EXISTENT -100016
/** The given buffer is too small */
#define BL_BUFFER_TOO_SMALL -100017
/** There is no additional answer data present from last sendCommand-call */
#define BL_NO_ANSWER_DATA -100018
/** Additional data with given index/name not present */
#define BL_ANSWER_DATA_NOT_EXISTENT -100019
/** Device Supported no Channels */
#define BL_NO_CHANNELS_AVAILABLE -100020
/** Unknown command passed to sendCommand */
#define BL_UNKNOWN_COMMAND -100021
/** a sendCommand message timed out */
#define BL_TIMEOUT -100022
/** SDF can not be loaded to a the device due to incompatibility ( incompatible SDFV3 to SDFV2
* device ) */
#define BL_SDF_INCOMPATIBLE -100023
/** value passed as a SDF handle is not valid */
#define SDF_HANDLE_INVALID -100024
/** SDF can not be unloaded as the SDF is in use on a device */
#define SDF_IN_USE -100025
/** can not execute command because SDF download is in progress */
#define BL_DOWNLOAD_IN_PROGRESS -100026
/** function can not be executed due to wrong mode or configuration */
#define BL_INVALID_MODE -100027
/** The number of parameters is not valid for this method. */
#define BLC_UA_EXECUTION_FAILED -100093
/** The number of parameters is not valid for this method. */
#define BLC_UA_INVALID_PARAMETER_COUNT -100094
/** the value could not be read. the reason should be documented in the help file. */
#define BLC_UA_GET_VALUE_REJECTED -100095
/** One of the parameters is invalid. Like a null pointer in a @ref BLC_getUnsignedNumber or a
* value, that is outside of the permitted range, like setting 256 on a 8bit Number property. */
#define BLC_UA_INVALID_PARAMETER -100096
/** the property has no getter for that type e.g. a unsigned number can not be read from a Binary
* property. */
#define BLC_UA_NO_GETTER_DEFINED -100097
/** the property has no setter for that type e.g. a callback can not be stored into Binary property.
*/
#define BLC_UA_NO_SETTER_DEFINED -100098
/** the value given was not set. the reason should be documented in the help file.*/
#define BLC_UA_SET_VALUE_REJECTED -100099
/** A return value between @ref BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref
* BLC_UA_NOT_RESOLVABLE_TAG_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be found. The index of that key is the return value - @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST (this index is 0 based).*/
#define BLC_UA_NOT_RESOLVABLE_TAG_FIRST -100100
/** The given Path should not have more then 100 tags */
#define BLC_UA_NOT_RESOLVABLE_TAG_MAX -100200
/** The @ref ua_service_iso_tp, is supposed to send a request but has no request data. */
#define BLC_UA_NO_REQUEST_DATA -100201
/** During the reception of the Response or the Request a frame timeout occurred. */
#define BLC_UA_SERVICE_FRAME_ORDER -100202
/** A Frame send by the DLL was not echoed by the BabyLIN within timeout_frame milliseconds. You
* might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_SEND -100203
/** The Response was not received within timeout_response milliseconds. Maybe the Request is
* malformed? */
#define BLC_UA_SERVICE_TIMEOUT_RESPONSE -100204
/** A flow-control Frame send by the DLL was not echoed by the BabyLIN within timeout_frame
* milliseconds. You might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_SEND -100205
/** The flow-control state reported by the target is not one of the known states. */
#define BLC_UA_SERVICE_FLOWCONTROL_INVALIDSTATE -100206
/** The flow-control state was "wait"(0x1) in more then max_flow_wait flow-control frames. */
#define BLC_UA_SERVICE_FLOWCONTROL_WAITSTATES -100207
/** The flow-control state was "overflow"(0x2). */
#define BLC_UA_SERVICE_FLOWCONTROL_OVERFLOW -100208
/** The flow-control was not issued by the other node. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_RECEIVE -100209
/** The data for a frame to send can not be put into a frame with the specified frame length. */
#define BLC_UA_SERVICE_FRAME_PACKAGING_ERROR -100210
/** A return value between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be resolved. The index of the object, that could not be
* found is the return value - @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST (this index is 0 based).
*/
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST -101100
/** The given Path should not have more then 100 objects */
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX -101200
//
// ADHOC PROTOCOL ERROR CODES
//
#define BLC_ADHOC_INVALID_HANDLE -1
#define BLC_ADHOC_EXECUTE_RUNNING -102000
#define BLC_ADHOC_MCR_OFFSET 71000
//
// LUA RUNTIME ERROR CODES
//
#define BLC_LUA_RUNTIME_ERROR -103000
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
//-------Return Values from BabyLIN Devices-----------------------------------------------
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
/** Missing or unknown SDF header. This Error occurs when a File is read that is not a SDF File. */
#define BL_ERR_SDF_HEADER 98
/** A corrupted DPMSG was received. This happens when a DPMessage contains an invalid identifier. */
#define BL_ERR_DP_CORRUPT 101
/** An unexpected DPMSG was received. */
#define BL_ERR_DP_SEQUENCE 102
/** The SDF Section Type does not match the Channel Type it is loaded on to. */
#define BL_ERR_DP_MAPPING 103
/** The requested Action can not be carried out on the selected channel. */
#define BL_ERR_CHANNEL 104
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_TYPE 105
/** The Object you are trying to manipulate was never created. */
#define BL_ERR_NULLPOINTER 106
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_MAPPING 107
/** Dataflash/persistent memory could not be initialized. */
#define BL_ERR_DATAFLASH_INIT 108
/** Dataflash/persistent memory does not keep requested SDF index. */
#define BL_ERR_DATAFLASH_INDEX 109
/** Dataflash/persistent memory is to small to hold the SDF. */
#define BL_ERR_DATAFLASH_NOSPACE 110
/** Dataflash/persistent memory read or write error. */
#define BL_ERR_DATAFLASH 111
/** Licence for the requested feature is not installed. */
#define BL_ERR_LICENCE 112
/** Not sufficient Heap Space to perform the requested action. */
#define BL_ERR_HEAP_EXHAUSTED 113
/** Same as ERR_NULLPOINTER but Objects are restricted to Signals. */
#define BL_ERR_SIG_REFERENCE 114
/** Same as ERR_NULLPOINTER but Objects are restricted to Frames. */
#define BL_ERR_FRAME_REFERENCE 115
/** Same as ERR_NULLPOINTER but Objects are restricted to Configurations. */
#define BL_ERR_CFG_REFERENCE 116
/** Same as ERR_NULLPOINTER but Objects are restricted to MacroSelections. */
#define BL_ERR_MACROSEL_REFERENCE 117
/** Same as ERR_NULLPOINTER but Objects are restricted to Events. */
#define BL_ERR_EVENT_REFERENCE 118
/** Same as ERR_NULLPOINTER but Objects are restricted to SignalFunctions. */
#define BL_ERR_SIGFUNC_REFERENCE 119
/** The Loaded SDF is discarded because the checksum is wrong. */
#define BL_ERR_CRC 120
/** Same as ERR_SEQUENCE The requested Component is not yet initialized. */
#define BL_ERR_NOT_INITIALIZED 121
/** Same as ERR_FRAME_REFERENCE. */
#define BL_ERR_FRAMEID_LOOKUP_FAILED 122
/** Same as ERR_NULLPOINTER but Objects are restricted to Macros. */
#define BL_ERR_MACRO_REFERENCE 130
/** A parameter had an invalid value. */
#define BL_ERR_PARAMVALUE 200
/** Condition not be applied or is not full filled. */
#define BL_ERR_CONDITION 210
/** Invalid number of Parameters. */
#define BL_ERR_PARAMCOUNT 211
/** No more Services can be enqueued because the Service queue is full. */
#define BL_ERR_SERVICEQUEUE_EXHAUSTED 300
/** Error Parsing a parameter of a DPMSG. The parameter index will be added onto resulting in the
* final Error code. */
#define BL_ERR_DP_PARSE 900
/** Upper limit of the reserved ERR_DP_PARSE indices. */
#define BL_ERR_DP_PARSE_TOP 980
/** Same as ERR_PARAMVALUE+x but only for Array Size. */
#define BL_ERR_DP_ARRAY_SIZE 989
/** The DPMSG does not start with a message name. */
#define BL_ERR_DP_NONAME 990
/** The DPMSG name is empty. */
#define BL_ERR_DP_NAME_TO_SHORT 991
/** Same as ERR_DP_CORRUPT. Happens when the message name field is longer then the entire message.
*/
#define BL_ERR_DP_NAME_TO_LONG 992
/** Macro Command/Event Action is not known. */
#define BL_CMD_NOT_SUPPORTED 997
/** A not further specified Error. */
#define BL_ERR_UNDEF 998
/** An unknown Command was received. */
#define BL_ERR_UNKNOWN_CMD 999
/** A not further specified Error. */
#define BL_OPERATION_PENDING -1
/** The Macro result can not be read, because the macro is still running. */
#define BL_MACRO_STILL_RUNNING 150
/** The Macro can not be started, because the macro is still running. */
#define BL_MACRO_SAME_RUNNING 151
/** No more parallel Macros are allowed. */
#define BL_MACRO_OTHER_RUNNING 152
/** The Macro could not be started. */
#define BL_MACRO_START_FAIL 153
/** The initial Macro error value. */
#define BL_MACRO_NEVER_EXECUTED 154
/** Macro Result actually contains the error value. */
#define BL_MACRO_ERRCODE_IN_RESULT 155
/** Macro Result actually contains the exception value. */
#define BL_MACRO_EXCEPTIONCODE_IN_RESULT 156
/** @}*/
/**
* @brief type of an answer data token retrieve type using BLC_getAnswerTypeByName or
* BLC_getAnswerTypeByIndex
*/
typedef enum {
/** token is an integer value */
BL_ANSWER_TYPE_INT,
/** token is a string value */
BL_ANSWER_TYPE_STR,
/** token is a binary value */
BL_ANSWER_TYPE_BIN,
/** token is a 64BitInteger value */
BL_ANSWER_TYPE_INT64,
/** token is a Floatingpoint value */
BL_ANSWER_TYPE_FLOAT,
/** token is an unknown value */
BL_ANSWER_TYPE_UNKNOWN,
} BL_ANSWER_TYPE;
/**
* @brief DTL protocol status answers.
* Part of BLC_DTL data structure. Retrieve status of pending
* DTL actions using BLC_getDTLRequestStatus or BLC_getDTLResponseStatus.
*/
typedef enum {
/** DTL action completed */
LD_COMPLETED = 0,
/** DTL action failed */
LD_FAILED,
/** DTL action in progress */
LD_IN_PROGRESS,
} BL_DTL_STATUS;
#endif // BABYLINRETURNCODES_H

92
vendor/BabyLIN library/Linux_PC/include/BabyLINSDF.h vendored
View File

@ -1,92 +0,0 @@
#ifndef BABYLINSDF_H
#define BABYLINSDF_H
#include "BabyLINReturncodes.h"
// ! @brief represents a connection to a BabyLIN-device ( for old BabyLINs ) or
// one of the channels on new BabyLIN-devices
typedef void* BL_HANDLE;
typedef const char* CPCHAR;
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup l_sdf_functions
* @brief List of legacy SDF functions
*
* The following structures are used to retrieve data from a SDF loaded to a BabyLIN. As these
* functions requeire a loaded SDF onto a BabyLIN, a existing connection to a BabyLIN is mendatory.
* Please see the new SDF API in @ref sdf_functions on how to handle SDFs without a BabyLIN
* connection.
* @{
*/
// ! Get the SDF's number for node by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getNodeNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for signal by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getSignalNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for frame by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getFrameNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for schedule by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
// ! Get the number of schedule tables in the SDF.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BL_SDF_getNumSchedules(BL_HANDLE handle);
// ! Get the SDF's name of schedule by number.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BL_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
// ! Get the SDF's number for macro by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINSDF_H

342
vendor/BabyLIN library/Linux_PC/include/BabyLIN_UnifiedAccess.h vendored
View File

@ -1,342 +0,0 @@
#ifndef BABYLIN_UNIFIEDACCESS_H
#define BABYLIN_UNIFIEDACCESS_H
/**
* @addtogroup ua Unified Access
* @brief In the Unified Access interface the available features and values are structured in a tree
* of objects.
*
* @details
* Every object may have children, properties and methods, that are accessible through the __path__
* parameter of the functions. The children, properties and methods are identified by __tags__.
* Those tags are handle specific and described in this document. Additionally they can be listed by
* calling @ref BLC_discover with the handle you are interested in.
*
* ### Creation of new Objects
* To add a new Object into the tree use the @ref BLC_createHandle function. To create a new object
* a using __key value pairs__ ("<key>=<value>") is required. In a path each key value pair has to
* be separated by one space character. Tags valid for the creation keys can be taken from the
* "Creat tags" tables of the Objects documented in this document. The value is specifying the name
* property of the new child. Additionally key value pairs with property tags can be appended, to
* set properties during the object creation, so that less calls to the Setters are required
* afterwards. e.g. creating a @ref ua_protocol_iso_tp in a @ref ua_channel with the name "my_dtl" :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "new_iso_tp_protocol=my_dtl",
* &protocol_handle);
* ~~~
*
* ### Handles of existing Objects
* To find an existing Object in the tree use the @ref BLC_createHandle function. Navigating the
* tree is done by constructing a path by using __key value pairs__ ("<key>=<value>"). Tags valid
* for the keys can be taken from the "Child tags" tables of the Objects documented in this
* document. In a path each key value pair has to be separated by one space character. e.g. getting
* the handle to the previously created @ref ua_protocol_iso_tp of that @ref ua_channel :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "protocol=my_dtl", &protocol_handle);
* ~~~
*
* ### Getters
* To read values of properties use @ref BLC_getSignedNumber, @ref BLC_getUnsignedNumber or @ref
* BLC_getBinary functions. The __path__ parameter has to end with the tag identifying the property
* to read. Valid tags can be taken from the "Property tags" tables of the Objects documented in
* this document. e.g. reading the requestFrameID from a @ref ua_service_iso_tp :
* ~~~.c
* uint64_t requestFrameID;
* BLC_getUnsignedNumber(service_handle, "req_frame_id", &requestFrameID);
* ~~~
*
* ### Setters
* To store values of properties use @ref BLC_setSignedNumber, @ref BLC_setUnsignedNumber, @ref
* BLC_setBinary or @ref BLC_setCallback functions. The __path__ parameter has to end with the tag
* identifying the property to store. Valid tags can be taken from the "Property tags" tables of the
* Objects documented in this document. e.g. setting the requestFrameID of a @ref ua_service_iso_tp
* to 59 :
* ~~~.c
* BLC_setUnsignedNumber(service_handle, "req_frame_id", 59);
* ~~~
*
* ### Execution of Methods
* To execute an object's method use @ref BLC_execute or @ref BLC_execute_async functions. In the
* path variable only the identifying tag is required. Valid tags can be taken from the "Method
* tags" tables of the Objects documented in this document. Functions might have parameters. Those
* can be specified by appending key value pairs to the path in the same manner as when creating new
* objects. The order of the parameters is not relevant. In some cases a synchronous call is not
* applicable, in these cases use @ref BLC_execute_async to execute the method in a dedicated
* thread. e.g. executing a @ref ua_service_iso_tp :
* ~~~.c
* BLC_execute(service_handle, "execute");
* ~~~
* @{
*/
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef>
#include <cstdint>
extern "C" {
#else
#include <stddef.h>
#include <stdint.h>
#endif
/**
* @brief The function prototype used for registering callbacks.
*
* The handle is the handle to the Object, that triggered the callback.<br/> The userdata pointer is
* the userdata specified when registering the callback.
*
* The device, that generated the callback must not be closed from within the callback.
*/
typedef void (*BLC_unifiedaccess_callback_func_ptr)(BL_HANDLE handle, void* userdata);
/**
* @brief The function prototype used for executing asynchron tasks.
*
* The result value is the value returned by the actual execute call.<br/> The handle is the handle
* to the Object, that triggered the callback.<br/> The userdata pointer is the userdata specified
* when registering the callback.<br/>
*/
typedef void (*BLC_unifiedaccess_async_callback_func_ptr)(int32_t result,
BL_HANDLE handle,
void* userdata);
/**
* @brief BLC_createHandle retrieves a handle to a loaded Object or creates a new Object.
*
* These Objects can range from Devices and SDFs down to Signals.<br> When retrieving a handle to
* an existing item the path has to end with a key value pair, where the key is a tag of the objects
* children list. When creating a new Object the "new_*=*" key value pair can be followed by key
* value pairs from the new objects property list, to initialize them.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from key value pairs, separated by spaces e.g.
* "protocol=1 service=2".
* @param result Value to store the new handle in.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the corresponding
* key-value-pair in the path parameter could not be resolved correctly.<br> If the returned value
* is between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX the corresponding key-value-pair in the path parameter
* tries to access a non existing Object.<br> If @ref BLC_UA_GET_VALUE_REJECTED is returned the
* requested Object was found but handles to this type of Object can not be created.<br> In case of
* Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_createHandle(BL_HANDLE handle, const char* path, BL_HANDLE* result);
/**
* @brief BLC_destroy removes the handle from the currently opened Objects and removes the Object
* from its parent.
*
* The given handle will be removed from the available handles and the Object behind it will be
* destroyed.
* @param handle The handle of the object to destroy.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_destroy(BL_HANDLE handle);
/**
* @brief BLC_releaseHandle removes the handle from the currently opened Objects.
*
* The given handle will be release, but a new handle to the underling object can be retrieved
* again.
* @param handle The handle to release.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_releaseHandle(BL_HANDLE handle);
/**
* @brief BLC_discover fills the result array with space separated identifiers, that can be used in
* the path parameters.
*
* Lists the available __Tags__ of the object separated by spaces.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags ending with either
* "property","child", "create", "execute" or "all".<br> "property" will list all __Tags__ usable in
* BLC_get...() and or BLC_set...().<br> "child" will list all __Tags__ usable in BLC_createHandle
* for already existing objects.<br> "create" will list all __Tags__ usable in BLC_createHandle for
* creating new objects.<br> "execute" will list all __Tags__ usable in BLC_execute and
* BLC_execute_async.<br> "all" will list all __Tags__ in the form of "property:=<tags
* >\nchild:=<tags >\ncreate:=<tags >\nexecute:=<tags>".
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, that will be set to the length of
* the result data.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_discover(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_getSignedNumber gets a signed value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed and has less then 64 bits sign extension will be applied, so negative
* values stay negative.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getSignedNumber(BL_HANDLE handle, const char* path, int64_t* result);
/**
* @brief BLC_getUnsignedNumber gets a unsigned value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed no sign extension will be applied, so 8 bit -1 will be 255.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t* result);
/**
* @brief BLC_getBinary gets a binary value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. A only Number or only
* Boolean property will be read as a string representation of it.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, this parameter will be set to the
* length of the result data. If the result buffer is too small no data will be
* copied and only result_length will be updated.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getBinary(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_setSignedNumber sets a signed value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setSignedNumber(BL_HANDLE handle, const char* path, int64_t value);
/**
* @brief BLC_setUnsignedNumber sets an unsigned value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t value);
/**
* @brief BLC_setBinary sets a binary value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. For a only Number or
* only Boolean property the given value will be parsed as a string, that is then handed to @ref
* BLC_setUnsignedNumber or @ref BLC_setSignedNumber.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @param value_length The length of the value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setBinary(BL_HANDLE handle,
const char* path,
const uint8_t* value,
uint32_t value_length);
/**
* @brief BLC_setCallback sets a callback function for an event of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Callback property. Only one
* callback can be registered per event per object.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to set, use a null pointer to deactivate the callback.
* @param userdata The parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setCallback(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_callback_func_ptr callback,
void* userdata);
/**
* @brief BLC_execute executes a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a blocking
* manner.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute(BL_HANDLE handle, const char* path);
/**
* @brief BLC_execute_async a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a non
* blocking manner, so the returned value does not state anything about whether the operation was
* successful, or not, but only if it was found or not. To get the result value you would get from
* @ref BLC_execute use the first parameter of the @ref BLC_unifiedaccess_async_callback_func_ptr.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to call once the operation is complete.
* @param userdata The additional parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute_async(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_async_callback_func_ptr callback,
void* userdata);
#if defined(__cplusplus)
}
#endif
/**
* @}
*/
#endif // BABYLIN_UNIFIEDACCESS_H

120
vendor/BabyLIN library/Linux_PC/include/SDF.h vendored
View File

@ -1,120 +0,0 @@
#ifndef SDF_H
#define SDF_H
#include "BabyLINReturncodes.h"
typedef struct {
int sectionNr;
// ! Sectiontype (i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
char name[64];
char description[4096];
} SDF_SECTIONINFO;
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @addtogroup sdf_functions
* @brief List of SDF functions
*
* The following structures are used to load and retrieve data from a SDF. The API allows to load
* and retrieve SDF informations without an existing BabyLIN-Device connection and is particulaly
* useful for SDF preloading or SDF loading to download to multiple BabyLIN devices. Functions
* prefixed with BLC_ require an existing connection to a BabyLIN with a loaded SDF on the
* corresponding channel.
*
* @{
*/
#define SDF_OK 0
#define SDF_HANDLE_INVALID -100024
#define SDF_IN_USE -100025
typedef void* SDF_HANDLE;
/**
* @brief Loads a SDFile to memory and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_open(const char* filename);
/**
* @brief Loads a LDFFile to memory, creates a temporary SDF and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_openLDF(const char* filename);
/** @brief Closes a SDFile opened using @ref SDF_open
*
* @param[in] handle The SDFile handle to close
* @return 0 on success
*/
int BL_DLLIMPORT SDF_close(SDF_HANDLE handle);
/**
* @brief Returns whether the command overwriting feature for macro names is enabled
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return 0 = feature disabled for this SDF, 1 = feature enabled, commands will be
* interpreted as macro names first, if that fails, it will execute the normal
* command e.g "reboot", if it exists.
*/
int BL_DLLIMPORT SDF_hasMacroCommandOverwriteEnabled(SDF_HANDLE sdfhandle);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sdfhandle The SDFile from @ref SDF_open to download
* @param[in] blhandle The BabyLIN connection handle from @ref BLC_open to download to
* @param[in] mode See @ref BLC_loadSDF modes
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadToDevice(SDF_HANDLE sdfhandle, BL_HANDLE blhandle, int mode);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sectionhandle The SDFile from @ref SDF_open to download
* @param[in] channelhandle The BabyLIN channel handle from @ref BLC_getChannelHandle to download to
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadSectionToChannel(SDF_HANDLE sectionhandle, BL_HANDLE channelhandle);
/**
* @brief Get number of sections in SDF
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return Number of sections ( negative value on error )
*/
int BL_DLLIMPORT SDF_getSectionCount(SDF_HANDLE sdfhandle);
/**
* @brief Get handle to a section of a sdf
* @param[in] handle The handle of the sdf to get the section handle from
* @param[in] sectionNr The section number to get the handle for
* @return Handle to the section ( 0 on error )
*/
SDF_HANDLE BL_DLLIMPORT SDF_getSectionHandle(SDF_HANDLE handle, int sectionNr);
/**
* @brief Get information about a section
* @param[in] handle The section handle to retrieve informations about
* @param[out] info Pointer to pre-allocated @ref SDF_SECTIONINFO structure to fill
* @return 0 on success
*/
int BL_DLLIMPORT SDF_getSectionInfo(SDF_HANDLE handle, SDF_SECTIONINFO* info);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // SDF_H

1015
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLIN.h vendored
View File

File diff suppressed because it is too large Load Diff

2351
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINCAN.h vendored
View File

File diff suppressed because it is too large Load Diff

88
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINCANSDF.h vendored
View File

@ -1,88 +0,0 @@
#ifndef BABYLINCANSDF_H
#define BABYLINCANSDF_H
#include "BabyLINReturncodes.h"
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup sdf_functions
* @{
*/
/**
* @brief Get the SDF's number for node by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getNodeNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for signal by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getSignalNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for frame by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getFrameNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for schedule by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the number of schedule tables in the SDF.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BLC_SDF_getNumSchedules(BL_HANDLE handle);
/**
* @brief Get the SDF's name of schedule by number.
*
* @param handle Handle representing the connection; returned previously by
* getChannelHandle().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BLC_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
/**
* @brief Get the SDF's number for macro by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCANSDF_H

692
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINCAN_nostruct.h vendored
View File

@ -1,692 +0,0 @@
#ifndef BABYLINCAN_NOSTRUCT_H
#define BABYLINCAN_NOSTRUCT_H
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef> // get "size_t", used by function BL_encodeSignal())
#include <cstdint>
extern "C" {
#else
#include <stddef.h> // get "size_t", used by function BL_encodeSignal())
#include <stdint.h>
#endif
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device of the BLC_PORTINFO information, i.e. works as a
* wrapper for @ref BLC_open and @ref BLC_openNet which automatically decides which connection to
* establish.
*
* \note Platform independent way of connecting to BabyLIN-devices found by @ref BLC_getBabyLinPorts
* or @ref BLC_getBabyLinPortsTimout.
*
* \note the BLC_PORTINFO-structure of the BabyLIN to connect to ( see @ref BLC_getBabyLinPorts ) is
* divided in its members here.
*
* @param portNr The Comport number on Windows for serial devices or the TCP port for network
* devices.
* @param type The type of the connection to establish refer to @ref BLC_PORTINFO 's type field
* for value descriptions.
* @param name A 256 character array. name is not yet used and has to have a '\0' as first
* character.
* @param device A 256 character array. device is the path to the serial connection under Linux
* (e.g. /dev/ttyUSB0) or the TCP IP address of the device to connect to.
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not
* be established. You may fetch the corresponding (textual) error with @ref
* BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openPort(int portNr, int type, char* name, char* device);
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device specified by the BLC_PORTINFO derived from the
* given URL.
*
* @param url The device URL to convert might be a system path (/dev/ttyUSB1) for Unix based
* systems, a comport (COM1) as is used for windows or a network address
* (tcp://127.0.0.1:2048) to connect to a network device.
*
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not be
* established or the given URL is malformed. You may fetch the corresponding (textual)
* error with @ref BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openURL(char* url);
/**
* @brief Requests the information about the target
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the connection (see @ref BLC_open )
* @param type The target type refer to @ref BLC_TARGETID for value description.
* @param version The firmware version of the device.
* @param flags The flags as described in @ref BLC_TARGETID.
* @param serial Devices serial number.
* @param heapsize The devices heap size.
* @param numofchannels The number of channels as described in @ref BLC_TARGETID.
* @param name The product name, has to be preallocated.
* @param nameLength Length of the product name array.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getTargetID(BL_HANDLE handle,
unsigned short* type,
unsigned short* version,
unsigned short* flags,
long* serial,
long* heapsize,
long* numofchannels,
char* name,
int nameLength);
/** @brief Retrieve informations about the Channel
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Channel-handle representing the Channel. (see @ref BLC_getChannelHandle)
* @param id The channel id.
* @param type The channel type as described in @ref BLC_CHANNELINFO.
* @param name The channel name, has to be preallocated.
* @param nameLength The size of the name array.
* @param maxbaudrate The maximal baud-rate as described in @ref BLC_CHANNELINFO.
* @param reserved1 Reserved for future use.
* @param reserved2 Reserved for future use.
* @param reserved3 Reserved for future use.
* @param associatedWithSectionNr The index of the section as described in @ref BLC_CHANNELINFO.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getChannelInfo(BL_HANDLE handle,
unsigned short* id,
unsigned short* type,
char* name,
int nameLength,
long* maxbaudrate,
long* reserved1,
long* reserved2,
long* reserved3,
int* associatedWithSectionNr);
/** @brief Get the version string of the library
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function returns the version string of the library.
*
* @param buffer A preallocated buffer to store the version string in.
* @param bufferlen The length of the preallocated buffer.
* @return Returns a C-string with the version information.
*/
int BL_DLLIMPORT BLCns_getVersionString(char* buffer, int bufferlen);
/** @brief Retrieve the last framedata available for a frame
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "disframe" or "mon_on" is sent
* before ( see @ref babylin_commands )
*
* @param handle Is the Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param frameNr Zero based index of requested frame entry.
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled with the frames data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getLastFrame(BL_HANDLE handle,
int frameNr,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value.
* @return The actual number of retrieved BLC_FRAMEs, which might be less than *size on
* input. Status of operation; '=0' means successful, '!=0' otherwise. See
* standard return values for error, or for textual representation (for return
* values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds for new data before it returns with a BL_TIMEOUT return
* code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_FRAMEs, which might be less than *size on input.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next jumbp frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return values
* for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAME to be fetched,
* which must be a positive value.
* @return The actual number of retrieved BLC_JUMBO_FRAMEs, which might be less than
* *size on input. Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual representation (for
* return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next jumbo frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next jumbo frame received from the BabyLIN. If no frame-data is available, the
* function will wait _up to_ timeout_ms milliseconds for new data before it returns with a
* BL_TIMEOUT return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAMEs to be fetched,
* which must be a positive value. On output, the actual number of retrieved
* BLC_JUMBO_FRAMEEs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next signal from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index The signal number of the received signal.
* @param isArray != 0 if the signal is marked as array signal.
* @param value The signal value for non array signals only.
* @param arrayLength The length of the given array and the amount of bytes copied into it.
* @param array The signal data of array signals.
* @param timestamp The timestamp given the signal report by the device.
* @param chId The id of the channel that did report the signal value.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignal(BL_HANDLE handle,
int* index,
int* isArray,
unsigned long long* value,
int* arrayLength,
unsigned char* array,
unsigned long* timestamp,
unsigned short* chId);
/** @brief Fetches the next signals from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retreived signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignals(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int* size);
/** @brief Fetches the next signals for a signal number from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retrieved signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
* @param signalNumber The signal number to return signals for
* @return Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual
* representation (for return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignalsForNumber(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int size,
int signalNumber);
/** @brief Fetches the next Bus error from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the error data from (see @ref
* BLC_getChannelHandle )
* @param timestamp The timestamp when the error was recorded by the device.
* @param type The error type.
* @param status The error status.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextBusError(BL_HANDLE handle,
unsigned long* timestamp,
unsigned short* type,
unsigned short* status);
/** @brief Fetches the next complete DTL request from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL request.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLRequest(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Fetches the next complete DTL response from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL response.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLResponse(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Retrieve further Information about a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* Need a loaded SDF (see @ref BLC_loadSDF or @ref BLC_loadLDF )
* @param handle Handle to a valid connection
* @param filename The loaded SDFs file name.
* @param sectionCount The amount of sections in that SDF.
* @param version_major The SDFs major version.
* @param version_minor The SDFs minor version.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getSDFInfo(BL_HANDLE handle,
char* filename,
short* sectionCount,
short* version_major,
short* version_minor);
/** @brief Retrieve informations about a SDF-Section from a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle handle of a valid connection
* @param infoAboutSectionNr The section number to retrieve information of. Ranges from 0 to the
* number of sections in the loaded SDF (see @ref BLC_getSDFInfo and @ref
* BLC_SDFINFO.sectionCount )
* @param name The sections name.
* @param type The section type e.g. LIN.
* @param nr The section number.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT
BLCns_getSectionInfo(BL_HANDLE handle, int infoAboutSectionNr, char* name, int* type, short* nr);
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCAN_NOSTRUCT_H

859
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINCAN_types.h vendored
View File

@ -1,859 +0,0 @@
#ifndef BABYLINCAN_TYPES_H
#define BABYLINCAN_TYPES_H
#include "BabyLINReturncodes.h"
/** @addtogroup structures
* @brief List of BabyLIN structures
*
* The following structures are used to retrieve data from a running BabyLIN device like frame- and
* signal-reports or error and debug information
* @{
*/
/** @brief Information about a BabyLIN port on the host operating system
*
* The structure holds information about a BabyLIN device connected to the PC Use @ref
* BLC_getBabyLinPorts to retrieve a list of connected BabyLIN-Devices
*
* */
typedef struct _BLC_PORTINFO {
/** @brief The COM-port number the device is connected to (windows only), use this value for
* BLC_open. For Network devices this is the TCP port to connect to.
*/
int portNr;
/** @brief The type of interface of the connected device (0=USBSerial, 1=Not Connectable(Network
* UDP), 2=Network TCP).
*
* Devices of type 1 can not be Connected to via BLC_open...(...).
*/
int type;
/** @brief The name of the connected device (f.ex. BabyLIN RM-II). For Network devices this is the
* hostname of the device.
*/
char name[256];
/** @brief The linux device file the BabyLIN is connected to (linux only) For Network devices this
* is the ip in dot notation.
*/
char device[256];
} BLC_PORTINFO;
/** @brief Information about a connected BabyLIN device
*
* The structure holds information about a connected BabyLIN device retreive informations using
* @ref BLC_getTargetID or request by using @ref BLC_sendCommand with command "targetid"
*
*/
typedef struct _BLC_TARGETID {
/** @brief Type of the hardware
*
* | Value | Device |
* |------:|--------|
* |0x100 |Baby-LIN|
* |0x102 |Baby-LIN-RC |
* |0x103 |Baby-LIN-KS01 |
* |0x200 |Baby-LIN-RM |
* |0x510 |Baby-LIN-MB |
* |0x300 |HARP |
* |0x503 |Baby-LIN-II |
* |0x501 |Baby-LIN-RC-II |
* |0x500 |Baby-LIN-RM-II |
* |0x700 |Baby-LIN-MB-II |
* |0x502 |HARP-4 |
* |0x511 |HARP-5 |
* |0x508 |Baby-LIN-RM-III |
* |0x509 |Baby-LIN-RC-II-B |
* |0x504 |MIF_LIN-II |
* |0x507 |MIF_CAN_FD |
* |0x600 |Virtual_CAN |
* */
unsigned short type;
// ! Firmware version of the device
unsigned short version;
// ! Firmware build number
unsigned short build;
/** @brief Software related flags
*
* |Value|Description|
* |----:|:----------|
* |0x01 |Testversion|
* */
unsigned short flags;
// ! Device's serial number
long serial;
// ! Remaining heap size on device (memory available for SDF dowload)
long heapsize;
// ! number of channels
long numofchannels;
// ! Textual name of the device (zero-terminated C-string)
char name[128];
} BLC_TARGETID;
/**
* @brief Information about a channel on a BabyLIN device
*
* Return data of the command '@ref BLC_getChannelInfo' providing information about a channel
* (BUS-type, speed etc.)
*/
typedef struct _BLC_CHANNELINFO {
/// Channel-id(i.e. 0 = device channel)
unsigned short id;
/// Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
unsigned short type;
/// Textual name of the Channel (zero-terminated C-string)
char name[128];
/// Maximum Baudrate of Channel
long maxbaudrate;
/**
* @brief Flags describing the State of the Channel.
*
* Bit0 : Indicates, whether the channel is disabled, due to missing licences.<br>
* Bit1 : Indicates, that SDFs of version 3 may be uploaded onto this Channel.<br>
* Bit2 : Deprecated: ignore the state of this bit.<br>
* Bit3 : Indicates, that the Channel is initialized (SDF/Section was loaded or Monitor Mode is
* active).<br>
* Bit4 : Indicates, that the channel has the ability and license to send and receive
* CAN FD frames.<br>
* Bit5 : Indicates, that the channel has the ability and license to send and
* receive CAN HS frames.<br>
* Bit6 : Indicates, that the channel has the ability and license to
* send and receive CAN LS frames.
*
* @remark Some bits may not be set by older firmware version.<br>Please consider a firmware
* update.
*/
long reserved1;
/// Reserved value (ignore for now)
long reserved2;
/// Reserved value (ignore for now)
long reserved3;
/// the number of the section of the loaded sdf associated with this channel >= 0 means valid
/// section number, -1: no mapping or no sdf loaded
int associatedWithSectionNr;
} BLC_CHANNELINFO;
// ! Return data of the command @ref BLC_getSDFInfo
typedef struct _BLC_SDFINFO {
// ! Filename of the loaded sdf
char filename[256];
// ! number of sections in the SDF. A file consists of at least one Section (LIN, CAN or DEVICE)
short sectionCount;
// ! SDF-version
short version_major, version_minor;
} BLC_SDFINFO;
// ! Return data of the command @ref BLC_getSectionInfo
typedef struct _BLC_SECTIONINFO {
// ! Textual name of the Section (zero-terminated C-string) as defined using SessionConf
char name[128];
// ! Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
// ! Number of the section within the SDF ( zero-based index )
short nr;
} BLC_SECTIONINFO;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned char lenOfData;
// ! Databytes of the frame
unsigned char frameData[8];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame (only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular CAN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
* */
// clang-format on
short busFlags;
/** @brief Checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_FRAME;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_JUMBO_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned int lenOfData;
// ! Databytes of the frame
unsigned char frameData[1024];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
* | 0x40 | The frame was not actually on the bus, only been mapped as its a SDF like inject |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame ( only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto|
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular LIN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
**/
// clang-format on
short busFlags;
/** @brief checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_JUMBO_FRAME;
/**
* @brief status of a macro
*
* Information about a macro, used as parameter of a callback function registered by @ref
* BLC_registerMacroStateCallback
* */
typedef struct _BLC_MACROSTATE {
// ! channel number this information belongs to
int channelid;
/** @brief Macro-number the information is about
* */
int macronr;
/** @brief The macro command number currently executed
*
* denotes the command-number in the macro @ref macronr which is currently executed
*
* valid if @ref state denotes a running macro
* */
int cmdnr;
/**
* @brief state of the macro execution
*
* |Value|Description|
* |----:|:----------|
* |0x00 |Macro execution ended|
* |0x01 |Macro execution started|
* |0x02 |Macro execution running|
* |0x03 |Macro execution error|
*/
int state;
/**
* @brief Timestamp of the macro state
* @remark Previous BabyLIN DLL v10.22.0 this value was long!
* We recommend to recompile your app using BabyLIN library if you have linked against a
* version previous v10.22.0.
*/
unsigned long timestamp;
} BLC_MACROSTATE;
// ! Carries information about one signal.
typedef struct _BLC_SIGNAL {
// ! Index number of signal; see the SDF for the adequate number
int index;
// ! Defines whether this signal is a normal, value-based one (0) or LIN2.0 array signal (1).
int isArray;
// ! Value of the signal.
unsigned long long value;
// ! Length of the array.
int arrayLength;
// ! Value(s) of the signal, if isArray == 1.
unsigned char array[8];
// ! Global time index of frame transmission start (in usec).
unsigned long timestamp;
// ! Current Channelid
unsigned short chId;
} BLC_SIGNAL;
/* clang-format off */
// ! Represents a BUS error message
typedef struct _BLC_ERROR{
/** @brief Time of occurence.
* The timestamp when the error occurred.
*
* device-timstamp in us if error @ref type is a device error (1-16)
*
* pc timestamp in ms if error @ref type is dll error (65535)
* */
unsigned long timestamp;
/** @brief Error type
*
* | Value | Name | Description | Status |
* |------:|:-----|:------------|:-------|
* |1|ERRTYPE_ID|Parity error in ID||
* |2|ERRTYPE_DATA|Read data from BUS does not match send data|Frame-ID|
* |3|ERRTYPE_FRAMING|Framing error in data reception|Frame-ID|
* |4|ERRTYPE_CHECKSUM|Checksum failed|Frame-ID|
* |5|ERRTYPE_DATATO|Data timed out (incomplete msg reception)|Frame-ID|
* |6|ERRTYPE_SEQ|Unexpected state sequencing|internal status|
* |8|ERRTYPE_MACRO|Error in macro execution|internal status|
* |9|ERRTYPE_BUSBUSY|Bus is already used|internal status|
* |10|ERRTYPE_BUSOFF|Bus is offline (no bus power) |internal status|
* |11|ERRTYPE_BUSSPEED_DIFFERS|Actual bus-speed differs from LDF bus speed (Warning) |actual speed|
* |12|ERRTYPE_RX_FRAME_LEN|Frame length error|Frame-ID|
* |13|ERRTYPE_RX_INCOMPLETE|Incomplete frame received|Frame-ID|
* |14|ERRTYPE_RESP_LOST|Response send buffer overflow occured|unused|
* |15|ERRTYPE_CAN_NOERR|CAN error disappeared|unused|
* |16|ERRTYPE_CAN_ERR|CAN error| bitmap 0x01 noAck<br>bitmap 0x02 stuffing error<br>bitmap 0x04 framing error<br>bitmap 0x08 recessive bit error<br>bitmap 0x10 dominant bit error<br>bitmap 0x20 checksum error|
* |17|ERRTYPE_FRAME_ERR|A received Frame does not match its definition in the SDF|The Frame number in the SDF|
* |18|ERRTYPE_LIN_SHORT_GND|LIN master Bus Low level too lang (master pull-up destroying danger)|unused|
* |19|ERRTYPE_INTERNAL_OVERFLOW|Queue overflow of an internal buffer/queue|internal status|
* |20|ERRTYPE_FLASH_SDF_LOAD|Error while loading SDF from persistent memory|internal status|
* |21|ERRTYPE_TX_HEADER_FAIL|An error occurred during the sending of a frame header|Frame-ID|
* |22|ERRTYPE_NO_CANPHY_SELECT|Bus was started without an activated CAN-Transceiver||
* |23|ERRTYPE_SLAVE_PROTOCOL_TIMEOUT|Slave protocol timeout||
* |24|ERRTYPE_CAN_STUFFERR|A CAN stuff error occurred||
* |25|ERRTYPE_CAN_FORMERR|A CAN form error occurred||
* |26|ERRTYPE_CAN_ACKERR|A CAN ack error occurred||
* |27|ERRTYPE_CAN_RECESSIVEBITERR|A CAN bit recessive error occurred||
* |28|ERRTYPE_CAN_DOMINANTBITERR|A CAN bit dominant error occurred||
* |29|ERRTYPE_CAN_CRCERR|A CAN CRC error occurred||
* |30|ERRTYPE_CAN_SETBYSWERR|A CAN frame can't be send on the bus||
* |31|ERRTYPE_CAN_BUSOFF|The CAN Bus is off||
* |32|ERRTYPE_SDF_LOG_COMMAND|Log file error|0=An internal error occurred<br>1=The log command is unknown<br>2=The log command has too few parameters<br>3=The log command has too many parameters<br>4=The log file handle is invalid<br>10=A parameter is invalid<br>11=The first parameter is mandatory<br>12=The first parameter is no unsigned integer<br>13=The first parameter is no handle<br>14=The first parameter is no valid handle<br>21=The second parameter is mandatory<br>22=The second parameter is no unsigned integer<br>23=The second parameter is no handle<br>24=The second parameter is no valid handle<br>31=The third parameter is mandatory<br>32=The third parameter is no unsigned integer<br>33=The third parameter is no handle<br>34=The third parameter is no valid handle<br>100=Could not create log file<br>101=Could not close log file<br>102=Could not start log file<br>103=Could not stop log file<br>104=Could not pause log file<br>105=Could not resume log file<br>106=Could not write to file|
* |33|ERRTYPE_SD_SDF_LOAD|The SDF could not be loaded from the SD card||
* |34|ERRTYPE_PROTOCOL_DEFINITION|Error on protocol definition|0=Error on CAN ID size<br>1=CAN flags mismatch<br>2=frame size too large|
* |35|ERRTYPE_PROTOCOL_SLAVE|Error on slave protocol||
* |36|ERRTYPE_PROTOCOL_MASTER|Error on master protocol|See macro error codes|
* |256|ERRTYPE_WARN_CANFD_FRAME|Warning: CAN-FD baudrate and flags are inconsistent||
* |257|ERRTYPE_WARN_MISSING_SYSCFG204|Warning: SYSCFG204 not defined||
* |258|ERRTYPE_WARN_CANID_MULTIPLE_USE|CAN ID used in more than one frame definitions||
* |512|ERRTYPE_SLAVE_PROTOCOL_SKIPPED_MIXED_PROTOCOLTYPES|Skipped execution of slave protocol||
* |513|ERRTYPE_SLAVE_PROTOCOL_USE_FIRST|The first of multiple possible services is executed||
* |514|ERRTYPE_LOGGER|A logging error occurred|0=No SD Card in device or no SD Card license<br>1=Log file number 99999 reached, please empty log directory<br>2=No free space on SD card<br>3=Can not open log file|
* |999|ERRTYPE_RUNTIME_SDFCODES|A runtime error occurred in the SDF||
* |61166|ERRTYPE_RUNTIME_DLLCONMBII|MB-II DLL-Connector error|1=Connection lost<br>2=Message lost<br>3=Message dropped|
* |65535|ERRTYPE_RUNTIME_LIBRARY|Error in DLL occurred|1=Connection lost<br>2=Message lost<br>3=Message dropped<br>4=Message was no report and not an answer to a transaction<br>5=The Baby-LIN library was not active for more than 2s<br>6=The Baby-LIN library was not active for more than 3s<br>7=The Baby-LIN library was not active for more than 4s<br>8=The Baby-LIN library was not active for more than 5s|
**/
unsigned short type;
/** @brief Additional error information
*
* Depends on @ref type descriptions.
* for "dll status code":
* |status|description|
* |-----:|:----------|
* |1|Lost connection to device|
**/
unsigned short status;
} BLC_ERROR;
/* clang-format on */
// ! Carries information about DTL protocol (both requests and responses).
typedef struct _BLC_DTL {
// ! Status of protocol frame
BL_DTL_STATUS status;
// ! NAD of protocol frame
unsigned char nad;
// ! Length of the data-array.
int length;
// ! frame data, beginning with the (R)SID.
unsigned char data[4 * 1024];
} BLC_DTL;
// ! Events from a device
typedef struct _BLC_EVENT {
/** @brief Time of occurence.
* The timestamp (of the device (us)) when the error occurred.
* */
unsigned int timestamp;
/** @brief Time of occurence.
* The timestamp (of the PC (ms)) when the error occurred.
* */
unsigned int pc_timestamp;
/* clang-format off */
/** @brief The event that occured
*
* | Value | Name | Description | data |
* |------:|:-----|:------------|:-------|
* |0|EVENTID_REBOOT|The device was rebootet.| |
* |1|EVENTID_HWSTATE|The state of the LIN bus voltage has changed|0: LIN bus voltage missing.\n: LIN bus voltage detected.|
* |3|EVENTID_DIRECT_MODE|||
* |4|EVENTID_BOOTLOADER_START|The bootloader is starting after a reboot.|The second parameter contains the hardware type.|
* |5|EVENTID_FIRMWARE_START|The firmware is starting after a reboot.|The second parameter contains the hardware type.|
* |6|EVENTID_BUSSPEED_CHANGE|The bus speed has changed.|The second parameter is the bus speed.|
* |7|EVENTID_ENLARGE_TIMEOUT_REQ|The firmware requests a change of the default timeout.|For internal use only.|
* |8|EVENTID_REBOOT_TO_FOLLOW|Is sent before the device executes a reboot.||
* |9|EVENTID_INJECTREJECT_BY_FRAMEID|An inject command was rejected.|A protocol with the same RX ID was actually executed.|
* |10|EVENTID_DISCONNECT|Device disconnected from host.|The parameter contains the reason: 0: No command was received from the host and triggered a timeout. 1: A channel crashed and was reset.|
* |999|EVENTID_RUNTIME_ERROR|A runtime error occurred.|The second parameter contains the error code.|
*/
int event;
/* clang-format on */
/** @brief Additional information of an event
*/
long long data;
} BLC_EVENT;
/**
* @brief Type of an ad hoc protocol
*/
typedef enum {
TYPE_RAW = 0,
TYPE_DTL_ISOTP = 1,
TYPE_ISOTP_WITHOUT_NAD = 2,
TYPE_WEBASTO_UHW2 = 3,
TYPE_WEBASTO_STD = 5,
TYPE_KLINE_RAW = 6,
} ADHOC_PROTOCOL_TYPE;
typedef union {
struct {
// any value of PROTOCOL_TYPE
// 0: Raw
// 1: DTL/ISO-TP with NAD
// 2: ISO-TP without NAD (CAN only)
// 3: Webasto KLine UHW V2 (LIN only)
// 4: Raw Jumbo (LIN only)
// 5: Webasto KLine Standard (LIN only)
//
int protocoltype : 6;
unsigned int unused_1 : 5;
// shorten sf (single frame) on transmission
unsigned int tx_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int tx_shortenlcf : 1;
unsigned int unused_2 : 3;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 1;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 1;
// this bit is set for a slave protocol definition
unsigned int slaveprotocol : 1;
// 0: no (Only full frames are accepted) Default bei V0
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted) Default bei V0
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// accept any containersize on reception
unsigned int accept_any_csize : 1;
// send shortened FloawCtrl frame (for CAN only)
unsigned int xmit_shortenflowctrl : 1;
} generic;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
unsigned int unused_1 : 2;
// classic or enhanced checksum
unsigned int xmit_chksumtype : 1;
// classic or enhanced checksum or both
unsigned int expect_chksumtype : 2;
// See generic definition above.
unsigned int xmit_shortensf : 1;
// See generic definition above.
unsigned int xmit_shortenlcf : 1;
unsigned int unused_2 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// See generic definition above.
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} lin;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
// use can FD baudswitch on transmission
unsigned int xmit_canfd_switch : 1;
// use can FD frame on transmission
unsigned int xmit_canfd_frame : 1;
// use can 29 bit frame id if set on transmission
unsigned int xmit_can_11_29bit : 1;
// expect can 29 bit frame id if set on reception
unsigned int expect_can_11_29bit : 2;
// shorten sf (single frame) on transmission
unsigned int xmit_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int xmit_shortenlcf : 1;
unsigned int unused_1 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedlcf : 2;
// 0: no (Only CAN-FD frames without baudswitch are accepted)
// 1: yes (Only CAN-FD frames with baudswitch are accepted)
// 2: ignore, accept both (All CAN-FD frames are accepted)
unsigned int expect_canfd_switch : 2;
// 0: no (Only normal CAN frames are accepted)
// 1: yes (Only CAN-FD frames are accepted)
// 2: ignore, accept both (All CAN frames are accepted)
unsigned int expect_canfd_frame : 2;
// 1: don't wait for FlowControl on IsoTp transmissions
unsigned int xmit_no_flowctrl_wait : 1;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} can;
} ADHOC_PROTOCOL_FLAGS;
// ! Ad-Hoc protocol
typedef struct _BLC_ADHOC_PROTOCOL {
const char* name;
ADHOC_PROTOCOL_FLAGS flags;
unsigned char active;
int req_slot_time;
int rsp_slot_time;
int rsp_delay;
unsigned char fill_byte;
} BLC_ADHOC_PROTOCOL;
typedef union {
struct {
unsigned int unused_1 : 2;
unsigned int unused_2 : 2;
// shorten sf (single frame) on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortensf_txd : 2;
// expect shorten sf (single frame) on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortensf_rcv : 2;
// shorten last consecutive frame on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortenlcf_txd : 2;
// shorten last consecutive frame on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortenlcf_rcv : 2;
unsigned int unused_3 : 8;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 2;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 2;
// Service does not expect a answer, if set
unsigned int requestonly : 1;
unsigned int unused_4 : 2;
// accept any containersize on reception
unsigned int accept_any_csize : 2;
unsigned int unused_5 : 3;
} generic;
struct {
// Checksum type for transmission
// 0: classic
// 1: enhanced
// 2: protocol default
unsigned int checksum_txd : 2;
// Checksum type for reception
// 0: classic
// 1: enhanced
// 2: ignore
unsigned int checksum_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
unsigned int unused_1 : 8;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int unused_2 : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_3 : 3;
} lin;
struct {
// CAN frame id type for transmission
// 0: 11 Bit
// 1: 29 Bit
// 2: Protocol default
unsigned int id_11_29_txd : 2;
// CAN frame id type for reception
// 0: 11 Bit
// 1: 29 Bit
// 2: ignore
unsigned int id_11_29_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
// CAN FD baudrate switching for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdbaudswitch_txd : 2;
// CAN FD baudrate switching for reception
// 0: off
// 1: on
// 2: ignore
unsigned int fdbaudswitch_rcv : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdframe_txd : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: ignore
unsigned int fdframe_rcv : 2;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int no_flowctrl_wait : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_1 : 3;
} can;
} ADHOC_SERVICE_FLAGS;
// ! Ad-Hoc service
typedef struct {
const char* name;
ADHOC_SERVICE_FLAGS flags;
int req_frame_id;
long long req_container_size;
long long req_payload_size;
int req_slot_time;
int rsp_frame_id;
long long rsp_container_size;
long long rsp_payload_size;
int rsp_slot_time;
int rsp_delay;
} BLC_ADHOC_SERVICE;
typedef struct {
int nad;
int p2_extended;
int flow_control_st_min;
int flow_control_block_size;
} BLC_ADHOC_EXECUTE;
// ! Carries information about one signal.
typedef struct _BLC_LOG {
// ! Index number of signal; see the SDF for the adequate number
int format_version;
// ! (0) channel source: channel.id / channel.signal_index, (1) group source: group.id / group.sub_index
unsigned int source_type;
// ! Information about the source of the log
union {
struct {
// ! the channel id
int id;
// ! the signal id
int signal_index;
} channel;
struct {
// ! the group id
int id;
// ! the sub index
int sub_index;
} group;
} source;
// ! unix time index of the log (in sec).
unsigned long long timestamp_unix;
// ! Global time index of the log (in usec).
unsigned long timestamp_usec;
// ! Value type of the value content 0x0 unsigned, 0x1 signed
unsigned int value_signed;
// ! byte size of one element (possible values are one of {1, 2, 4, 8})
unsigned int value_element_size;
// ! array size of the value (is always greater then 0)
unsigned int value_array_size;
// ! values as single value if value_array_size == 1 or as array of values for value_array_size > 1
unsigned char value_data[4 * 1024];
} BLC_LOG;
/** @}*/
/** @addtogroup callback_handling Callback Handling
* @brief List of functions to manage callback functions
*
* The following functions are used to register callback functions for a BabyLIN connection.
* A callback will be called whenever a corresponding message is received on the connection it is
* registered to ( push method ). If you want to use a pull method to retrieve the data, have a look
* at the @ref pull_handling section of the documentation
*
* The device, that generated the callback must not be closed from within the callback.
* @{
*/
// !these Callbacks will tell you the data(as done with old callbacks) AND the Channel which send
// the Data !to find out which Device send the data use => !BL_HANDLE hConnection =
// BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func)(BL_HANDLE, BLC_FRAME frame);
typedef void(BLC_jumboframe_callback_func)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame);
typedef void(BLC_signal_callback_func)(BL_HANDLE, BLC_SIGNAL signal);
typedef void(BLC_macrostate_callback_func)(BL_HANDLE, BLC_MACROSTATE macroState);
typedef void(BLC_error_callback_func)(BL_HANDLE, BLC_ERROR error);
typedef void(BLC_debug_callback_func)(BL_HANDLE, const char* text);
typedef void(BLC_dtl_request_callback_func)(BL_HANDLE, BLC_DTL dtl_request);
typedef void(BLC_dtl_response_callback_func)(BL_HANDLE, BLC_DTL dtl_response);
typedef void(BLC_event_callback_func)(BL_HANDLE, BLC_EVENT event);
// !these Callbacks will tell you the data(as done with old callbacks), plus the Channel which send
// the Data and a user data pointer !added when registering the function !to find out which Device
// send the data use => !BL_HANDLE hConnection = BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func_ptr)(BL_HANDLE, BLC_FRAME frame, void*);
typedef void(BLC_jumboframe_callback_func_ptr)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame, void*);
typedef void(BLC_signal_callback_func_ptr)(BL_HANDLE, BLC_SIGNAL signal, void*);
typedef void(BLC_macrostate_callback_func_ptr)(BL_HANDLE, BLC_MACROSTATE macroState, void*);
typedef void(BLC_error_callback_func_ptr)(BL_HANDLE, BLC_ERROR error, void*);
typedef void(BLC_debug_callback_func_ptr)(BL_HANDLE, const char* text, void*);
typedef void(BLC_dtl_request_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_request, void*);
typedef void(BLC_dtl_response_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_response, void*);
typedef void(BLC_event_callback_func_ptr)(BL_HANDLE, BLC_EVENT event, void*);
typedef void(BLC_log_callback_func_ptr)(BL_HANDLE, BLC_LOG log, void*);
typedef void(BLC_lua_print_func_ptr)(const char* msg, void* userdata);
#endif // BABYLINCAN_TYPES_H

309
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINReturncodes.h vendored
View File

@ -1,309 +0,0 @@
#ifndef BABYLINRETURNCODES_H
#define BABYLINRETURNCODES_H
#if !defined(BL_DLLIMPORT)
#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __declspec(dllexport)
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#else
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __attribute__((visibility("protected")))
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#endif
#else
// #undef BL_DLLIMPORT
// #define BL_DLLIMPORT
#endif
#ifndef DEPRECATED
#ifdef _MSC_VER
#define DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__) | defined(__clang__)
#define DEPRECATED __attribute__((__deprecated__))
#else
#define DEPRECATED
#endif
#endif
// ! @brief represents a connection to a BabyLIN-device or one of the channels
typedef void* BL_HANDLE;
typedef int BL_ADHOC_HANDLE;
typedef const char* CPCHAR;
/** @addtogroup return_values Return Values
* @brief List of possible return values of BabyLINDLL functions
*
* The following values may be returned by BL_ and BLC_ functions to indicate the success or failure
* of an operation. Mostly, the functions will return BL_OK as an indicator for success. However,
* some functions use positive values to return the result of the function on success ( for example
* BL_getFrameCount will return the number of frames ).
* @{
*/
/** Function successfully completed. */
#define BL_OK 0
#define SDF_OK 0
/** Limit for separating BabyLIN- and PC-side errors; below there are all PC-side ones. */
#define BL_PC_SIDE_ERRORS -100000
/** Internal resource allocation problem. Maybe out of memory/handles/etc. */
#define BL_RESOURCE_ERROR -100001
/** Specified handle invalid. */
#define BL_HANDLE_INVALID -100002
/** There is no connection open. */
#define BL_NO_CONNECTION -100003
/** Serial port couldn't be opened or closed. */
#define BL_SERIAL_PORT_ERROR -100004
/** BabyLIN command syntax error. */
#define BL_CMD_SYNTAX_ERROR -100005
/** BabyLIN doesn't answer within timeout. */
#define BL_NO_ANSWER -100006
/** Unable to open a file. */
#define BL_FILE_ERROR -100007
/** Wrong parameter given to function. */
#define BL_WRONG_PARAMETER -100008
/** No data available upon request. */
#define BL_NO_DATA -100009
/** No SDF was loaded previously */
#define BL_NO_SDF -100010
/** Internal message format error */
#define BL_DP_MSG_ERROR -100011
/** The given signal_nr or name does not exist in loaded SDF */
#define BL_SIGNAL_NOT_EXISTENT -100012
/** The signal chosen is a scalar, but an array function was called */
#define BL_SIGNAL_IS_SCALAR -100013
/** The signal chosen is an array, but an scalar function was called */
#define BL_SIGNAL_IS_ARRAY -100014
/** The SDF is unsupported by connected Baby-LIN due to insufficient firmware version */
#define BL_SDF_INSUFFICIENT_FIRMWARE -100015
/** The given signal has no encoding */
#define BL_ENCODING_NOT_EXISTENT -100016
/** The given buffer is too small */
#define BL_BUFFER_TOO_SMALL -100017
/** There is no additional answer data present from last sendCommand-call */
#define BL_NO_ANSWER_DATA -100018
/** Additional data with given index/name not present */
#define BL_ANSWER_DATA_NOT_EXISTENT -100019
/** Device Supported no Channels */
#define BL_NO_CHANNELS_AVAILABLE -100020
/** Unknown command passed to sendCommand */
#define BL_UNKNOWN_COMMAND -100021
/** a sendCommand message timed out */
#define BL_TIMEOUT -100022
/** SDF can not be loaded to a the device due to incompatibility ( incompatible SDFV3 to SDFV2
* device ) */
#define BL_SDF_INCOMPATIBLE -100023
/** value passed as a SDF handle is not valid */
#define SDF_HANDLE_INVALID -100024
/** SDF can not be unloaded as the SDF is in use on a device */
#define SDF_IN_USE -100025
/** can not execute command because SDF download is in progress */
#define BL_DOWNLOAD_IN_PROGRESS -100026
/** function can not be executed due to wrong mode or configuration */
#define BL_INVALID_MODE -100027
/** The number of parameters is not valid for this method. */
#define BLC_UA_EXECUTION_FAILED -100093
/** The number of parameters is not valid for this method. */
#define BLC_UA_INVALID_PARAMETER_COUNT -100094
/** the value could not be read. the reason should be documented in the help file. */
#define BLC_UA_GET_VALUE_REJECTED -100095
/** One of the parameters is invalid. Like a null pointer in a @ref BLC_getUnsignedNumber or a
* value, that is outside of the permitted range, like setting 256 on a 8bit Number property. */
#define BLC_UA_INVALID_PARAMETER -100096
/** the property has no getter for that type e.g. a unsigned number can not be read from a Binary
* property. */
#define BLC_UA_NO_GETTER_DEFINED -100097
/** the property has no setter for that type e.g. a callback can not be stored into Binary property.
*/
#define BLC_UA_NO_SETTER_DEFINED -100098
/** the value given was not set. the reason should be documented in the help file.*/
#define BLC_UA_SET_VALUE_REJECTED -100099
/** A return value between @ref BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref
* BLC_UA_NOT_RESOLVABLE_TAG_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be found. The index of that key is the return value - @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST (this index is 0 based).*/
#define BLC_UA_NOT_RESOLVABLE_TAG_FIRST -100100
/** The given Path should not have more then 100 tags */
#define BLC_UA_NOT_RESOLVABLE_TAG_MAX -100200
/** The @ref ua_service_iso_tp, is supposed to send a request but has no request data. */
#define BLC_UA_NO_REQUEST_DATA -100201
/** During the reception of the Response or the Request a frame timeout occurred. */
#define BLC_UA_SERVICE_FRAME_ORDER -100202
/** A Frame send by the DLL was not echoed by the BabyLIN within timeout_frame milliseconds. You
* might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_SEND -100203
/** The Response was not received within timeout_response milliseconds. Maybe the Request is
* malformed? */
#define BLC_UA_SERVICE_TIMEOUT_RESPONSE -100204
/** A flow-control Frame send by the DLL was not echoed by the BabyLIN within timeout_frame
* milliseconds. You might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_SEND -100205
/** The flow-control state reported by the target is not one of the known states. */
#define BLC_UA_SERVICE_FLOWCONTROL_INVALIDSTATE -100206
/** The flow-control state was "wait"(0x1) in more then max_flow_wait flow-control frames. */
#define BLC_UA_SERVICE_FLOWCONTROL_WAITSTATES -100207
/** The flow-control state was "overflow"(0x2). */
#define BLC_UA_SERVICE_FLOWCONTROL_OVERFLOW -100208
/** The flow-control was not issued by the other node. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_RECEIVE -100209
/** The data for a frame to send can not be put into a frame with the specified frame length. */
#define BLC_UA_SERVICE_FRAME_PACKAGING_ERROR -100210
/** A return value between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be resolved. The index of the object, that could not be
* found is the return value - @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST (this index is 0 based).
*/
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST -101100
/** The given Path should not have more then 100 objects */
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX -101200
//
// ADHOC PROTOCOL ERROR CODES
//
#define BLC_ADHOC_INVALID_HANDLE -1
#define BLC_ADHOC_EXECUTE_RUNNING -102000
#define BLC_ADHOC_MCR_OFFSET 71000
//
// LUA RUNTIME ERROR CODES
//
#define BLC_LUA_RUNTIME_ERROR -103000
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
//-------Return Values from BabyLIN Devices-----------------------------------------------
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
/** Missing or unknown SDF header. This Error occurs when a File is read that is not a SDF File. */
#define BL_ERR_SDF_HEADER 98
/** A corrupted DPMSG was received. This happens when a DPMessage contains an invalid identifier. */
#define BL_ERR_DP_CORRUPT 101
/** An unexpected DPMSG was received. */
#define BL_ERR_DP_SEQUENCE 102
/** The SDF Section Type does not match the Channel Type it is loaded on to. */
#define BL_ERR_DP_MAPPING 103
/** The requested Action can not be carried out on the selected channel. */
#define BL_ERR_CHANNEL 104
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_TYPE 105
/** The Object you are trying to manipulate was never created. */
#define BL_ERR_NULLPOINTER 106
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_MAPPING 107
/** Dataflash/persistent memory could not be initialized. */
#define BL_ERR_DATAFLASH_INIT 108
/** Dataflash/persistent memory does not keep requested SDF index. */
#define BL_ERR_DATAFLASH_INDEX 109
/** Dataflash/persistent memory is to small to hold the SDF. */
#define BL_ERR_DATAFLASH_NOSPACE 110
/** Dataflash/persistent memory read or write error. */
#define BL_ERR_DATAFLASH 111
/** Licence for the requested feature is not installed. */
#define BL_ERR_LICENCE 112
/** Not sufficient Heap Space to perform the requested action. */
#define BL_ERR_HEAP_EXHAUSTED 113
/** Same as ERR_NULLPOINTER but Objects are restricted to Signals. */
#define BL_ERR_SIG_REFERENCE 114
/** Same as ERR_NULLPOINTER but Objects are restricted to Frames. */
#define BL_ERR_FRAME_REFERENCE 115
/** Same as ERR_NULLPOINTER but Objects are restricted to Configurations. */
#define BL_ERR_CFG_REFERENCE 116
/** Same as ERR_NULLPOINTER but Objects are restricted to MacroSelections. */
#define BL_ERR_MACROSEL_REFERENCE 117
/** Same as ERR_NULLPOINTER but Objects are restricted to Events. */
#define BL_ERR_EVENT_REFERENCE 118
/** Same as ERR_NULLPOINTER but Objects are restricted to SignalFunctions. */
#define BL_ERR_SIGFUNC_REFERENCE 119
/** The Loaded SDF is discarded because the checksum is wrong. */
#define BL_ERR_CRC 120
/** Same as ERR_SEQUENCE The requested Component is not yet initialized. */
#define BL_ERR_NOT_INITIALIZED 121
/** Same as ERR_FRAME_REFERENCE. */
#define BL_ERR_FRAMEID_LOOKUP_FAILED 122
/** Same as ERR_NULLPOINTER but Objects are restricted to Macros. */
#define BL_ERR_MACRO_REFERENCE 130
/** A parameter had an invalid value. */
#define BL_ERR_PARAMVALUE 200
/** Condition not be applied or is not full filled. */
#define BL_ERR_CONDITION 210
/** Invalid number of Parameters. */
#define BL_ERR_PARAMCOUNT 211
/** No more Services can be enqueued because the Service queue is full. */
#define BL_ERR_SERVICEQUEUE_EXHAUSTED 300
/** Error Parsing a parameter of a DPMSG. The parameter index will be added onto resulting in the
* final Error code. */
#define BL_ERR_DP_PARSE 900
/** Upper limit of the reserved ERR_DP_PARSE indices. */
#define BL_ERR_DP_PARSE_TOP 980
/** Same as ERR_PARAMVALUE+x but only for Array Size. */
#define BL_ERR_DP_ARRAY_SIZE 989
/** The DPMSG does not start with a message name. */
#define BL_ERR_DP_NONAME 990
/** The DPMSG name is empty. */
#define BL_ERR_DP_NAME_TO_SHORT 991
/** Same as ERR_DP_CORRUPT. Happens when the message name field is longer then the entire message.
*/
#define BL_ERR_DP_NAME_TO_LONG 992
/** Macro Command/Event Action is not known. */
#define BL_CMD_NOT_SUPPORTED 997
/** A not further specified Error. */
#define BL_ERR_UNDEF 998
/** An unknown Command was received. */
#define BL_ERR_UNKNOWN_CMD 999
/** A not further specified Error. */
#define BL_OPERATION_PENDING -1
/** The Macro result can not be read, because the macro is still running. */
#define BL_MACRO_STILL_RUNNING 150
/** The Macro can not be started, because the macro is still running. */
#define BL_MACRO_SAME_RUNNING 151
/** No more parallel Macros are allowed. */
#define BL_MACRO_OTHER_RUNNING 152
/** The Macro could not be started. */
#define BL_MACRO_START_FAIL 153
/** The initial Macro error value. */
#define BL_MACRO_NEVER_EXECUTED 154
/** Macro Result actually contains the error value. */
#define BL_MACRO_ERRCODE_IN_RESULT 155
/** Macro Result actually contains the exception value. */
#define BL_MACRO_EXCEPTIONCODE_IN_RESULT 156
/** @}*/
/**
* @brief type of an answer data token retrieve type using BLC_getAnswerTypeByName or
* BLC_getAnswerTypeByIndex
*/
typedef enum {
/** token is an integer value */
BL_ANSWER_TYPE_INT,
/** token is a string value */
BL_ANSWER_TYPE_STR,
/** token is a binary value */
BL_ANSWER_TYPE_BIN,
/** token is a 64BitInteger value */
BL_ANSWER_TYPE_INT64,
/** token is a Floatingpoint value */
BL_ANSWER_TYPE_FLOAT,
/** token is an unknown value */
BL_ANSWER_TYPE_UNKNOWN,
} BL_ANSWER_TYPE;
/**
* @brief DTL protocol status answers.
* Part of BLC_DTL data structure. Retrieve status of pending
* DTL actions using BLC_getDTLRequestStatus or BLC_getDTLResponseStatus.
*/
typedef enum {
/** DTL action completed */
LD_COMPLETED = 0,
/** DTL action failed */
LD_FAILED,
/** DTL action in progress */
LD_IN_PROGRESS,
} BL_DTL_STATUS;
#endif // BABYLINRETURNCODES_H

92
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLINSDF.h vendored
View File

@ -1,92 +0,0 @@
#ifndef BABYLINSDF_H
#define BABYLINSDF_H
#include "BabyLINReturncodes.h"
// ! @brief represents a connection to a BabyLIN-device ( for old BabyLINs ) or
// one of the channels on new BabyLIN-devices
typedef void* BL_HANDLE;
typedef const char* CPCHAR;
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup l_sdf_functions
* @brief List of legacy SDF functions
*
* The following structures are used to retrieve data from a SDF loaded to a BabyLIN. As these
* functions requeire a loaded SDF onto a BabyLIN, a existing connection to a BabyLIN is mendatory.
* Please see the new SDF API in @ref sdf_functions on how to handle SDFs without a BabyLIN
* connection.
* @{
*/
// ! Get the SDF's number for node by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getNodeNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for signal by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getSignalNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for frame by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getFrameNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for schedule by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
// ! Get the number of schedule tables in the SDF.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BL_SDF_getNumSchedules(BL_HANDLE handle);
// ! Get the SDF's name of schedule by number.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BL_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
// ! Get the SDF's number for macro by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINSDF_H

342
vendor/BabyLIN library/Linux_RaspberryPi/include/BabyLIN_UnifiedAccess.h vendored
View File

@ -1,342 +0,0 @@
#ifndef BABYLIN_UNIFIEDACCESS_H
#define BABYLIN_UNIFIEDACCESS_H
/**
* @addtogroup ua Unified Access
* @brief In the Unified Access interface the available features and values are structured in a tree
* of objects.
*
* @details
* Every object may have children, properties and methods, that are accessible through the __path__
* parameter of the functions. The children, properties and methods are identified by __tags__.
* Those tags are handle specific and described in this document. Additionally they can be listed by
* calling @ref BLC_discover with the handle you are interested in.
*
* ### Creation of new Objects
* To add a new Object into the tree use the @ref BLC_createHandle function. To create a new object
* a using __key value pairs__ ("<key>=<value>") is required. In a path each key value pair has to
* be separated by one space character. Tags valid for the creation keys can be taken from the
* "Creat tags" tables of the Objects documented in this document. The value is specifying the name
* property of the new child. Additionally key value pairs with property tags can be appended, to
* set properties during the object creation, so that less calls to the Setters are required
* afterwards. e.g. creating a @ref ua_protocol_iso_tp in a @ref ua_channel with the name "my_dtl" :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "new_iso_tp_protocol=my_dtl",
* &protocol_handle);
* ~~~
*
* ### Handles of existing Objects
* To find an existing Object in the tree use the @ref BLC_createHandle function. Navigating the
* tree is done by constructing a path by using __key value pairs__ ("<key>=<value>"). Tags valid
* for the keys can be taken from the "Child tags" tables of the Objects documented in this
* document. In a path each key value pair has to be separated by one space character. e.g. getting
* the handle to the previously created @ref ua_protocol_iso_tp of that @ref ua_channel :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "protocol=my_dtl", &protocol_handle);
* ~~~
*
* ### Getters
* To read values of properties use @ref BLC_getSignedNumber, @ref BLC_getUnsignedNumber or @ref
* BLC_getBinary functions. The __path__ parameter has to end with the tag identifying the property
* to read. Valid tags can be taken from the "Property tags" tables of the Objects documented in
* this document. e.g. reading the requestFrameID from a @ref ua_service_iso_tp :
* ~~~.c
* uint64_t requestFrameID;
* BLC_getUnsignedNumber(service_handle, "req_frame_id", &requestFrameID);
* ~~~
*
* ### Setters
* To store values of properties use @ref BLC_setSignedNumber, @ref BLC_setUnsignedNumber, @ref
* BLC_setBinary or @ref BLC_setCallback functions. The __path__ parameter has to end with the tag
* identifying the property to store. Valid tags can be taken from the "Property tags" tables of the
* Objects documented in this document. e.g. setting the requestFrameID of a @ref ua_service_iso_tp
* to 59 :
* ~~~.c
* BLC_setUnsignedNumber(service_handle, "req_frame_id", 59);
* ~~~
*
* ### Execution of Methods
* To execute an object's method use @ref BLC_execute or @ref BLC_execute_async functions. In the
* path variable only the identifying tag is required. Valid tags can be taken from the "Method
* tags" tables of the Objects documented in this document. Functions might have parameters. Those
* can be specified by appending key value pairs to the path in the same manner as when creating new
* objects. The order of the parameters is not relevant. In some cases a synchronous call is not
* applicable, in these cases use @ref BLC_execute_async to execute the method in a dedicated
* thread. e.g. executing a @ref ua_service_iso_tp :
* ~~~.c
* BLC_execute(service_handle, "execute");
* ~~~
* @{
*/
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef>
#include <cstdint>
extern "C" {
#else
#include <stddef.h>
#include <stdint.h>
#endif
/**
* @brief The function prototype used for registering callbacks.
*
* The handle is the handle to the Object, that triggered the callback.<br/> The userdata pointer is
* the userdata specified when registering the callback.
*
* The device, that generated the callback must not be closed from within the callback.
*/
typedef void (*BLC_unifiedaccess_callback_func_ptr)(BL_HANDLE handle, void* userdata);
/**
* @brief The function prototype used for executing asynchron tasks.
*
* The result value is the value returned by the actual execute call.<br/> The handle is the handle
* to the Object, that triggered the callback.<br/> The userdata pointer is the userdata specified
* when registering the callback.<br/>
*/
typedef void (*BLC_unifiedaccess_async_callback_func_ptr)(int32_t result,
BL_HANDLE handle,
void* userdata);
/**
* @brief BLC_createHandle retrieves a handle to a loaded Object or creates a new Object.
*
* These Objects can range from Devices and SDFs down to Signals.<br> When retrieving a handle to
* an existing item the path has to end with a key value pair, where the key is a tag of the objects
* children list. When creating a new Object the "new_*=*" key value pair can be followed by key
* value pairs from the new objects property list, to initialize them.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from key value pairs, separated by spaces e.g.
* "protocol=1 service=2".
* @param result Value to store the new handle in.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the corresponding
* key-value-pair in the path parameter could not be resolved correctly.<br> If the returned value
* is between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX the corresponding key-value-pair in the path parameter
* tries to access a non existing Object.<br> If @ref BLC_UA_GET_VALUE_REJECTED is returned the
* requested Object was found but handles to this type of Object can not be created.<br> In case of
* Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_createHandle(BL_HANDLE handle, const char* path, BL_HANDLE* result);
/**
* @brief BLC_destroy removes the handle from the currently opened Objects and removes the Object
* from its parent.
*
* The given handle will be removed from the available handles and the Object behind it will be
* destroyed.
* @param handle The handle of the object to destroy.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_destroy(BL_HANDLE handle);
/**
* @brief BLC_releaseHandle removes the handle from the currently opened Objects.
*
* The given handle will be release, but a new handle to the underling object can be retrieved
* again.
* @param handle The handle to release.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_releaseHandle(BL_HANDLE handle);
/**
* @brief BLC_discover fills the result array with space separated identifiers, that can be used in
* the path parameters.
*
* Lists the available __Tags__ of the object separated by spaces.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags ending with either
* "property","child", "create", "execute" or "all".<br> "property" will list all __Tags__ usable in
* BLC_get...() and or BLC_set...().<br> "child" will list all __Tags__ usable in BLC_createHandle
* for already existing objects.<br> "create" will list all __Tags__ usable in BLC_createHandle for
* creating new objects.<br> "execute" will list all __Tags__ usable in BLC_execute and
* BLC_execute_async.<br> "all" will list all __Tags__ in the form of "property:=<tags
* >\nchild:=<tags >\ncreate:=<tags >\nexecute:=<tags>".
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, that will be set to the length of
* the result data.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_discover(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_getSignedNumber gets a signed value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed and has less then 64 bits sign extension will be applied, so negative
* values stay negative.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getSignedNumber(BL_HANDLE handle, const char* path, int64_t* result);
/**
* @brief BLC_getUnsignedNumber gets a unsigned value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed no sign extension will be applied, so 8 bit -1 will be 255.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t* result);
/**
* @brief BLC_getBinary gets a binary value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. A only Number or only
* Boolean property will be read as a string representation of it.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, this parameter will be set to the
* length of the result data. If the result buffer is too small no data will be
* copied and only result_length will be updated.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getBinary(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_setSignedNumber sets a signed value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setSignedNumber(BL_HANDLE handle, const char* path, int64_t value);
/**
* @brief BLC_setUnsignedNumber sets an unsigned value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t value);
/**
* @brief BLC_setBinary sets a binary value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. For a only Number or
* only Boolean property the given value will be parsed as a string, that is then handed to @ref
* BLC_setUnsignedNumber or @ref BLC_setSignedNumber.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @param value_length The length of the value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setBinary(BL_HANDLE handle,
const char* path,
const uint8_t* value,
uint32_t value_length);
/**
* @brief BLC_setCallback sets a callback function for an event of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Callback property. Only one
* callback can be registered per event per object.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to set, use a null pointer to deactivate the callback.
* @param userdata The parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setCallback(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_callback_func_ptr callback,
void* userdata);
/**
* @brief BLC_execute executes a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a blocking
* manner.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute(BL_HANDLE handle, const char* path);
/**
* @brief BLC_execute_async a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a non
* blocking manner, so the returned value does not state anything about whether the operation was
* successful, or not, but only if it was found or not. To get the result value you would get from
* @ref BLC_execute use the first parameter of the @ref BLC_unifiedaccess_async_callback_func_ptr.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to call once the operation is complete.
* @param userdata The additional parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute_async(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_async_callback_func_ptr callback,
void* userdata);
#if defined(__cplusplus)
}
#endif
/**
* @}
*/
#endif // BABYLIN_UNIFIEDACCESS_H

120
vendor/BabyLIN library/Linux_RaspberryPi/include/SDF.h vendored
View File

@ -1,120 +0,0 @@
#ifndef SDF_H
#define SDF_H
#include "BabyLINReturncodes.h"
typedef struct {
int sectionNr;
// ! Sectiontype (i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
char name[64];
char description[4096];
} SDF_SECTIONINFO;
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @addtogroup sdf_functions
* @brief List of SDF functions
*
* The following structures are used to load and retrieve data from a SDF. The API allows to load
* and retrieve SDF informations without an existing BabyLIN-Device connection and is particulaly
* useful for SDF preloading or SDF loading to download to multiple BabyLIN devices. Functions
* prefixed with BLC_ require an existing connection to a BabyLIN with a loaded SDF on the
* corresponding channel.
*
* @{
*/
#define SDF_OK 0
#define SDF_HANDLE_INVALID -100024
#define SDF_IN_USE -100025
typedef void* SDF_HANDLE;
/**
* @brief Loads a SDFile to memory and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_open(const char* filename);
/**
* @brief Loads a LDFFile to memory, creates a temporary SDF and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_openLDF(const char* filename);
/** @brief Closes a SDFile opened using @ref SDF_open
*
* @param[in] handle The SDFile handle to close
* @return 0 on success
*/
int BL_DLLIMPORT SDF_close(SDF_HANDLE handle);
/**
* @brief Returns whether the command overwriting feature for macro names is enabled
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return 0 = feature disabled for this SDF, 1 = feature enabled, commands will be
* interpreted as macro names first, if that fails, it will execute the normal
* command e.g "reboot", if it exists.
*/
int BL_DLLIMPORT SDF_hasMacroCommandOverwriteEnabled(SDF_HANDLE sdfhandle);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sdfhandle The SDFile from @ref SDF_open to download
* @param[in] blhandle The BabyLIN connection handle from @ref BLC_open to download to
* @param[in] mode See @ref BLC_loadSDF modes
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadToDevice(SDF_HANDLE sdfhandle, BL_HANDLE blhandle, int mode);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sectionhandle The SDFile from @ref SDF_open to download
* @param[in] channelhandle The BabyLIN channel handle from @ref BLC_getChannelHandle to download to
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadSectionToChannel(SDF_HANDLE sectionhandle, BL_HANDLE channelhandle);
/**
* @brief Get number of sections in SDF
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return Number of sections ( negative value on error )
*/
int BL_DLLIMPORT SDF_getSectionCount(SDF_HANDLE sdfhandle);
/**
* @brief Get handle to a section of a sdf
* @param[in] handle The handle of the sdf to get the section handle from
* @param[in] sectionNr The section number to get the handle for
* @return Handle to the section ( 0 on error )
*/
SDF_HANDLE BL_DLLIMPORT SDF_getSectionHandle(SDF_HANDLE handle, int sectionNr);
/**
* @brief Get information about a section
* @param[in] handle The section handle to retrieve informations about
* @param[out] info Pointer to pre-allocated @ref SDF_SECTIONINFO structure to fill
* @return 0 on success
*/
int BL_DLLIMPORT SDF_getSectionInfo(SDF_HANDLE handle, SDF_SECTIONINFO* info);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // SDF_H

BIN
vendor/BabyLIN library/Windows_PC/BabyLIN-DLL x64/BabyLIN.dll vendored
View File

Binary file not shown.

BIN
vendor/BabyLIN library/Windows_PC/BabyLIN-DLL x86/BabyLIN.dll vendored
View File

Binary file not shown.

BIN
vendor/BabyLIN library/Windows_PC/BabyLIN.dll vendored
View File

Binary file not shown.

1015
vendor/BabyLIN library/Windows_PC/BabyLIN.h vendored
View File

File diff suppressed because it is too large Load Diff

2351
vendor/BabyLIN library/Windows_PC/BabyLINCAN.h vendored
View File

File diff suppressed because it is too large Load Diff

88
vendor/BabyLIN library/Windows_PC/BabyLINCANSDF.h vendored
View File

@ -1,88 +0,0 @@
#ifndef BABYLINCANSDF_H
#define BABYLINCANSDF_H
#include "BabyLINReturncodes.h"
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup sdf_functions
* @{
*/
/**
* @brief Get the SDF's number for node by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getNodeNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for signal by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getSignalNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for frame by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getFrameNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the SDF's number for schedule by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
/**
* @brief Get the number of schedule tables in the SDF.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BLC_SDF_getNumSchedules(BL_HANDLE handle);
/**
* @brief Get the SDF's name of schedule by number.
*
* @param handle Handle representing the connection; returned previously by
* getChannelHandle().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BLC_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
/**
* @brief Get the SDF's number for macro by name.
*
* @param handle Handle representing the connection; returned previously by getChannelHandle().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BLC_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCANSDF_H

692
vendor/BabyLIN library/Windows_PC/BabyLINCAN_nostruct.h vendored
View File

@ -1,692 +0,0 @@
#ifndef BABYLINCAN_NOSTRUCT_H
#define BABYLINCAN_NOSTRUCT_H
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef> // get "size_t", used by function BL_encodeSignal())
#include <cstdint>
extern "C" {
#else
#include <stddef.h> // get "size_t", used by function BL_encodeSignal())
#include <stdint.h>
#endif
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device of the BLC_PORTINFO information, i.e. works as a
* wrapper for @ref BLC_open and @ref BLC_openNet which automatically decides which connection to
* establish.
*
* \note Platform independent way of connecting to BabyLIN-devices found by @ref BLC_getBabyLinPorts
* or @ref BLC_getBabyLinPortsTimout.
*
* \note the BLC_PORTINFO-structure of the BabyLIN to connect to ( see @ref BLC_getBabyLinPorts ) is
* divided in its members here.
*
* @param portNr The Comport number on Windows for serial devices or the TCP port for network
* devices.
* @param type The type of the connection to establish refer to @ref BLC_PORTINFO 's type field
* for value descriptions.
* @param name A 256 character array. name is not yet used and has to have a '\0' as first
* character.
* @param device A 256 character array. device is the path to the serial connection under Linux
* (e.g. /dev/ttyUSB0) or the TCP IP address of the device to connect to.
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not
* be established. You may fetch the corresponding (textual) error with @ref
* BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openPort(int portNr, int type, char* name, char* device);
/** @brief Open a connection to a BabyLIN device using BLC_PORTINFO information.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function tries to open the BabyLIN device specified by the BLC_PORTINFO derived from the
* given URL.
*
* @param url The device URL to convert might be a system path (/dev/ttyUSB1) for Unix based
* systems, a comport (COM1) as is used for windows or a network address
* (tcp://127.0.0.1:2048) to connect to a network device.
*
* @return Returns an handle for the BabyLIN-connection or NULL if the connection could not be
* established or the given URL is malformed. You may fetch the corresponding (textual)
* error with @ref BLC_getLastError.
*/
BL_HANDLE BL_DLLIMPORT BLCns_openURL(char* url);
/**
* @brief Requests the information about the target
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the connection (see @ref BLC_open )
* @param type The target type refer to @ref BLC_TARGETID for value description.
* @param version The firmware version of the device.
* @param flags The flags as described in @ref BLC_TARGETID.
* @param serial Devices serial number.
* @param heapsize The devices heap size.
* @param numofchannels The number of channels as described in @ref BLC_TARGETID.
* @param name The product name, has to be preallocated.
* @param nameLength Length of the product name array.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getTargetID(BL_HANDLE handle,
unsigned short* type,
unsigned short* version,
unsigned short* flags,
long* serial,
long* heapsize,
long* numofchannels,
char* name,
int nameLength);
/** @brief Retrieve informations about the Channel
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Channel-handle representing the Channel. (see @ref BLC_getChannelHandle)
* @param id The channel id.
* @param type The channel type as described in @ref BLC_CHANNELINFO.
* @param name The channel name, has to be preallocated.
* @param nameLength The size of the name array.
* @param maxbaudrate The maximal baud-rate as described in @ref BLC_CHANNELINFO.
* @param reserved1 Reserved for future use.
* @param reserved2 Reserved for future use.
* @param reserved3 Reserved for future use.
* @param associatedWithSectionNr The index of the section as described in @ref BLC_CHANNELINFO.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getChannelInfo(BL_HANDLE handle,
unsigned short* id,
unsigned short* type,
char* name,
int nameLength,
long* maxbaudrate,
long* reserved1,
long* reserved2,
long* reserved3,
int* associatedWithSectionNr);
/** @brief Get the version string of the library
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* This function returns the version string of the library.
*
* @param buffer A preallocated buffer to store the version string in.
* @param bufferlen The length of the preallocated buffer.
* @return Returns a C-string with the version information.
*/
int BL_DLLIMPORT BLCns_getVersionString(char* buffer, int bufferlen);
/** @brief Retrieve the last framedata available for a frame
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "disframe" or "mon_on" is sent
* before ( see @ref babylin_commands )
*
* @param handle Is the Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param frameNr Zero based index of requested frame entry.
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled with the frames data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getLastFrame(BL_HANDLE handle,
int frameNr,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value.
* @return The actual number of retrieved BLC_FRAMEs, which might be less than *size on
* input. Status of operation; '=0' means successful, '!=0' otherwise. See
* standard return values for error, or for textual representation (for return
* values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds for new data before it returns with a BL_TIMEOUT return
* code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_FRAME struct.
* @param frameId The frame id as described in the @ref BLC_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_FRAME struct.
* @param checksum only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned char* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_FRAMEs to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_FRAMEs, which might be less than *size on input.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned char lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next jumbp frame on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array to be filled witht he frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return values
* for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrame(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAME to be fetched,
* which must be a positive value.
* @return The actual number of retrieved BLC_JUMBO_FRAMEs, which might be less than
* *size on input. Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual representation (for
* return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrames(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int* size);
/** @brief Fetches the next jumbo frame on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next jumbo frame received from the BabyLIN. If no frame-data is available, the
* function will wait _up to_ timeout_ms milliseconds for new data before it returns with a
* BL_TIMEOUT return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId The channel id, the frame came in at.
* @param timestamp The timestamp given the frame from the device as described in the @ref BLC_FRAME
* struct.
* @param intime The PC time when the frame came in as described in the @ref BLC_JUMBO_FRAME
* struct.
* @param frameId The frame id as described in the @ref BLC_JUMBO_FRAME struct.
* @param lenOfData The length of the frame data array.
* @param frameData Pointer to a preallocated array that will be filled with the frame data.
* @param frameFlags The frame flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param busFlags The bus specific flags as described in the @ref BLC_JUMBO_FRAME struct.
* @param checksum Only valid for LIN channels the frames checksum byte.
* @param timeout_ms Timeout to wait for new framedata.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFrameTimeout(BL_HANDLE handle,
unsigned long* chId,
unsigned long* timestamp,
long* intime,
unsigned long* frameId,
unsigned int* lenOfData,
unsigned char* frameData,
short* frameFlags,
short* busFlags,
unsigned char* checksum,
int timeout_ms);
/** @brief Fetches the next jumbo frames on Channel from the receiver queue with wait-timeout
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Device fills the receiver queue only if command "disframe" or "mon_on" is sent
* before.
*
* Retrieves the next frame received from the BabyLIN. If no frame-data is available, the function
* will wait _up to_ timeout_ms milliseconds before new data before it returns with a BL_TIMEOUT
* return code.
*
* @param handle Handle representing the channel to get the frame data from (see @ref
* BLC_getChannelHandle )
* @param chId Array of channel identifiers for the corresponding fetched frames.
* @param timestamp Array of timestamps for the corresponding fetched frames.
* @param intime Array of arrival timestamps for the corresponding fetched frames.
* @param frameId Array of frame identifiers for the corresponding fetched frames.
* @param lenOfData Array of data lengths for the data of of the corresponding fetched frames.
* @param frameData Array of frame data arrays for the corresponding fetched frames.
* @param frameFlags Array of frame flags for the corresponding fetched frames.
* @param busFlags Array of bus flags for the corresponding fetched frames.
* @param checksum Array of checksums for the corresponding fetched frames.
* @param timeout_ms Timeout to wait for new framedata
* @param size Input/Output parameter. On input, number of BLC_JUMBO_FRAMEs to be fetched,
* which must be a positive value. On output, the actual number of retrieved
* BLC_JUMBO_FRAMEEs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextJumboFramesTimeout(BL_HANDLE handle,
unsigned long chId[],
unsigned long timestamp[],
long intime[],
unsigned long frameId[],
unsigned int lenOfData[],
unsigned char frameData[],
short frameFlags[],
short busFlags[],
unsigned char checksum[],
int timeout_ms,
int* size);
/** @brief Fetches the next signal from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index The signal number of the received signal.
* @param isArray != 0 if the signal is marked as array signal.
* @param value The signal value for non array signals only.
* @param arrayLength The length of the given array and the amount of bytes copied into it.
* @param array The signal data of array signals.
* @param timestamp The timestamp given the signal report by the device.
* @param chId The id of the channel that did report the signal value.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignal(BL_HANDLE handle,
int* index,
int* isArray,
unsigned long long* value,
int* arrayLength,
unsigned char* array,
unsigned long* timestamp,
unsigned short* chId);
/** @brief Fetches the next signals from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retreived signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
*
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignals(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int* size);
/** @brief Fetches the next signals for a signal number from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
* @attention The Baby-LIN fills the receiver queue only if command "dissignal" sent before.
*
* @param handle Handle representing the channel to get the signal data from (see @ref
* BLC_getChannelHandle )
* @param index Output parameter: array of indices of the corresponding retrieved signals.
* @param isArray Output parameter: array of boolean values, indicating if the corresponding
* retrieved signal is an array.
* @param value Output parameter: array of signal values for the corresponding retrieved
* signals.
* @param arrayLength Output parameter: array of array lengths for the data arrays contained in
* the retrieved signals.
* @param array Output parameter: array of 8*(*size) bytes, containing for each retrieved
* signal an 8-byte data array if the resp. array length is greater 0.
* @param timestamp Output parameter: array of timestamps for the corresponding retrieved
* signals.
* @param chId Output parameter: array of channel identifiers for the corresponding
* retrieved signals.
* @param size Input/Output parameter. On input, number of BLC_SIGNAL to be fetched, which
* must be a positive value. On output, the actual number of retrieved
* BLC_SIGNALs, which might be less than *size on input.
* @param signalNumber The signal number to return signals for
* @return Status of operation; '=0' means successful, '!=0' otherwise.
* See standard return values for error, or for textual
* representation (for return values < -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextSignalsForNumber(BL_HANDLE handle,
int index[],
int isArray[],
unsigned long long value[],
int arrayLength[],
unsigned char array[],
unsigned long timestamp[],
unsigned short chId[],
int size,
int signalNumber);
/** @brief Fetches the next Bus error from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the error data from (see @ref
* BLC_getChannelHandle )
* @param timestamp The timestamp when the error was recorded by the device.
* @param type The error type.
* @param status The error status.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextBusError(BL_HANDLE handle,
unsigned long* timestamp,
unsigned short* type,
unsigned short* status);
/** @brief Fetches the next complete DTL request from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL request.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLRequest(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Fetches the next complete DTL response from the receiver queue.
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle Handle representing the channel to get the DTL data from (see @ref
* BLC_getChannelHandle )
* @param status The DTL status.
* @param nad The NAD of that DTL response.
* @param length The length of the DTL data, has to hold the length of the preallocated data
* buffer.
* @param data The DTL data, has to be preallocated.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getNextDTLResponse(
BL_HANDLE handle, BL_DTL_STATUS* status, unsigned char* nad, int* length, unsigned char* data);
/** @brief Retrieve further Information about a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* Need a loaded SDF (see @ref BLC_loadSDF or @ref BLC_loadLDF )
* @param handle Handle to a valid connection
* @param filename The loaded SDFs file name.
* @param sectionCount The amount of sections in that SDF.
* @param version_major The SDFs major version.
* @param version_minor The SDFs minor version.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard
* return values for error, or for textual representation (for return values <
* -1000) @ref BLC_getLastError.
*/
int BL_DLLIMPORT BLCns_getSDFInfo(BL_HANDLE handle,
char* filename,
short* sectionCount,
short* version_major,
short* version_minor);
/** @brief Retrieve informations about a SDF-Section from a loaded SDF
*
* @attention This function is required by certain BabyLIN Wrappers.
* @attention It is strongly recommended, that it is not used in C/C++ applications.
*
* @param handle handle of a valid connection
* @param infoAboutSectionNr The section number to retrieve information of. Ranges from 0 to the
* number of sections in the loaded SDF (see @ref BLC_getSDFInfo and @ref
* BLC_SDFINFO.sectionCount )
* @param name The sections name.
* @param type The section type e.g. LIN.
* @param nr The section number.
* @return Status of operation; '=0' means successful, '!=0' otherwise. See standard return
* values for error, or for textual representation (for return values < -1000) @ref
* BLC_getLastError.
*/
int BL_DLLIMPORT
BLCns_getSectionInfo(BL_HANDLE handle, int infoAboutSectionNr, char* name, int* type, short* nr);
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINCAN_NOSTRUCT_H

859
vendor/BabyLIN library/Windows_PC/BabyLINCAN_types.h vendored
View File

@ -1,859 +0,0 @@
#ifndef BABYLINCAN_TYPES_H
#define BABYLINCAN_TYPES_H
#include "BabyLINReturncodes.h"
/** @addtogroup structures
* @brief List of BabyLIN structures
*
* The following structures are used to retrieve data from a running BabyLIN device like frame- and
* signal-reports or error and debug information
* @{
*/
/** @brief Information about a BabyLIN port on the host operating system
*
* The structure holds information about a BabyLIN device connected to the PC Use @ref
* BLC_getBabyLinPorts to retrieve a list of connected BabyLIN-Devices
*
* */
typedef struct _BLC_PORTINFO {
/** @brief The COM-port number the device is connected to (windows only), use this value for
* BLC_open. For Network devices this is the TCP port to connect to.
*/
int portNr;
/** @brief The type of interface of the connected device (0=USBSerial, 1=Not Connectable(Network
* UDP), 2=Network TCP).
*
* Devices of type 1 can not be Connected to via BLC_open...(...).
*/
int type;
/** @brief The name of the connected device (f.ex. BabyLIN RM-II). For Network devices this is the
* hostname of the device.
*/
char name[256];
/** @brief The linux device file the BabyLIN is connected to (linux only) For Network devices this
* is the ip in dot notation.
*/
char device[256];
} BLC_PORTINFO;
/** @brief Information about a connected BabyLIN device
*
* The structure holds information about a connected BabyLIN device retreive informations using
* @ref BLC_getTargetID or request by using @ref BLC_sendCommand with command "targetid"
*
*/
typedef struct _BLC_TARGETID {
/** @brief Type of the hardware
*
* | Value | Device |
* |------:|--------|
* |0x100 |Baby-LIN|
* |0x102 |Baby-LIN-RC |
* |0x103 |Baby-LIN-KS01 |
* |0x200 |Baby-LIN-RM |
* |0x510 |Baby-LIN-MB |
* |0x300 |HARP |
* |0x503 |Baby-LIN-II |
* |0x501 |Baby-LIN-RC-II |
* |0x500 |Baby-LIN-RM-II |
* |0x700 |Baby-LIN-MB-II |
* |0x502 |HARP-4 |
* |0x511 |HARP-5 |
* |0x508 |Baby-LIN-RM-III |
* |0x509 |Baby-LIN-RC-II-B |
* |0x504 |MIF_LIN-II |
* |0x507 |MIF_CAN_FD |
* |0x600 |Virtual_CAN |
* */
unsigned short type;
// ! Firmware version of the device
unsigned short version;
// ! Firmware build number
unsigned short build;
/** @brief Software related flags
*
* |Value|Description|
* |----:|:----------|
* |0x01 |Testversion|
* */
unsigned short flags;
// ! Device's serial number
long serial;
// ! Remaining heap size on device (memory available for SDF dowload)
long heapsize;
// ! number of channels
long numofchannels;
// ! Textual name of the device (zero-terminated C-string)
char name[128];
} BLC_TARGETID;
/**
* @brief Information about a channel on a BabyLIN device
*
* Return data of the command '@ref BLC_getChannelInfo' providing information about a channel
* (BUS-type, speed etc.)
*/
typedef struct _BLC_CHANNELINFO {
/// Channel-id(i.e. 0 = device channel)
unsigned short id;
/// Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
unsigned short type;
/// Textual name of the Channel (zero-terminated C-string)
char name[128];
/// Maximum Baudrate of Channel
long maxbaudrate;
/**
* @brief Flags describing the State of the Channel.
*
* Bit0 : Indicates, whether the channel is disabled, due to missing licences.<br>
* Bit1 : Indicates, that SDFs of version 3 may be uploaded onto this Channel.<br>
* Bit2 : Deprecated: ignore the state of this bit.<br>
* Bit3 : Indicates, that the Channel is initialized (SDF/Section was loaded or Monitor Mode is
* active).<br>
* Bit4 : Indicates, that the channel has the ability and license to send and receive
* CAN FD frames.<br>
* Bit5 : Indicates, that the channel has the ability and license to send and
* receive CAN HS frames.<br>
* Bit6 : Indicates, that the channel has the ability and license to
* send and receive CAN LS frames.
*
* @remark Some bits may not be set by older firmware version.<br>Please consider a firmware
* update.
*/
long reserved1;
/// Reserved value (ignore for now)
long reserved2;
/// Reserved value (ignore for now)
long reserved3;
/// the number of the section of the loaded sdf associated with this channel >= 0 means valid
/// section number, -1: no mapping or no sdf loaded
int associatedWithSectionNr;
} BLC_CHANNELINFO;
// ! Return data of the command @ref BLC_getSDFInfo
typedef struct _BLC_SDFINFO {
// ! Filename of the loaded sdf
char filename[256];
// ! number of sections in the SDF. A file consists of at least one Section (LIN, CAN or DEVICE)
short sectionCount;
// ! SDF-version
short version_major, version_minor;
} BLC_SDFINFO;
// ! Return data of the command @ref BLC_getSectionInfo
typedef struct _BLC_SECTIONINFO {
// ! Textual name of the Section (zero-terminated C-string) as defined using SessionConf
char name[128];
// ! Channel-Type(i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
// ! Number of the section within the SDF ( zero-based index )
short nr;
} BLC_SECTIONINFO;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned char lenOfData;
// ! Databytes of the frame
unsigned char frameData[8];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame (only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular CAN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
* */
// clang-format on
short busFlags;
/** @brief Checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_FRAME;
// ! Carries information about one frame, is used as API interface
typedef struct _BLC_JUMBO_FRAME {
// ! Id of the channel within the device
unsigned long chId;
// ! Global time index of frame transmission start (in us). Received from target, represents the
// time since the Target was powered on.
unsigned long timestamp;
// ! Timestamp with pc time, used to calculate age of framedata, to allow timeout functions (ms)
long intime;
// ! FrameID of Frame ( as appeared on the BUS. On LIN BUS without parity bits )
unsigned long frameId;
// ! Length of frameData
unsigned int lenOfData;
// ! Databytes of the frame
unsigned char frameData[1024];
// clang-format off
/** @brief Additional, informational frame flags
*
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 | Frame has error|
* | 0x02 | Frame is selfsent (sent by the BabyLIN-Device, because it simulates the corresponding node)|
* | 0x04 | Timebase, if set, the unit of @ref timestamp is ms, otherwise us|
* | 0x08 | The frame was a SDF specified frame |
* | 0x10 | The frame was an injected frame |
* | 0x20 | The frame was a protocol frame |
* | 0x40 | The frame was not actually on the bus, only been mapped as its a SDF like inject |
**/
// clang-format on
short frameFlags;
// clang-format off
/** @brief Bus specific flags
*
* for LIN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |Valid CLASSIC checksum (V1)|
* | 0x02 |Valid EXTENDED checksum (V2)|
* | 0x04 |incomplete frame without checksum, not an error|
* | 0x08 |Errorframe (f.ex: no data)|
* | 0x10 |Frame is slave response to a master request. If set, the upper 3 bits of flags denote a master request id|
* | 0x20 |Event triggered frame ( only if 0x10 is not set )|
* | 0x1C0 |Master request ID|
* | 0x600 |Frame Type: 0: regular LIN, 1: KLine Raw, 2: KLine Webasto|
*
* for CAN-BUS:
* Used as a bitfield, multiple flags possible
* | Value | Description |
* |------:|:------------|
* | 0x01 |29 bit frame identifier|
* | 0x06 |Frame Type: 0: regular LIN, 1: CAN-FD, 2: CAN-FD with bitrate switching|
**/
// clang-format on
short busFlags;
/** @brief checksum of the frame
* stores a checksum V1 or V2 ( refer to busFlags which checksum type applies )
*/
unsigned char checksum;
} BLC_JUMBO_FRAME;
/**
* @brief status of a macro
*
* Information about a macro, used as parameter of a callback function registered by @ref
* BLC_registerMacroStateCallback
* */
typedef struct _BLC_MACROSTATE {
// ! channel number this information belongs to
int channelid;
/** @brief Macro-number the information is about
* */
int macronr;
/** @brief The macro command number currently executed
*
* denotes the command-number in the macro @ref macronr which is currently executed
*
* valid if @ref state denotes a running macro
* */
int cmdnr;
/**
* @brief state of the macro execution
*
* |Value|Description|
* |----:|:----------|
* |0x00 |Macro execution ended|
* |0x01 |Macro execution started|
* |0x02 |Macro execution running|
* |0x03 |Macro execution error|
*/
int state;
/**
* @brief Timestamp of the macro state
* @remark Previous BabyLIN DLL v10.22.0 this value was long!
* We recommend to recompile your app using BabyLIN library if you have linked against a
* version previous v10.22.0.
*/
unsigned long timestamp;
} BLC_MACROSTATE;
// ! Carries information about one signal.
typedef struct _BLC_SIGNAL {
// ! Index number of signal; see the SDF for the adequate number
int index;
// ! Defines whether this signal is a normal, value-based one (0) or LIN2.0 array signal (1).
int isArray;
// ! Value of the signal.
unsigned long long value;
// ! Length of the array.
int arrayLength;
// ! Value(s) of the signal, if isArray == 1.
unsigned char array[8];
// ! Global time index of frame transmission start (in usec).
unsigned long timestamp;
// ! Current Channelid
unsigned short chId;
} BLC_SIGNAL;
/* clang-format off */
// ! Represents a BUS error message
typedef struct _BLC_ERROR{
/** @brief Time of occurence.
* The timestamp when the error occurred.
*
* device-timstamp in us if error @ref type is a device error (1-16)
*
* pc timestamp in ms if error @ref type is dll error (65535)
* */
unsigned long timestamp;
/** @brief Error type
*
* | Value | Name | Description | Status |
* |------:|:-----|:------------|:-------|
* |1|ERRTYPE_ID|Parity error in ID||
* |2|ERRTYPE_DATA|Read data from BUS does not match send data|Frame-ID|
* |3|ERRTYPE_FRAMING|Framing error in data reception|Frame-ID|
* |4|ERRTYPE_CHECKSUM|Checksum failed|Frame-ID|
* |5|ERRTYPE_DATATO|Data timed out (incomplete msg reception)|Frame-ID|
* |6|ERRTYPE_SEQ|Unexpected state sequencing|internal status|
* |8|ERRTYPE_MACRO|Error in macro execution|internal status|
* |9|ERRTYPE_BUSBUSY|Bus is already used|internal status|
* |10|ERRTYPE_BUSOFF|Bus is offline (no bus power) |internal status|
* |11|ERRTYPE_BUSSPEED_DIFFERS|Actual bus-speed differs from LDF bus speed (Warning) |actual speed|
* |12|ERRTYPE_RX_FRAME_LEN|Frame length error|Frame-ID|
* |13|ERRTYPE_RX_INCOMPLETE|Incomplete frame received|Frame-ID|
* |14|ERRTYPE_RESP_LOST|Response send buffer overflow occured|unused|
* |15|ERRTYPE_CAN_NOERR|CAN error disappeared|unused|
* |16|ERRTYPE_CAN_ERR|CAN error| bitmap 0x01 noAck<br>bitmap 0x02 stuffing error<br>bitmap 0x04 framing error<br>bitmap 0x08 recessive bit error<br>bitmap 0x10 dominant bit error<br>bitmap 0x20 checksum error|
* |17|ERRTYPE_FRAME_ERR|A received Frame does not match its definition in the SDF|The Frame number in the SDF|
* |18|ERRTYPE_LIN_SHORT_GND|LIN master Bus Low level too lang (master pull-up destroying danger)|unused|
* |19|ERRTYPE_INTERNAL_OVERFLOW|Queue overflow of an internal buffer/queue|internal status|
* |20|ERRTYPE_FLASH_SDF_LOAD|Error while loading SDF from persistent memory|internal status|
* |21|ERRTYPE_TX_HEADER_FAIL|An error occurred during the sending of a frame header|Frame-ID|
* |22|ERRTYPE_NO_CANPHY_SELECT|Bus was started without an activated CAN-Transceiver||
* |23|ERRTYPE_SLAVE_PROTOCOL_TIMEOUT|Slave protocol timeout||
* |24|ERRTYPE_CAN_STUFFERR|A CAN stuff error occurred||
* |25|ERRTYPE_CAN_FORMERR|A CAN form error occurred||
* |26|ERRTYPE_CAN_ACKERR|A CAN ack error occurred||
* |27|ERRTYPE_CAN_RECESSIVEBITERR|A CAN bit recessive error occurred||
* |28|ERRTYPE_CAN_DOMINANTBITERR|A CAN bit dominant error occurred||
* |29|ERRTYPE_CAN_CRCERR|A CAN CRC error occurred||
* |30|ERRTYPE_CAN_SETBYSWERR|A CAN frame can't be send on the bus||
* |31|ERRTYPE_CAN_BUSOFF|The CAN Bus is off||
* |32|ERRTYPE_SDF_LOG_COMMAND|Log file error|0=An internal error occurred<br>1=The log command is unknown<br>2=The log command has too few parameters<br>3=The log command has too many parameters<br>4=The log file handle is invalid<br>10=A parameter is invalid<br>11=The first parameter is mandatory<br>12=The first parameter is no unsigned integer<br>13=The first parameter is no handle<br>14=The first parameter is no valid handle<br>21=The second parameter is mandatory<br>22=The second parameter is no unsigned integer<br>23=The second parameter is no handle<br>24=The second parameter is no valid handle<br>31=The third parameter is mandatory<br>32=The third parameter is no unsigned integer<br>33=The third parameter is no handle<br>34=The third parameter is no valid handle<br>100=Could not create log file<br>101=Could not close log file<br>102=Could not start log file<br>103=Could not stop log file<br>104=Could not pause log file<br>105=Could not resume log file<br>106=Could not write to file|
* |33|ERRTYPE_SD_SDF_LOAD|The SDF could not be loaded from the SD card||
* |34|ERRTYPE_PROTOCOL_DEFINITION|Error on protocol definition|0=Error on CAN ID size<br>1=CAN flags mismatch<br>2=frame size too large|
* |35|ERRTYPE_PROTOCOL_SLAVE|Error on slave protocol||
* |36|ERRTYPE_PROTOCOL_MASTER|Error on master protocol|See macro error codes|
* |256|ERRTYPE_WARN_CANFD_FRAME|Warning: CAN-FD baudrate and flags are inconsistent||
* |257|ERRTYPE_WARN_MISSING_SYSCFG204|Warning: SYSCFG204 not defined||
* |258|ERRTYPE_WARN_CANID_MULTIPLE_USE|CAN ID used in more than one frame definitions||
* |512|ERRTYPE_SLAVE_PROTOCOL_SKIPPED_MIXED_PROTOCOLTYPES|Skipped execution of slave protocol||
* |513|ERRTYPE_SLAVE_PROTOCOL_USE_FIRST|The first of multiple possible services is executed||
* |514|ERRTYPE_LOGGER|A logging error occurred|0=No SD Card in device or no SD Card license<br>1=Log file number 99999 reached, please empty log directory<br>2=No free space on SD card<br>3=Can not open log file|
* |999|ERRTYPE_RUNTIME_SDFCODES|A runtime error occurred in the SDF||
* |61166|ERRTYPE_RUNTIME_DLLCONMBII|MB-II DLL-Connector error|1=Connection lost<br>2=Message lost<br>3=Message dropped|
* |65535|ERRTYPE_RUNTIME_LIBRARY|Error in DLL occurred|1=Connection lost<br>2=Message lost<br>3=Message dropped<br>4=Message was no report and not an answer to a transaction<br>5=The Baby-LIN library was not active for more than 2s<br>6=The Baby-LIN library was not active for more than 3s<br>7=The Baby-LIN library was not active for more than 4s<br>8=The Baby-LIN library was not active for more than 5s|
**/
unsigned short type;
/** @brief Additional error information
*
* Depends on @ref type descriptions.
* for "dll status code":
* |status|description|
* |-----:|:----------|
* |1|Lost connection to device|
**/
unsigned short status;
} BLC_ERROR;
/* clang-format on */
// ! Carries information about DTL protocol (both requests and responses).
typedef struct _BLC_DTL {
// ! Status of protocol frame
BL_DTL_STATUS status;
// ! NAD of protocol frame
unsigned char nad;
// ! Length of the data-array.
int length;
// ! frame data, beginning with the (R)SID.
unsigned char data[4 * 1024];
} BLC_DTL;
// ! Events from a device
typedef struct _BLC_EVENT {
/** @brief Time of occurence.
* The timestamp (of the device (us)) when the error occurred.
* */
unsigned int timestamp;
/** @brief Time of occurence.
* The timestamp (of the PC (ms)) when the error occurred.
* */
unsigned int pc_timestamp;
/* clang-format off */
/** @brief The event that occured
*
* | Value | Name | Description | data |
* |------:|:-----|:------------|:-------|
* |0|EVENTID_REBOOT|The device was rebootet.| |
* |1|EVENTID_HWSTATE|The state of the LIN bus voltage has changed|0: LIN bus voltage missing.\n: LIN bus voltage detected.|
* |3|EVENTID_DIRECT_MODE|||
* |4|EVENTID_BOOTLOADER_START|The bootloader is starting after a reboot.|The second parameter contains the hardware type.|
* |5|EVENTID_FIRMWARE_START|The firmware is starting after a reboot.|The second parameter contains the hardware type.|
* |6|EVENTID_BUSSPEED_CHANGE|The bus speed has changed.|The second parameter is the bus speed.|
* |7|EVENTID_ENLARGE_TIMEOUT_REQ|The firmware requests a change of the default timeout.|For internal use only.|
* |8|EVENTID_REBOOT_TO_FOLLOW|Is sent before the device executes a reboot.||
* |9|EVENTID_INJECTREJECT_BY_FRAMEID|An inject command was rejected.|A protocol with the same RX ID was actually executed.|
* |10|EVENTID_DISCONNECT|Device disconnected from host.|The parameter contains the reason: 0: No command was received from the host and triggered a timeout. 1: A channel crashed and was reset.|
* |999|EVENTID_RUNTIME_ERROR|A runtime error occurred.|The second parameter contains the error code.|
*/
int event;
/* clang-format on */
/** @brief Additional information of an event
*/
long long data;
} BLC_EVENT;
/**
* @brief Type of an ad hoc protocol
*/
typedef enum {
TYPE_RAW = 0,
TYPE_DTL_ISOTP = 1,
TYPE_ISOTP_WITHOUT_NAD = 2,
TYPE_WEBASTO_UHW2 = 3,
TYPE_WEBASTO_STD = 5,
TYPE_KLINE_RAW = 6,
} ADHOC_PROTOCOL_TYPE;
typedef union {
struct {
// any value of PROTOCOL_TYPE
// 0: Raw
// 1: DTL/ISO-TP with NAD
// 2: ISO-TP without NAD (CAN only)
// 3: Webasto KLine UHW V2 (LIN only)
// 4: Raw Jumbo (LIN only)
// 5: Webasto KLine Standard (LIN only)
//
int protocoltype : 6;
unsigned int unused_1 : 5;
// shorten sf (single frame) on transmission
unsigned int tx_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int tx_shortenlcf : 1;
unsigned int unused_2 : 3;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 1;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 1;
// this bit is set for a slave protocol definition
unsigned int slaveprotocol : 1;
// 0: no (Only full frames are accepted) Default bei V0
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted) Default bei V0
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// accept any containersize on reception
unsigned int accept_any_csize : 1;
// send shortened FloawCtrl frame (for CAN only)
unsigned int xmit_shortenflowctrl : 1;
} generic;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
unsigned int unused_1 : 2;
// classic or enhanced checksum
unsigned int xmit_chksumtype : 1;
// classic or enhanced checksum or both
unsigned int expect_chksumtype : 2;
// See generic definition above.
unsigned int xmit_shortensf : 1;
// See generic definition above.
unsigned int xmit_shortenlcf : 1;
unsigned int unused_2 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// See generic definition above.
unsigned int expect_shortenedlcf : 2;
unsigned int unused_3 : 5;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} lin;
struct {
// See generic definition above.
unsigned int protocoltype : 6;
// use can FD baudswitch on transmission
unsigned int xmit_canfd_switch : 1;
// use can FD frame on transmission
unsigned int xmit_canfd_frame : 1;
// use can 29 bit frame id if set on transmission
unsigned int xmit_can_11_29bit : 1;
// expect can 29 bit frame id if set on reception
unsigned int expect_can_11_29bit : 2;
// shorten sf (single frame) on transmission
unsigned int xmit_shortensf : 1;
// shorten last consecutive frame on transmission
unsigned int xmit_shortenlcf : 1;
unsigned int unused_1 : 3;
// See generic definition above.
unsigned int use_std_posresp : 1;
// See generic definition above.
unsigned int use_std_negresp : 1;
// See generic definition above.
unsigned int slaveprotocol : 1;
// See generic definition above.
unsigned int expect_shortenedsf : 2;
// 0: no (Only full frames are accepted)
// 1: yes (Only shortened frames are accepted)
// 2: ignore, accept both (Full and shortened frames are accepted)
unsigned int expect_shortenedlcf : 2;
// 0: no (Only CAN-FD frames without baudswitch are accepted)
// 1: yes (Only CAN-FD frames with baudswitch are accepted)
// 2: ignore, accept both (All CAN-FD frames are accepted)
unsigned int expect_canfd_switch : 2;
// 0: no (Only normal CAN frames are accepted)
// 1: yes (Only CAN-FD frames are accepted)
// 2: ignore, accept both (All CAN frames are accepted)
unsigned int expect_canfd_frame : 2;
// 1: don't wait for FlowControl on IsoTp transmissions
unsigned int xmit_no_flowctrl_wait : 1;
// See generic definition above.
unsigned int accept_any_csize : 1;
// See generic definition above.
unsigned int xmit_shortenflowctrl : 1;
} can;
} ADHOC_PROTOCOL_FLAGS;
// ! Ad-Hoc protocol
typedef struct _BLC_ADHOC_PROTOCOL {
const char* name;
ADHOC_PROTOCOL_FLAGS flags;
unsigned char active;
int req_slot_time;
int rsp_slot_time;
int rsp_delay;
unsigned char fill_byte;
} BLC_ADHOC_PROTOCOL;
typedef union {
struct {
unsigned int unused_1 : 2;
unsigned int unused_2 : 2;
// shorten sf (single frame) on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortensf_txd : 2;
// expect shorten sf (single frame) on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortensf_rcv : 2;
// shorten last consecutive frame on transmission
// 0: no
// 1: yes
// 2: default from protocol
unsigned int shortenlcf_txd : 2;
// shorten last consecutive frame on reception
// 0: no
// 1: yes
// 2: ignore
unsigned int shortenlcf_rcv : 2;
unsigned int unused_3 : 8;
// if set a pos response has to fulfil RSID = SID | 0x40 rule other wise everything with
// matching length is positive signals are mapped on positive Response only
unsigned int use_std_posresp : 2;
// interpret neg. response as 0x7f sid errorcode
unsigned int use_std_negresp : 2;
// Service does not expect a answer, if set
unsigned int requestonly : 1;
unsigned int unused_4 : 2;
// accept any containersize on reception
unsigned int accept_any_csize : 2;
unsigned int unused_5 : 3;
} generic;
struct {
// Checksum type for transmission
// 0: classic
// 1: enhanced
// 2: protocol default
unsigned int checksum_txd : 2;
// Checksum type for reception
// 0: classic
// 1: enhanced
// 2: ignore
unsigned int checksum_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
unsigned int unused_1 : 8;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int unused_2 : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_3 : 3;
} lin;
struct {
// CAN frame id type for transmission
// 0: 11 Bit
// 1: 29 Bit
// 2: Protocol default
unsigned int id_11_29_txd : 2;
// CAN frame id type for reception
// 0: 11 Bit
// 1: 29 Bit
// 2: ignore
unsigned int id_11_29_rcv : 2;
// See generic definition above.
unsigned int shortensf_txd : 2;
// See generic definition above.
unsigned int shortensf_rcv : 2;
// See generic definition above.
unsigned int shortenlcf_txd : 2;
// See generic definition above.
unsigned int shortenlcf_rcv : 2;
// CAN FD baudrate switching for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdbaudswitch_txd : 2;
// CAN FD baudrate switching for reception
// 0: off
// 1: on
// 2: ignore
unsigned int fdbaudswitch_rcv : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: protocol default
unsigned int fdframe_txd : 2;
// CAN FD frame for transmission
// 0: off
// 1: on
// 2: ignore
unsigned int fdframe_rcv : 2;
// See generic definition above.
unsigned int use_std_posresp : 2;
// See generic definition above.
unsigned int use_std_negresp : 2;
// See generic definition above.
unsigned int requestonly : 1;
unsigned int no_flowctrl_wait : 2;
// See generic definition above.
unsigned int accept_any_csize : 2;
unsigned int unused_1 : 3;
} can;
} ADHOC_SERVICE_FLAGS;
// ! Ad-Hoc service
typedef struct {
const char* name;
ADHOC_SERVICE_FLAGS flags;
int req_frame_id;
long long req_container_size;
long long req_payload_size;
int req_slot_time;
int rsp_frame_id;
long long rsp_container_size;
long long rsp_payload_size;
int rsp_slot_time;
int rsp_delay;
} BLC_ADHOC_SERVICE;
typedef struct {
int nad;
int p2_extended;
int flow_control_st_min;
int flow_control_block_size;
} BLC_ADHOC_EXECUTE;
// ! Carries information about one signal.
typedef struct _BLC_LOG {
// ! Index number of signal; see the SDF for the adequate number
int format_version;
// ! (0) channel source: channel.id / channel.signal_index, (1) group source: group.id / group.sub_index
unsigned int source_type;
// ! Information about the source of the log
union {
struct {
// ! the channel id
int id;
// ! the signal id
int signal_index;
} channel;
struct {
// ! the group id
int id;
// ! the sub index
int sub_index;
} group;
} source;
// ! unix time index of the log (in sec).
unsigned long long timestamp_unix;
// ! Global time index of the log (in usec).
unsigned long timestamp_usec;
// ! Value type of the value content 0x0 unsigned, 0x1 signed
unsigned int value_signed;
// ! byte size of one element (possible values are one of {1, 2, 4, 8})
unsigned int value_element_size;
// ! array size of the value (is always greater then 0)
unsigned int value_array_size;
// ! values as single value if value_array_size == 1 or as array of values for value_array_size > 1
unsigned char value_data[4 * 1024];
} BLC_LOG;
/** @}*/
/** @addtogroup callback_handling Callback Handling
* @brief List of functions to manage callback functions
*
* The following functions are used to register callback functions for a BabyLIN connection.
* A callback will be called whenever a corresponding message is received on the connection it is
* registered to ( push method ). If you want to use a pull method to retrieve the data, have a look
* at the @ref pull_handling section of the documentation
*
* The device, that generated the callback must not be closed from within the callback.
* @{
*/
// !these Callbacks will tell you the data(as done with old callbacks) AND the Channel which send
// the Data !to find out which Device send the data use => !BL_HANDLE hConnection =
// BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func)(BL_HANDLE, BLC_FRAME frame);
typedef void(BLC_jumboframe_callback_func)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame);
typedef void(BLC_signal_callback_func)(BL_HANDLE, BLC_SIGNAL signal);
typedef void(BLC_macrostate_callback_func)(BL_HANDLE, BLC_MACROSTATE macroState);
typedef void(BLC_error_callback_func)(BL_HANDLE, BLC_ERROR error);
typedef void(BLC_debug_callback_func)(BL_HANDLE, const char* text);
typedef void(BLC_dtl_request_callback_func)(BL_HANDLE, BLC_DTL dtl_request);
typedef void(BLC_dtl_response_callback_func)(BL_HANDLE, BLC_DTL dtl_response);
typedef void(BLC_event_callback_func)(BL_HANDLE, BLC_EVENT event);
// !these Callbacks will tell you the data(as done with old callbacks), plus the Channel which send
// the Data and a user data pointer !added when registering the function !to find out which Device
// send the data use => !BL_HANDLE hConnection = BLC_getConnectionOfChannel(BLC_CHANNEL hChannel);
typedef void(BLC_frame_callback_func_ptr)(BL_HANDLE, BLC_FRAME frame, void*);
typedef void(BLC_jumboframe_callback_func_ptr)(BL_HANDLE, BLC_JUMBO_FRAME jumbo_frame, void*);
typedef void(BLC_signal_callback_func_ptr)(BL_HANDLE, BLC_SIGNAL signal, void*);
typedef void(BLC_macrostate_callback_func_ptr)(BL_HANDLE, BLC_MACROSTATE macroState, void*);
typedef void(BLC_error_callback_func_ptr)(BL_HANDLE, BLC_ERROR error, void*);
typedef void(BLC_debug_callback_func_ptr)(BL_HANDLE, const char* text, void*);
typedef void(BLC_dtl_request_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_request, void*);
typedef void(BLC_dtl_response_callback_func_ptr)(BL_HANDLE, BLC_DTL dtl_response, void*);
typedef void(BLC_event_callback_func_ptr)(BL_HANDLE, BLC_EVENT event, void*);
typedef void(BLC_log_callback_func_ptr)(BL_HANDLE, BLC_LOG log, void*);
typedef void(BLC_lua_print_func_ptr)(const char* msg, void* userdata);
#endif // BABYLINCAN_TYPES_H

BIN
vendor/BabyLIN library/Windows_PC/BabyLINDLL.chm vendored
View File

Binary file not shown.

309
vendor/BabyLIN library/Windows_PC/BabyLINReturncodes.h vendored
View File

@ -1,309 +0,0 @@
#ifndef BABYLINRETURNCODES_H
#define BABYLINRETURNCODES_H
#if !defined(BL_DLLIMPORT)
#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __declspec(dllexport)
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#else
#if BUILD_BABYLIN_DLL
#define BL_DLLIMPORT __attribute__((visibility("protected")))
#else /* Not BUILDING_DLL */
#define BL_DLLIMPORT
#endif /* Not BUILDING_DLL */
#endif
#else
// #undef BL_DLLIMPORT
// #define BL_DLLIMPORT
#endif
#ifndef DEPRECATED
#ifdef _MSC_VER
#define DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__) | defined(__clang__)
#define DEPRECATED __attribute__((__deprecated__))
#else
#define DEPRECATED
#endif
#endif
// ! @brief represents a connection to a BabyLIN-device or one of the channels
typedef void* BL_HANDLE;
typedef int BL_ADHOC_HANDLE;
typedef const char* CPCHAR;
/** @addtogroup return_values Return Values
* @brief List of possible return values of BabyLINDLL functions
*
* The following values may be returned by BL_ and BLC_ functions to indicate the success or failure
* of an operation. Mostly, the functions will return BL_OK as an indicator for success. However,
* some functions use positive values to return the result of the function on success ( for example
* BL_getFrameCount will return the number of frames ).
* @{
*/
/** Function successfully completed. */
#define BL_OK 0
#define SDF_OK 0
/** Limit for separating BabyLIN- and PC-side errors; below there are all PC-side ones. */
#define BL_PC_SIDE_ERRORS -100000
/** Internal resource allocation problem. Maybe out of memory/handles/etc. */
#define BL_RESOURCE_ERROR -100001
/** Specified handle invalid. */
#define BL_HANDLE_INVALID -100002
/** There is no connection open. */
#define BL_NO_CONNECTION -100003
/** Serial port couldn't be opened or closed. */
#define BL_SERIAL_PORT_ERROR -100004
/** BabyLIN command syntax error. */
#define BL_CMD_SYNTAX_ERROR -100005
/** BabyLIN doesn't answer within timeout. */
#define BL_NO_ANSWER -100006
/** Unable to open a file. */
#define BL_FILE_ERROR -100007
/** Wrong parameter given to function. */
#define BL_WRONG_PARAMETER -100008
/** No data available upon request. */
#define BL_NO_DATA -100009
/** No SDF was loaded previously */
#define BL_NO_SDF -100010
/** Internal message format error */
#define BL_DP_MSG_ERROR -100011
/** The given signal_nr or name does not exist in loaded SDF */
#define BL_SIGNAL_NOT_EXISTENT -100012
/** The signal chosen is a scalar, but an array function was called */
#define BL_SIGNAL_IS_SCALAR -100013
/** The signal chosen is an array, but an scalar function was called */
#define BL_SIGNAL_IS_ARRAY -100014
/** The SDF is unsupported by connected Baby-LIN due to insufficient firmware version */
#define BL_SDF_INSUFFICIENT_FIRMWARE -100015
/** The given signal has no encoding */
#define BL_ENCODING_NOT_EXISTENT -100016
/** The given buffer is too small */
#define BL_BUFFER_TOO_SMALL -100017
/** There is no additional answer data present from last sendCommand-call */
#define BL_NO_ANSWER_DATA -100018
/** Additional data with given index/name not present */
#define BL_ANSWER_DATA_NOT_EXISTENT -100019
/** Device Supported no Channels */
#define BL_NO_CHANNELS_AVAILABLE -100020
/** Unknown command passed to sendCommand */
#define BL_UNKNOWN_COMMAND -100021
/** a sendCommand message timed out */
#define BL_TIMEOUT -100022
/** SDF can not be loaded to a the device due to incompatibility ( incompatible SDFV3 to SDFV2
* device ) */
#define BL_SDF_INCOMPATIBLE -100023
/** value passed as a SDF handle is not valid */
#define SDF_HANDLE_INVALID -100024
/** SDF can not be unloaded as the SDF is in use on a device */
#define SDF_IN_USE -100025
/** can not execute command because SDF download is in progress */
#define BL_DOWNLOAD_IN_PROGRESS -100026
/** function can not be executed due to wrong mode or configuration */
#define BL_INVALID_MODE -100027
/** The number of parameters is not valid for this method. */
#define BLC_UA_EXECUTION_FAILED -100093
/** The number of parameters is not valid for this method. */
#define BLC_UA_INVALID_PARAMETER_COUNT -100094
/** the value could not be read. the reason should be documented in the help file. */
#define BLC_UA_GET_VALUE_REJECTED -100095
/** One of the parameters is invalid. Like a null pointer in a @ref BLC_getUnsignedNumber or a
* value, that is outside of the permitted range, like setting 256 on a 8bit Number property. */
#define BLC_UA_INVALID_PARAMETER -100096
/** the property has no getter for that type e.g. a unsigned number can not be read from a Binary
* property. */
#define BLC_UA_NO_GETTER_DEFINED -100097
/** the property has no setter for that type e.g. a callback can not be stored into Binary property.
*/
#define BLC_UA_NO_SETTER_DEFINED -100098
/** the value given was not set. the reason should be documented in the help file.*/
#define BLC_UA_SET_VALUE_REJECTED -100099
/** A return value between @ref BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref
* BLC_UA_NOT_RESOLVABLE_TAG_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be found. The index of that key is the return value - @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST (this index is 0 based).*/
#define BLC_UA_NOT_RESOLVABLE_TAG_FIRST -100100
/** The given Path should not have more then 100 tags */
#define BLC_UA_NOT_RESOLVABLE_TAG_MAX -100200
/** The @ref ua_service_iso_tp, is supposed to send a request but has no request data. */
#define BLC_UA_NO_REQUEST_DATA -100201
/** During the reception of the Response or the Request a frame timeout occurred. */
#define BLC_UA_SERVICE_FRAME_ORDER -100202
/** A Frame send by the DLL was not echoed by the BabyLIN within timeout_frame milliseconds. You
* might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_SEND -100203
/** The Response was not received within timeout_response milliseconds. Maybe the Request is
* malformed? */
#define BLC_UA_SERVICE_TIMEOUT_RESPONSE -100204
/** A flow-control Frame send by the DLL was not echoed by the BabyLIN within timeout_frame
* milliseconds. You might have to do a disframe/mon_on with that FrameID. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_SEND -100205
/** The flow-control state reported by the target is not one of the known states. */
#define BLC_UA_SERVICE_FLOWCONTROL_INVALIDSTATE -100206
/** The flow-control state was "wait"(0x1) in more then max_flow_wait flow-control frames. */
#define BLC_UA_SERVICE_FLOWCONTROL_WAITSTATES -100207
/** The flow-control state was "overflow"(0x2). */
#define BLC_UA_SERVICE_FLOWCONTROL_OVERFLOW -100208
/** The flow-control was not issued by the other node. */
#define BLC_UA_SERVICE_TIMEOUT_FLOWCONTROL_RECEIVE -100209
/** The data for a frame to send can not be put into a frame with the specified frame length. */
#define BLC_UA_SERVICE_FRAME_PACKAGING_ERROR -100210
/** A return value between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX indicates that the path parameter given to one of the
* BLC_UnifiedAccess functions could not be resolved. The index of the object, that could not be
* found is the return value - @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST (this index is 0 based).
*/
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST -101100
/** The given Path should not have more then 100 objects */
#define BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX -101200
//
// ADHOC PROTOCOL ERROR CODES
//
#define BLC_ADHOC_INVALID_HANDLE -1
#define BLC_ADHOC_EXECUTE_RUNNING -102000
#define BLC_ADHOC_MCR_OFFSET 71000
//
// LUA RUNTIME ERROR CODES
//
#define BLC_LUA_RUNTIME_ERROR -103000
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
//-------Return Values from BabyLIN Devices-----------------------------------------------
//----------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------
/** Missing or unknown SDF header. This Error occurs when a File is read that is not a SDF File. */
#define BL_ERR_SDF_HEADER 98
/** A corrupted DPMSG was received. This happens when a DPMessage contains an invalid identifier. */
#define BL_ERR_DP_CORRUPT 101
/** An unexpected DPMSG was received. */
#define BL_ERR_DP_SEQUENCE 102
/** The SDF Section Type does not match the Channel Type it is loaded on to. */
#define BL_ERR_DP_MAPPING 103
/** The requested Action can not be carried out on the selected channel. */
#define BL_ERR_CHANNEL 104
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_TYPE 105
/** The Object you are trying to manipulate was never created. */
#define BL_ERR_NULLPOINTER 106
/** The Section Type does not Match the Channel Type. */
#define BL_ERR_SECTION_MAPPING 107
/** Dataflash/persistent memory could not be initialized. */
#define BL_ERR_DATAFLASH_INIT 108
/** Dataflash/persistent memory does not keep requested SDF index. */
#define BL_ERR_DATAFLASH_INDEX 109
/** Dataflash/persistent memory is to small to hold the SDF. */
#define BL_ERR_DATAFLASH_NOSPACE 110
/** Dataflash/persistent memory read or write error. */
#define BL_ERR_DATAFLASH 111
/** Licence for the requested feature is not installed. */
#define BL_ERR_LICENCE 112
/** Not sufficient Heap Space to perform the requested action. */
#define BL_ERR_HEAP_EXHAUSTED 113
/** Same as ERR_NULLPOINTER but Objects are restricted to Signals. */
#define BL_ERR_SIG_REFERENCE 114
/** Same as ERR_NULLPOINTER but Objects are restricted to Frames. */
#define BL_ERR_FRAME_REFERENCE 115
/** Same as ERR_NULLPOINTER but Objects are restricted to Configurations. */
#define BL_ERR_CFG_REFERENCE 116
/** Same as ERR_NULLPOINTER but Objects are restricted to MacroSelections. */
#define BL_ERR_MACROSEL_REFERENCE 117
/** Same as ERR_NULLPOINTER but Objects are restricted to Events. */
#define BL_ERR_EVENT_REFERENCE 118
/** Same as ERR_NULLPOINTER but Objects are restricted to SignalFunctions. */
#define BL_ERR_SIGFUNC_REFERENCE 119
/** The Loaded SDF is discarded because the checksum is wrong. */
#define BL_ERR_CRC 120
/** Same as ERR_SEQUENCE The requested Component is not yet initialized. */
#define BL_ERR_NOT_INITIALIZED 121
/** Same as ERR_FRAME_REFERENCE. */
#define BL_ERR_FRAMEID_LOOKUP_FAILED 122
/** Same as ERR_NULLPOINTER but Objects are restricted to Macros. */
#define BL_ERR_MACRO_REFERENCE 130
/** A parameter had an invalid value. */
#define BL_ERR_PARAMVALUE 200
/** Condition not be applied or is not full filled. */
#define BL_ERR_CONDITION 210
/** Invalid number of Parameters. */
#define BL_ERR_PARAMCOUNT 211
/** No more Services can be enqueued because the Service queue is full. */
#define BL_ERR_SERVICEQUEUE_EXHAUSTED 300
/** Error Parsing a parameter of a DPMSG. The parameter index will be added onto resulting in the
* final Error code. */
#define BL_ERR_DP_PARSE 900
/** Upper limit of the reserved ERR_DP_PARSE indices. */
#define BL_ERR_DP_PARSE_TOP 980
/** Same as ERR_PARAMVALUE+x but only for Array Size. */
#define BL_ERR_DP_ARRAY_SIZE 989
/** The DPMSG does not start with a message name. */
#define BL_ERR_DP_NONAME 990
/** The DPMSG name is empty. */
#define BL_ERR_DP_NAME_TO_SHORT 991
/** Same as ERR_DP_CORRUPT. Happens when the message name field is longer then the entire message.
*/
#define BL_ERR_DP_NAME_TO_LONG 992
/** Macro Command/Event Action is not known. */
#define BL_CMD_NOT_SUPPORTED 997
/** A not further specified Error. */
#define BL_ERR_UNDEF 998
/** An unknown Command was received. */
#define BL_ERR_UNKNOWN_CMD 999
/** A not further specified Error. */
#define BL_OPERATION_PENDING -1
/** The Macro result can not be read, because the macro is still running. */
#define BL_MACRO_STILL_RUNNING 150
/** The Macro can not be started, because the macro is still running. */
#define BL_MACRO_SAME_RUNNING 151
/** No more parallel Macros are allowed. */
#define BL_MACRO_OTHER_RUNNING 152
/** The Macro could not be started. */
#define BL_MACRO_START_FAIL 153
/** The initial Macro error value. */
#define BL_MACRO_NEVER_EXECUTED 154
/** Macro Result actually contains the error value. */
#define BL_MACRO_ERRCODE_IN_RESULT 155
/** Macro Result actually contains the exception value. */
#define BL_MACRO_EXCEPTIONCODE_IN_RESULT 156
/** @}*/
/**
* @brief type of an answer data token retrieve type using BLC_getAnswerTypeByName or
* BLC_getAnswerTypeByIndex
*/
typedef enum {
/** token is an integer value */
BL_ANSWER_TYPE_INT,
/** token is a string value */
BL_ANSWER_TYPE_STR,
/** token is a binary value */
BL_ANSWER_TYPE_BIN,
/** token is a 64BitInteger value */
BL_ANSWER_TYPE_INT64,
/** token is a Floatingpoint value */
BL_ANSWER_TYPE_FLOAT,
/** token is an unknown value */
BL_ANSWER_TYPE_UNKNOWN,
} BL_ANSWER_TYPE;
/**
* @brief DTL protocol status answers.
* Part of BLC_DTL data structure. Retrieve status of pending
* DTL actions using BLC_getDTLRequestStatus or BLC_getDTLResponseStatus.
*/
typedef enum {
/** DTL action completed */
LD_COMPLETED = 0,
/** DTL action failed */
LD_FAILED,
/** DTL action in progress */
LD_IN_PROGRESS,
} BL_DTL_STATUS;
#endif // BABYLINRETURNCODES_H

92
vendor/BabyLIN library/Windows_PC/BabyLINSDF.h vendored
View File

@ -1,92 +0,0 @@
#ifndef BABYLINSDF_H
#define BABYLINSDF_H
#include "BabyLINReturncodes.h"
// ! @brief represents a connection to a BabyLIN-device ( for old BabyLINs ) or
// one of the channels on new BabyLIN-devices
typedef void* BL_HANDLE;
typedef const char* CPCHAR;
#if defined(__cplusplus)
extern "C" {
#endif
/** @addtogroup l_sdf_functions
* @brief List of legacy SDF functions
*
* The following structures are used to retrieve data from a SDF loaded to a BabyLIN. As these
* functions requeire a loaded SDF onto a BabyLIN, a existing connection to a BabyLIN is mendatory.
* Please see the new SDF API in @ref sdf_functions on how to handle SDFs without a BabyLIN
* connection.
* @{
*/
// ! Get the SDF's number for node by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the node.
* @return Returns the node's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getNodeNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for signal by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the signal.
* @return Returns the signal's number or -1 if there's no signal with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getSignalNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for frame by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the frame.
* @return Returns the frame's number or -1 if there's no frame with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getFrameNr(BL_HANDLE handle, const char* name);
// ! Get the SDF's number for schedule by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the schedule.
* @return Returns the schedule's number or -1 if there's no schedule with specified name.
* Even smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getScheduleNr(BL_HANDLE handle, const char* name);
// ! Get the number of schedule tables in the SDF.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @return Returns the number of schedule tablesname or 0 if there's no schedule defined.
*/
int BL_DLLIMPORT BL_SDF_getNumSchedules(BL_HANDLE handle);
// ! Get the SDF's name of schedule by number.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param schedule_nr Index of the schedule.
* @return Returns the schedule's name or empty string if there's no schedule with
* specified index.
*/
CPCHAR BL_DLLIMPORT BL_SDF_getScheduleName(BL_HANDLE handle, int schedule_nr);
// ! Get the SDF's number for macro by name.
/**
* @param handle Handle representing the connection; returned previously by BL_open().
* @param name Name of the macro.
* @return Returns the macro's number or -1 if there's no macro with specified name. Even
* smaller numbers designate error codes as defined in BabyLIN.h.
*/
int BL_DLLIMPORT BL_SDF_getMacroNr(BL_HANDLE handle, const char* name);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // BABYLINSDF_H

342
vendor/BabyLIN library/Windows_PC/BabyLIN_UnifiedAccess.h vendored
View File

@ -1,342 +0,0 @@
#ifndef BABYLIN_UNIFIEDACCESS_H
#define BABYLIN_UNIFIEDACCESS_H
/**
* @addtogroup ua Unified Access
* @brief In the Unified Access interface the available features and values are structured in a tree
* of objects.
*
* @details
* Every object may have children, properties and methods, that are accessible through the __path__
* parameter of the functions. The children, properties and methods are identified by __tags__.
* Those tags are handle specific and described in this document. Additionally they can be listed by
* calling @ref BLC_discover with the handle you are interested in.
*
* ### Creation of new Objects
* To add a new Object into the tree use the @ref BLC_createHandle function. To create a new object
* a using __key value pairs__ ("<key>=<value>") is required. In a path each key value pair has to
* be separated by one space character. Tags valid for the creation keys can be taken from the
* "Creat tags" tables of the Objects documented in this document. The value is specifying the name
* property of the new child. Additionally key value pairs with property tags can be appended, to
* set properties during the object creation, so that less calls to the Setters are required
* afterwards. e.g. creating a @ref ua_protocol_iso_tp in a @ref ua_channel with the name "my_dtl" :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "new_iso_tp_protocol=my_dtl",
* &protocol_handle);
* ~~~
*
* ### Handles of existing Objects
* To find an existing Object in the tree use the @ref BLC_createHandle function. Navigating the
* tree is done by constructing a path by using __key value pairs__ ("<key>=<value>"). Tags valid
* for the keys can be taken from the "Child tags" tables of the Objects documented in this
* document. In a path each key value pair has to be separated by one space character. e.g. getting
* the handle to the previously created @ref ua_protocol_iso_tp of that @ref ua_channel :
* ~~~.c
* BL_HANDLE protocol_handle;
* BLC_createHandle(channel_handle, "protocol=my_dtl", &protocol_handle);
* ~~~
*
* ### Getters
* To read values of properties use @ref BLC_getSignedNumber, @ref BLC_getUnsignedNumber or @ref
* BLC_getBinary functions. The __path__ parameter has to end with the tag identifying the property
* to read. Valid tags can be taken from the "Property tags" tables of the Objects documented in
* this document. e.g. reading the requestFrameID from a @ref ua_service_iso_tp :
* ~~~.c
* uint64_t requestFrameID;
* BLC_getUnsignedNumber(service_handle, "req_frame_id", &requestFrameID);
* ~~~
*
* ### Setters
* To store values of properties use @ref BLC_setSignedNumber, @ref BLC_setUnsignedNumber, @ref
* BLC_setBinary or @ref BLC_setCallback functions. The __path__ parameter has to end with the tag
* identifying the property to store. Valid tags can be taken from the "Property tags" tables of the
* Objects documented in this document. e.g. setting the requestFrameID of a @ref ua_service_iso_tp
* to 59 :
* ~~~.c
* BLC_setUnsignedNumber(service_handle, "req_frame_id", 59);
* ~~~
*
* ### Execution of Methods
* To execute an object's method use @ref BLC_execute or @ref BLC_execute_async functions. In the
* path variable only the identifying tag is required. Valid tags can be taken from the "Method
* tags" tables of the Objects documented in this document. Functions might have parameters. Those
* can be specified by appending key value pairs to the path in the same manner as when creating new
* objects. The order of the parameters is not relevant. In some cases a synchronous call is not
* applicable, in these cases use @ref BLC_execute_async to execute the method in a dedicated
* thread. e.g. executing a @ref ua_service_iso_tp :
* ~~~.c
* BLC_execute(service_handle, "execute");
* ~~~
* @{
*/
#include "BabyLINCAN.h"
#if defined(__cplusplus)
#include <cstddef>
#include <cstdint>
extern "C" {
#else
#include <stddef.h>
#include <stdint.h>
#endif
/**
* @brief The function prototype used for registering callbacks.
*
* The handle is the handle to the Object, that triggered the callback.<br/> The userdata pointer is
* the userdata specified when registering the callback.
*
* The device, that generated the callback must not be closed from within the callback.
*/
typedef void (*BLC_unifiedaccess_callback_func_ptr)(BL_HANDLE handle, void* userdata);
/**
* @brief The function prototype used for executing asynchron tasks.
*
* The result value is the value returned by the actual execute call.<br/> The handle is the handle
* to the Object, that triggered the callback.<br/> The userdata pointer is the userdata specified
* when registering the callback.<br/>
*/
typedef void (*BLC_unifiedaccess_async_callback_func_ptr)(int32_t result,
BL_HANDLE handle,
void* userdata);
/**
* @brief BLC_createHandle retrieves a handle to a loaded Object or creates a new Object.
*
* These Objects can range from Devices and SDFs down to Signals.<br> When retrieving a handle to
* an existing item the path has to end with a key value pair, where the key is a tag of the objects
* children list. When creating a new Object the "new_*=*" key value pair can be followed by key
* value pairs from the new objects property list, to initialize them.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from key value pairs, separated by spaces e.g.
* "protocol=1 service=2".
* @param result Value to store the new handle in.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the corresponding
* key-value-pair in the path parameter could not be resolved correctly.<br> If the returned value
* is between @ref BLC_UA_REQUESTED_OBJECT_NOT_FOUND_FIRST and @ref
* BLC_UA_REQUESTED_OBJECT_NOT_FOUND_MAX the corresponding key-value-pair in the path parameter
* tries to access a non existing Object.<br> If @ref BLC_UA_GET_VALUE_REJECTED is returned the
* requested Object was found but handles to this type of Object can not be created.<br> In case of
* Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_createHandle(BL_HANDLE handle, const char* path, BL_HANDLE* result);
/**
* @brief BLC_destroy removes the handle from the currently opened Objects and removes the Object
* from its parent.
*
* The given handle will be removed from the available handles and the Object behind it will be
* destroyed.
* @param handle The handle of the object to destroy.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_destroy(BL_HANDLE handle);
/**
* @brief BLC_releaseHandle removes the handle from the currently opened Objects.
*
* The given handle will be release, but a new handle to the underling object can be retrieved
* again.
* @param handle The handle to release.
* @return @ref BL_OK if no error occurred. In case of Error refer to the @ref
* BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_releaseHandle(BL_HANDLE handle);
/**
* @brief BLC_discover fills the result array with space separated identifiers, that can be used in
* the path parameters.
*
* Lists the available __Tags__ of the object separated by spaces.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags ending with either
* "property","child", "create", "execute" or "all".<br> "property" will list all __Tags__ usable in
* BLC_get...() and or BLC_set...().<br> "child" will list all __Tags__ usable in BLC_createHandle
* for already existing objects.<br> "create" will list all __Tags__ usable in BLC_createHandle for
* creating new objects.<br> "execute" will list all __Tags__ usable in BLC_execute and
* BLC_execute_async.<br> "all" will list all __Tags__ in the form of "property:=<tags
* >\nchild:=<tags >\ncreate:=<tags >\nexecute:=<tags>".
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, that will be set to the length of
* the result data.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_discover(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_getSignedNumber gets a signed value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed and has less then 64 bits sign extension will be applied, so negative
* values stay negative.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getSignedNumber(BL_HANDLE handle, const char* path, int64_t* result);
/**
* @brief BLC_getUnsignedNumber gets a unsigned value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is signed no sign extension will be applied, so 8 bit -1 will be 255.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The target value.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t* result);
/**
* @brief BLC_getBinary gets a binary value from the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. A only Number or only
* Boolean property will be read as a string representation of it.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param result The buffer to fill, if a null pointer is provided here only the result_length
* will be filled.
* @param result_length Is a pointer to the length of the buffer, this parameter will be set to the
* length of the result data. If the result buffer is too small no data will be
* copied and only result_length will be updated.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_getBinary(BL_HANDLE handle,
const char* path,
uint8_t* result,
uint32_t* result_length);
/**
* @brief BLC_setSignedNumber sets a signed value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setSignedNumber(BL_HANDLE handle, const char* path, int64_t value);
/**
* @brief BLC_setUnsignedNumber sets an unsigned value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Number or Boolean property. If
* that property is too small to represent the value the set is rejected.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setUnsignedNumber(BL_HANDLE handle, const char* path, uint64_t value);
/**
* @brief BLC_setBinary sets a binary value of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a property. For a only Number or
* only Boolean property the given value will be parsed as a string, that is then handed to @ref
* BLC_setUnsignedNumber or @ref BLC_setSignedNumber.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param value The value to set.
* @param value_length The length of the value to set.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setBinary(BL_HANDLE handle,
const char* path,
const uint8_t* value,
uint32_t value_length);
/**
* @brief BLC_setCallback sets a callback function for an event of the given handle.
*
* The path will be followed and the last __Tag__ has to identify a Callback property. Only one
* callback can be registered per event per object.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to set, use a null pointer to deactivate the callback.
* @param userdata The parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_setCallback(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_callback_func_ptr callback,
void* userdata);
/**
* @brief BLC_execute executes a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a blocking
* manner.
* @param handle the handle to start the query from.
* @param path the query, it is a cstring build from entries of tags.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute(BL_HANDLE handle, const char* path);
/**
* @brief BLC_execute_async a method of the given handle.
*
* The path will be followed and a __Tag__ that identifies a Method property, followed by the
* __Tags__ to set additional parameters of that method. The Method will be executed in a non
* blocking manner, so the returned value does not state anything about whether the operation was
* successful, or not, but only if it was found or not. To get the result value you would get from
* @ref BLC_execute use the first parameter of the @ref BLC_unifiedaccess_async_callback_func_ptr.
* @param handle The handle to start the query from.
* @param path The query, it is a cstring build from entries of tags.
* @param callback The callback to call once the operation is complete.
* @param userdata The additional parameter to call the callback with.
* @return @ref BL_OK if no error occurred. If the returned value is between @ref
* BLC_UA_NOT_RESOLVABLE_TAG_FIRST and @ref BLC_UA_NOT_RESOLVABLE_TAG_MAX the
* corresponding key-value-pair in the path parameter could not be resolved
* correctly. In case of Error refer to the @ref BabyLINReturncodes.h file.
*/
int32_t BL_DLLIMPORT BLC_execute_async(BL_HANDLE handle,
const char* path,
BLC_unifiedaccess_async_callback_func_ptr callback,
void* userdata);
#if defined(__cplusplus)
}
#endif
/**
* @}
*/
#endif // BABYLIN_UNIFIEDACCESS_H

120
vendor/BabyLIN library/Windows_PC/SDF.h vendored
View File

@ -1,120 +0,0 @@
#ifndef SDF_H
#define SDF_H
#include "BabyLINReturncodes.h"
typedef struct {
int sectionNr;
// ! Sectiontype (i.e. 0 = LIN, 1 = CAN, 99 = DEVICE)
int type;
char name[64];
char description[4096];
} SDF_SECTIONINFO;
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @addtogroup sdf_functions
* @brief List of SDF functions
*
* The following structures are used to load and retrieve data from a SDF. The API allows to load
* and retrieve SDF informations without an existing BabyLIN-Device connection and is particulaly
* useful for SDF preloading or SDF loading to download to multiple BabyLIN devices. Functions
* prefixed with BLC_ require an existing connection to a BabyLIN with a loaded SDF on the
* corresponding channel.
*
* @{
*/
#define SDF_OK 0
#define SDF_HANDLE_INVALID -100024
#define SDF_IN_USE -100025
typedef void* SDF_HANDLE;
/**
* @brief Loads a SDFile to memory and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_open(const char* filename);
/**
* @brief Loads a LDFFile to memory, creates a temporary SDF and returns a @ref SDF_HANDLE
*
* @param[in] filename The filename to load, can be absolute or relative to the current working
* directory
* @return To the loaded SDFile or 0 on error
*/
SDF_HANDLE BL_DLLIMPORT SDF_openLDF(const char* filename);
/** @brief Closes a SDFile opened using @ref SDF_open
*
* @param[in] handle The SDFile handle to close
* @return 0 on success
*/
int BL_DLLIMPORT SDF_close(SDF_HANDLE handle);
/**
* @brief Returns whether the command overwriting feature for macro names is enabled
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return 0 = feature disabled for this SDF, 1 = feature enabled, commands will be
* interpreted as macro names first, if that fails, it will execute the normal
* command e.g "reboot", if it exists.
*/
int BL_DLLIMPORT SDF_hasMacroCommandOverwriteEnabled(SDF_HANDLE sdfhandle);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sdfhandle The SDFile from @ref SDF_open to download
* @param[in] blhandle The BabyLIN connection handle from @ref BLC_open to download to
* @param[in] mode See @ref BLC_loadSDF modes
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadToDevice(SDF_HANDLE sdfhandle, BL_HANDLE blhandle, int mode);
/**
* @brief Download a SDFile to a BabyLIN device
*
* @param[in] sectionhandle The SDFile from @ref SDF_open to download
* @param[in] channelhandle The BabyLIN channel handle from @ref BLC_getChannelHandle to download to
* @return See @ref BLC_loadSDF returncodes (0 = success)
*/
int BL_DLLIMPORT SDF_downloadSectionToChannel(SDF_HANDLE sectionhandle, BL_HANDLE channelhandle);
/**
* @brief Get number of sections in SDF
*
* @param[in] sdfhandle The SDFile from @ref SDF_open
* @return Number of sections ( negative value on error )
*/
int BL_DLLIMPORT SDF_getSectionCount(SDF_HANDLE sdfhandle);
/**
* @brief Get handle to a section of a sdf
* @param[in] handle The handle of the sdf to get the section handle from
* @param[in] sectionNr The section number to get the handle for
* @return Handle to the section ( 0 on error )
*/
SDF_HANDLE BL_DLLIMPORT SDF_getSectionHandle(SDF_HANDLE handle, int sectionNr);
/**
* @brief Get information about a section
* @param[in] handle The section handle to retrieve informations about
* @param[out] info Pointer to pre-allocated @ref SDF_SECTIONINFO structure to fill
* @return 0 on success
*/
int BL_DLLIMPORT SDF_getSectionInfo(SDF_HANDLE handle, SDF_SECTIONINFO* info);
/** @} */
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // SDF_H

3371
vendor/BabyLIN_library.py vendored
View File

File diff suppressed because it is too large Load Diff

BIN
vendor/Example.sdf vendored
View File

Binary file not shown.

95
vendor/Owon/owon_psu_quick_demo.py vendored
View File

@ -1,95 +0,0 @@
"""Owon PSU quick demo (optimized to use ecu_framework.power.owon_psu).
This script reads configuration from OWON_PSU_CONFIG (YAML) or ./config/owon_psu.yaml,
prints discovered ports responding to *IDN?, then connects to the configured port
and performs a small sequence (IDN, optional V/I set, toggle output, measure V/I).
No CLI flags; edit YAML to change behavior.
"""
from __future__ import annotations
import os
import time
from pathlib import Path
import yaml
try:
from ecu_framework.power import OwonPSU, SerialParams, scan_ports
except ModuleNotFoundError:
# Ensure repository root is on sys.path when running this file directly
import sys
repo_root = Path(__file__).resolve().parents[2]
if str(repo_root) not in sys.path:
sys.path.insert(0, str(repo_root))
from ecu_framework.power import OwonPSU, SerialParams, scan_ports
def _load_yaml_config() -> dict:
cfg_path = str(Path("config") / "owon_psu.yaml")
p = Path(cfg_path).resolve()
print("Using config path:", str(p))
if not p.is_file():
return {}
with p.open("r", encoding="utf-8") as f:
data = yaml.safe_load(f) or {}
return data if isinstance(data, dict) else {}
def run_demo() -> int:
cfg = _load_yaml_config()
if not cfg or "port" not in cfg:
print("Config not found or missing 'port'. Set OWON_PSU_CONFIG or create ./config/owon_psu.yaml")
return 2
print("Scanning ports (responding to *IDN?):")
for dev, idn in scan_ports(SerialParams(baudrate=int(cfg.get("baudrate", 115200)), timeout=float(cfg.get("timeout", 1.0)))):
print(f" {dev} -> {idn}")
# Serial params
baud = int(cfg.get("baudrate", 115200))
timeout = float(cfg.get("timeout", 1.0))
eol = cfg.get("eol", "\n")
from serial import PARITY_NONE, PARITY_EVEN, PARITY_ODD, STOPBITS_ONE, STOPBITS_TWO
parity = {"N": PARITY_NONE, "E": PARITY_EVEN, "O": PARITY_ODD}.get(str(cfg.get("parity", "N")).upper(), PARITY_NONE)
stopbits = {1: STOPBITS_ONE, 2: STOPBITS_TWO}.get(int(float(cfg.get("stopbits", 1))), STOPBITS_ONE)
xonxoff = bool(cfg.get("xonxoff", False))
rtscts = bool(cfg.get("rtscts", False))
dsrdtr = bool(cfg.get("dsrdtr", False))
ps = SerialParams(
baudrate=baud,
timeout=timeout,
parity=parity,
stopbits=stopbits,
xonxoff=xonxoff,
rtscts=rtscts,
dsrdtr=dsrdtr,
)
port = str(cfg["port"]).strip()
do_set = bool(cfg.get("do_set", False))
set_v = float(cfg.get("set_voltage", 1.0))
set_i = float(cfg.get("set_current", 0.1))
with OwonPSU(port, ps, eol=eol) as psu:
idn = psu.idn()
print(f"IDN: {idn}")
print(f"Output status: {psu.output_status()}")
if do_set:
psu.set_output(True)
time.sleep(0.5)
psu.set_voltage(1, set_v)
psu.set_current(1, set_i)
time.sleep(1.0)
print(f"Measured V: {psu.measure_voltage()} V")
print(f"Measured I: {psu.measure_current()} A")
time.sleep(0.5)
psu.set_output(False)
return 0
if __name__ == "__main__":
raise SystemExit(run_demo())

59
vendor/README.md vendored
View File

@ -1,59 +0,0 @@
# BabyLIN SDK placement
Place the SDK's Python wrapper and platform-specific libraries here so the test framework can import and use them.
## Required files
- BabyLIN_library.py
- BabyLIN library/ (directory provided by the SDK containing platform-specific binaries)
- Windows: `BabyLIN library/Windows/x64/*.dll`
- Linux x86_64: `BabyLIN library/Linux/x86_64/*.so`
- Raspberry Pi (ARM): `BabyLIN library/Linux/armv7/*.so` (or as provided by your SDK)
- Optional: Example SDF file (e.g., `Example.sdf`)
Folder structure example:
```
vendor/
├─ BabyLIN_library.py
├─ Example.sdf
└─ BabyLIN library/
├─ Windows/
│ └─ x64/
│ ├─ BabyLIN.dll
│ ├─ BabyLIN_FTDI.dll
│ └─ ... (other DLLs from SDK)
├─ Linux/
│ ├─ x86_64/
│ │ └─ libBabyLIN.so
│ └─ armv7/
│ └─ libBabyLIN.so
└─ ...
```
Notes:
- Keep the directory names and casing exactly as the SDK expects (often referenced in `BabyLIN_library.py`).
- Ensure your Python environment architecture matches the binaries (e.g., 64-bit Python with 64-bit DLLs).
- On Linux/RPi, you may need to set `LD_LIBRARY_PATH` to include the directory with the shared libraries.
## Configuration
Point your config to the SDF and schedule:
```yaml
interface:
type: babylin
channel: 0
sdf_path: ./vendor/Example.sdf
schedule_nr: 0
```
## Troubleshooting
- ImportError: BabyLIN_library not found
- Ensure `vendor/BabyLIN_library.py` exists or add the vendor folder to `PYTHONPATH`.
- DLL/SO not found
- On Windows, ensure the DLLs are in PATH or next to `BabyLIN_library.py` per SDK instructions.
- On Linux/RPi, export `LD_LIBRARY_PATH` to the folder with the `.so` files.
- Device not found
- Check USB connection, drivers, and that no other tool holds the device open.

0
vendor/__init__.py vendored
View File

116
vendor/mock_babylin_wrapper.py vendored
View File

@ -1,116 +0,0 @@
"""Mock implementation of the BabyLIN SDK wrapper API used by our adapter.
This module provides create_BabyLIN() returning an object with BLC_* methods,
so the real adapter can be exercised without hardware.
Design notes:
- We simulate a single device with one channel and an RX queue per channel.
- Transmit (BLC_mon_set_xmit) echoes payload into the RX queue to mimic loopback.
- Master request (BLC_sendRawMasterRequest) enqueues a deterministic response so
tests can validate request/response logic without randomness.
"""
from dataclasses import dataclass
from typing import List
BL_OK = 0 # Success code matching the real SDK convention
@dataclass
class BLC_FRAME:
"""Minimal frame structure to mirror the SDK's BLC_FRAME used by the adapter."""
frameId: int
lenOfData: int
frameData: bytes
class _MockChannel:
"""Represents a BabyLIN channel with a simple RX queue."""
def __init__(self):
self.rx: List[BLC_FRAME] = [] # FIFO for received frames
class _MockBL:
"""BabyLIN mock exposing the subset of BLC_* APIs our adapter calls."""
def __init__(self):
self.BL_OK = BL_OK
self._ports = ["MOCK_PORT"] # Simulate one discoverable device
self._handle = object() # Opaque handle placeholder
self._channels = [_MockChannel()] # Single channel system
# -----------------------------
# Discovery/open/close
# -----------------------------
def BLC_getBabyLinPorts(self, timeout_ms: int):
"""Return a list of mock ports; timeout not used in mock."""
return list(self._ports)
def BLC_openPort(self, port: str):
"""Return an opaque handle for the given port name."""
return self._handle
def BLC_closeAll(self):
"""Pretend to close; always succeeds."""
return BL_OK
# -----------------------------
# SDF and channel handling
# -----------------------------
def BLC_loadSDF(self, handle, sdf_path: str, download: int):
"""No-op in mock; assume success."""
return BL_OK
def BLC_getChannelCount(self, handle):
"""Report number of channels (1 in mock)."""
return len(self._channels)
def BLC_getChannelHandle(self, handle, idx: int):
"""Return the channel object acting as its own handle."""
return self._channels[idx]
def BLC_sendCommand(self, channel, command: str):
"""Accept any command (e.g., start schedule); always succeed."""
return BL_OK
# -----------------------------
# Transmit/Receive primitives
# -----------------------------
def BLC_mon_set_xmit(self, channel: _MockChannel, frame_id: int, data: bytes, slot_time: int):
"""Echo transmitted payload back to RX to simulate a bus loopback."""
channel.rx.append(BLC_FRAME(frameId=frame_id, lenOfData=len(data), frameData=bytes(data)))
return BL_OK
def BLC_getNextFrameTimeout(self, channel: _MockChannel, timeout_ms: int):
"""Pop next frame from RX queue; return None on timeout (empty queue)."""
if channel.rx:
return channel.rx.pop(0)
# Simulate timeout -> real wrapper may raise; we return None for simplicity
return None
def BLC_sendRawMasterRequest(self, channel: _MockChannel, frame_id: int, payload_or_length):
"""Simulate a slave response for a master request.
Supports two call forms to mirror SDK variations:
- (channel, frame_id, bytes): use bytes as the response payload
- (channel, frame_id, length): synthesize payload with a deterministic pattern
"""
if isinstance(payload_or_length, (bytes, bytearray)):
data = bytes(payload_or_length)
else:
length = int(payload_or_length)
# Deterministic pattern: response[i] = (frame_id + i) & 0xFF
data = bytes(((frame_id + i) & 0xFF) for i in range(max(0, min(8, length))))
# Enqueue the response frame as if the slave published it on the bus
channel.rx.append(BLC_FRAME(frameId=frame_id, lenOfData=len(data), frameData=data))
return BL_OK
def BLC_getDetailedErrorString(self, rc: int):
"""Provide a friendly error string for non-OK return codes."""
return f"Mock error rc={rc}"
def create_BabyLIN():
"""Factory method matching the real SDK to construct the mock instance."""
return _MockBL()