Skip to content

Latest commit

 

History

History
276 lines (228 loc) · 19.5 KB

File metadata and controls

276 lines (228 loc) · 19.5 KB

NobroRTOS API Index

Generated by tools/build/gen_api_index.py from the crate sources.

nobro-adapter-motion-ai

Motion classifier: a bounded on-device inference adapter (AiInferenceSal).

  • struct: MotionClassifier
  • enum: MotionError
  • fn: new

nobro-adapter-nn-motion-ai

Neural-network motion classifier: a bounded on-device inference adapter

  • struct: NnMotionClassifier, Nn3MotionClassifier
  • enum: NnError
  • fn: new, new

nobro-adapter-audio-esp32s3-es8311

Bounded ESP32-S3 + ES8311 bridge.

  • trait: Esp32s3Es8311Transport
  • struct: AudioDiagnostics, Esp32s3Es8311
  • enum: TransportError
  • fn: into_inner

nobro-eh-i2c

embedded-hal 1.0 I2C adapter over the NobroRTOS TWIM bus.

  • struct: NobroI2cError, NobroI2c
  • fn: new, scan_device_count, recover

nobro-eh-spi

embedded-hal 1.0 SpiDevice adapter over the NobroRTOS SPIM0 bus.

  • struct: NobroSpiError, NobroSpiDevice

nobro-adapter-camera-niuscam

Allocation-free ownership bridge for NiusCam-class transports.

  • trait: NiusCamTransport
  • struct: NiusCamBackend
  • fn: transport_mut

nobro-adapter-icm45686

ICM-45686 sensor adapter, generic over embedded-hal I2C.

  • struct: Icm45686
  • fn: to_milli, new, who_am_i, decode_accel, decode_gyro

nobro-adapter-mpu9250-imu

Portable MPU9250-family adapter.

  • trait: MonotonicClock, InterruptSource, BusLease
  • struct: NoInterrupt, NoLease, Mpu9250TransportDiagnostics, PortableMpu9250Imu, NrfClock, NrfDelay, NrfLease
  • enum: Mpu9250Error
  • fn: mount, module_spec, accel_mag_mg, imu_plausible, probe_and_init, scan_device_count

nobro-adapter-ina3221

INA3221 3-channel power monitor driver, generic over embedded_hal::i2c::I2c.

  • struct: InaChannel, Ina3221
  • fn: new, manufacturer_id, read_channel, read_all

nobro-adapter-ros-imu-bridge

Bounded ROS-style IMU topic bridge (RosBridgeSal).

  • struct: RosImuBridge
  • enum: RosError
  • fn: published, transmitted, dropped, max_depth, pump

nobro-adapter-bmp280

BMP280 pressure + temperature sensor adapter, generic over embedded_hal::i2c::I2c.

  • struct: Bmp280Calib, Bmp280
  • fn: compensate_temp, compensate_pressure, new, chip_id, load_calibration, calibration

nobro-adapter-sensors-esp32-adc-continuous

  • trait: Esp32AdcContinuousTransport
  • struct: AdcDiagnostics, Esp32AdcContinuous
  • enum: TransportError
  • fn: into_inner

nobro-adapter-servo-esp32-ledc

  • trait: Esp32LedcTransport
  • struct: Esp32Ledc

nobro-adapter-servo-esp32-rmt

  • trait: Esp32RmtTransport
  • struct: Esp32Rmt
  • enum: TransportError

nobro-adapter-robo-servo

RoboServo-style ActuatorSal using the nRF52840 PWM backend.

  • struct: RoboServoAdapter
  • enum: RoboServoError
  • fn: new, module_spec

nobro-adapter-sensor-stub

SensorSal stub with synthetic IMU samples when no NiusIMU hardware is connected.

  • struct: SensorStubProfile, SensorStub
  • enum: SensorStubError, SensorStubMode
  • fn: new, with_profile, owner, stub_i2c_addr, profile, set_mode, tick_count, poll_at, module_spec, stub_imu_plausible

nobro-adapter-wireless-ble-arduino-ble

Bounded bridge for ArduinoBLE peripheral stacks.

  • trait: ArduinoBleTransport
  • struct: TimedOperation, ArduinoBleDiagnostics, ArduinoBle
  • enum: TransportError
  • fn: into_inner

nobro-adapter-wireless-ble-arduino-esp

  • enum: ArduinoEspTarget, VendorHost

nobro-adapter-radio-comms

Framed radio comms as a managed nobro-wireless backend over the nRF RADIO.

  • struct: RadioComms
  • enum: RadioCommsError
  • fn: acquire, release

nobro-adapter-wireless-wifi-arduino-esp

  • fn: valid_credentials

nobro-adapter-wireless-wifi-arduino-wifis3

Bounded bridge for the Arduino UNO R4 WiFiS3 stack.

  • trait: ArduinoWifiS3Transport
  • struct: TimedJoin, WifiS3Diagnostics, ArduinoWifiS3
  • enum: TransportError
  • fn: into_inner

nobro-admission

Allocation-free admission shared by firmware build scripts and the kernel.

  • struct: AdmissionProfile, TaskContract, IsrOperations, InterruptContract, InterruptProfile, AdmissionError, AdmittedTask, AdmittedWorkload
  • enum: AdmissionErrorCode
  • fn: validate_runtime, admit_runtime_into

nobro-ai

AI deployment + cloud-API management for NobroRTOS.

  • struct: ModelManifest, ApiKeyRef, CloudPolicy, CloudSession
  • enum: WeightFormat, DeployError, LinkState, LinkEvent
  • fn: fnv1a, validate, dequant, new, state, key, backoff_ms, on_event, tick, take_request, reset_budget

nobro-audio

Allocation-free audio contracts with explicit format, lifecycle, and backpressure.

  • trait: AudioBackend, MountableAudioBackend, TimedAudioBackend
  • struct: CodecConfig, AudioInstanceId, AudioBackendIdentity, AudioMountReceipt, AudioResourcePrice, MountedAudio, AudioMountError, AudioRing
  • enum: SampleFormat, AudioState, AudioError
  • fn: mount, backend, backend_mut, into_backend, capture, playback, quiesce, recover, push, pop_into

nobro-camera

Allocation-free camera contracts with explicit deadline and memory admission.

  • trait: CameraFrame, CameraBackend, MountableCameraBackend
  • struct: CameraInstanceId, CameraBackendIdentity, CameraMountReceipt, FrameMetadata, CaptureContract, StreamBudget, CameraDiagnostics, AdmittedFrame, CameraPipeline, CameraMountError, MountedCamera, WorkflowBudget, WorkflowUsage, WorkflowAccountant
  • enum: PixelFormat, CameraState, CameraError, WorkflowError
  • fn: capture_at, reset_window, recover, backend, backend_mut, into_backend, mount, capture_at, reset_window, quiesce, recover, backend, into_backend, sampled_mean, admit, reset_window

nobro-classic

Familiar fixed-capacity RTOS primitives for small applications.

  • struct: Queue, Semaphore, Mutex, SoftwareTimer, EventFlags
  • enum: Ready
  • fn: send, send_to_front, receive, peek, messages_waiting, spaces_available, is_full, is_empty, give, take, count, take, give, holder, start, stop, tick, is_active, set, clear, get, wait_any, wait_all, select2

nobro-control

No-heap control primitives (f32, FPU-friendly).

  • struct: Pid, ComplementaryFilter, DiffDrive, Trajectory, SafetyEnvelope, Odometry, BalanceController
  • fn: new, reset, update, update, angle, to_wheels, to_body, new, duration, position, diff_drive_mix, new, heartbeat, guard, tripped, reset, update, new, effort

nobro-crypto

No-heap crypto primitives for NobroRTOS: AES-128 block encryption (FIPS-197) and a

  • struct: Aes128, PrngCrypto, CryptoError
  • fn: new, encrypt_block, new

nobro-database

Fixed-capacity structured data store for NobroRTOS (database-style operations,

  • trait: RecordCodec
  • struct: PersistentTable, Table
  • enum: DbError, PersistentDbError
  • fn: mount, load, save, into_flash, new, len, is_empty, insert, get, update, upsert, delete, iter, select, next_key, count, to_image, from_image

nobro-device

Extensible device-module framework for NobroRTOS.

  • struct: ProviderResourcePrice, ProviderWorkload, ProviderRuntimePrice, ProviderAdmissionPrice, ServoProfile, MotorProfile, SensorDescriptor, SensorRegistry, StepperProfile, LedStripProfile, RelayProfile, DisplayProfile, GpsProfile, RangerProfile, BoardModule, BoardRegistry
  • enum: ResourceDimension, WorkloadPacing, ActuatorKind, SensorKind, Bus, ColorOrder
  • fn: angle_to_pulse, speed_to_pulse, throttle_to_pulse, arm_pulse, identify, register, len, is_empty, find_kind, identify_at, angle_to_steps, rpm_to_sps, frame_bytes, drive_level, framebuffer_bytes, nmea_checksum, echo_us_to_mm, register, find, len, is_empty

nobro-hal

NobroRTOS hardware abstraction with portable traits and platform backends.

nobro-host

Host-side contract constants shared by scripts, tools, and documentation.

  • trait: HostReport
  • struct: HostContract, BootDiagnostic, ReportSlot, BootSummary, BootReports, BoardProfileReport, BoardPackageReport, ManifestReport, AdapterCompatibilityReport, AiModelReport, RosBridgeReport, AdmissionReport, RuntimeReport, EventLogReport, ModuleRuntimeReport, DegradeApplicationReport, HealthReport
  • enum: BootLayout, ReportStatus, BootStage
  • fn: diagnostic, slots, summary, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, finalize_diagnostic, diagnostic_checksum_matches, status, set_next_alarm_due_us, next_alarm_due_us, finalize_diagnostic, diagnostic_checksum_matches, status, latest_at_us, finalize_diagnostic, diagnostic_checksum_matches, status, latest_change_us, finalize_diagnostic, diagnostic_checksum_matches, status, set_applied_at_us, applied_at_us, finalize_diagnostic, diagnostic_checksum_matches, status, set_last_seen_us, last_seen_us, finalize_diagnostic, diagnostic_checksum_matches, status

nobro-imu

Canonical, allocation-free IMU domain contracts for NobroRTOS.

  • trait: ImuBackend
  • struct: ImuHealthReport, ImuSample, ImuCalibration, ImuFamily, ImuIdentity, ImuDiagnostics
  • enum: ImuEvent
  • fn: finalize_diagnostic, diagnostic_checksum_matches, magnitude3

nobro-kernel

NobroRTOS kernel: Sample envelope, error policy, and scheduling hooks.

nobro-ml

No-heap embedded ML / DSP primitives (f32, no sqrt - FPU-friendly, bounded).

  • struct: RunningStats, Ewma, Vote, GestureDetector, GruCell
  • enum: Gesture
  • fn: update, mean, variance, z_squared, is_anomaly, update, value, reject, complementary, kws_frame_log_energy_features, kws_log_energy_features, ensemble_vote, new, calibrate, update, quantize_i8, dequantize_i8, choose_scale, depthwise_conv3, fed_average, prune_magnitude, step, schedule_models, count_blobs, ab_route

nobro-net

No-heap networking primitives for multi-board NobroRTOS meshes.

  • struct: Route, RoutingTable, TimeSync, Aggregator, SeenSet, PrioQueue, LinkMonitor, MeshSnapshot, AppliedCommand, OtaReassembler, OtaImageAssembler, FleetOtaNode, FleetOtaPolicy, FleetOtaWave, FleetOtaOrchestrator, StoreForward, NetworkFormation
  • enum: LinkEvent, NodeReading, LinkError, OtaReassemblyError, OtaImageError, FleetOtaPhase, FleetOtaError
  • fn: update, integrate_from, next_hop, cost, len, is_empty, estimate, add, mean, observe, push, pop, len, is_empty, heard, tick, is_up, up_count, from_readings, seal, open, open_addressed, pack, unpack, synced_capture_local_us, path_latency_us, command, apply, rssi_best_next_hop, new, chunk_count, receive, is_complete, first_missing, progress_percent, new, receive, verify, first_missing, register, set_health, mark_installing, complete_node, complete_node_with_policy, stage_next_wave, stage_verified_wave, node, len, is_empty, healthy_percent, active_count, confirmed_count, store, deliver, pending_for, join, parent_of, reparent, depth

nobro-nn

Neural-network building blocks from scratch, scoped for MCUs (inference side).

  • trait: QuantizedDenseI8Backend
  • struct: DenseI8Receipt, DenseI8Quantization, ScalarQuantizedDenseI8, CmsisNnQuantizedDenseI8, LstmState
  • enum: DenseI8BackendId, DenseI8BackendError, DenseI8Fallback
  • fn: exp_approx, sqrt_approx, relu, leaky_relu, sigmoid, tanh_approx, softmax, argmax, dense, dense_int8, quantized_dense_i8_with_fallback, quantize_i8, sgd_update, log_approx, conv1d_valid, conv2d_valid, conv2d_valid_i8, avg_pool2d, rnn_step, step, attention

nobro-power

No-heap power management policy: pick a sleep mode from activity + a deadline,

  • trait: PowerPlatform, PowerParticipant
  • struct: PowerVetoMask, PowerLease, PowerLeaseTable, SystemOffWake, PowerTransition, PowerHookError, PowerPlatformChain, PowerManager, EnergyLedger, ExecutorPower, DutyScheduler
  • enum: PowerMode, PowerVetoReason, PowerLeaseKind, PowerLeaseError, WakeStyle, SystemOffWakeError
  • fn: acquire, release, owner, attach_participant, select, account_active, end_window, duty_milli, charge, energy_uj, total_uj, top, set_task_power, task_power_uw, account_task, acquire_lease, release_lease, set_system_off_wake, apply_idle, apply_idle_release, sampling_divisor, harvest_work_budget_uj, tick

nobro-sal

NobroRTOS service abstraction layer with portable capability traits.

  • trait: AdapterManifest, BusSal, StreamSal, RadioSal, ActuatorSal, SensorSal, ImuSal, TempSal, CryptoSal, RosBridgeSal, AiInferenceSal
  • struct: AdapterDescriptor, AdapterCompatibilityReport, AdapterSet, AdapterPreflight, RosTopicContract, RosServiceContract, RosActionContract, RosParameterContract, RosBridgeContract, RosBridgePreflight, RosBridgeContractReport, AiRuntimeState, AiRouteDecision, AiRoutePolicy, ModelRegistry, AiModelContract, AiModelContractReport, AiInferenceRequest, AiInferenceResult, AiInvocationLimits, AiInvocationPreflight
  • enum: AdapterSetError, RosBridgeTransport, AiBackendKind, AiRoutePreference, AiRouteTarget, AiRegistryError
  • fn: from_result, finalize_diagnostic, diagnostic_checksum_matches, add, add_manifest, validate_profile, compatibility_report, descriptor, copy_descriptors, total_budget, owned_capabilities, required_capabilities, len, is_empty, add, add_manifest, compatibility_report, descriptor, copy_descriptors, buffer_bytes, buffer_bytes, buffer_bytes, from_parts, preflight_ros_topic, preflight_ros_service, preflight_ros_action, preflight_ros_parameter, from_contract, finalize_diagnostic, diagnostic_checksum_matches, decide, register, resolve, len, is_empty, route, from_contract, from_contract_and_policy, finalize_diagnostic, diagnostic_checksum_matches, preflight_ai_invocation, default_action

nobro-secure

Security + data-integrity primitives.

  • struct: KeyStore, RollbackGuard, TamperSeal, AuditLog, ConfigStore, OtaAgent, BootImageManifest, BootVectorPolicy, VerifiedBootPlan, SecureBoot
  • enum: Slot, OtaError, BootVerdict, BootPlanError
  • fn: attest, verify_tag, provision, get, deprovision, accept, min_version, seal, intact, new, append, head, count, store, load, active, stage, boot_staged, confirm, revert, measure, sign, verify, commit, min_version, boot_plan

nobro-sensor

No-heap sensor utilities, transport-agnostic.

  • trait: AdcDmaBackend
  • struct: SensorHealth, Calibration, Decimator, AdcDmaConfig, AdcSample
  • enum: AdcDmaState, AdcDmaError
  • fn: update, is_stuck, out_of_range, observe, finalize, apply, bias, tick, tmr_vote

nobro-services

Optional, allocation-free application services.

  • trait: UsbHostBackend, DisplayBackend
  • struct: ServiceInstanceId, UsbHostCapabilities, UsbDevice, UsbHostMountReceipt, UsbTransferReceipt, UsbHostMountError, MountedUsbHost, DisplayCapabilities, DisplayMountReceipt, PresentReceipt, MountedDisplay, ParsedCommand, BoundedShell
  • enum: ServiceState, ServiceError, PixelFormat, DisplayBufferModel
  • fn: valid, into_backend, mount, enumerate, transfer, quiesce, recover, into_backend, frame_bytes, valid, mount, present, quiesce, recover, into_backend, arg, line, parse

nobro-servo

Allocation-free servo command contract.

  • trait: ServoBackend, PwmEngineBackend, PulseEngineBackend
  • struct: ServoCommand, ServoBounds, PwmConfig, PulseSymbol
  • enum: PulseState, PulseError

nobro-storage

Power-fail-safe, wear-leveled key-value flash store.

  • trait: Flash
  • struct: KvStore, BlobStore, FileSystemMountError, FileMetadata, FileCommitReceipt, AtomicFileSystem
  • enum: KvError, FileSystemError
  • fn: mount, read, replace, into_flash, into_flash, mount, write, remove, read, metadata, file_count, into_flash, mount, get, put, into_flash

nobro-tierc

libnobro.a - the prebuilt NobroRTOS runtime for Tier C (C developers, no Rust).

nobro-usb

Modular, mountable USB device stack for NobroRTOS.

  • trait: UsbStack
  • struct: UsbInstanceId, UsbConfig, UsbCapabilities, UsbServiceLimits, UsbMountReceipt, MountedUsb
  • enum: CdcState, UsbBackendError, UsbIoError, UsbIdentityPolicy, UsbAdvertisedIdentity, UsbMountError
  • fn: config_supported, state, power_veto, write_all, read_available, flush_pending, stage, disconnect_link, reconnect_link, try_mount_instance, try_mount, mount

nobro-wireless

Allocation-free wireless domain: bounded link contracts, admission, and helpers.

  • trait: WirelessBackend, WifiStack, BleStack, NativeNetworkStack, SpiIo, ByteIo
  • struct: LinkDescriptor, Packet, TxContract, LinkBudget, LinkDiagnostics, ManagedLink, StackInstanceId, StackIdentity, StackMountReceipt, StackMountError, WifiCredentials, WifiNetwork, MountedWifi, BleEvent, BleEventQueue, MountedBle, NetworkEndpoint, NetworkSocket, NetworkCapabilities, NetworkInstanceId, NetworkMountReceipt, NetworkIoReceipt, NetworkMountError, MountedNetwork, BleAdvBuilder, RfidReaderDescriptor, RfidUid, Mfrc522, Cc2530
  • enum: Protocol, LinkState, LinkError, StackFamily, StackState, StackError, BleEventKind, IpAddress, NetworkSocketKind, NetworkBufferModel, AdvKind, RfidError, MacFrameType
  • fn: copy_from, as_slice, send_at, recv, reset_window, recover, backend, backend_mut, into_backend, valid_for, into_backend, new, set_ssid, ssid, mount, mount_instance, state, scan, join, leave, quiesce, recover, backend, backend_mut, into_backend, set_payload, payload, push, pop, mount, mount_instance, state, advertise, stop_advertising, poll_event, respond_gatt, quiesce, recover, backend, backend_mut, into_backend, valid, into_backend, mount, open_socket, connect, resolve, send, receive, close_socket, quiesce, recover, into_backend, build, build_as, build_scan_response, from_slice, as_slice, into_inner, reader_descriptor, init, request_a, anticollision_level1, poll_uid, transceive, iso14443a_bcc, validate_anticollision, has_next_cascade, mac_frame_type, new, initialize, join, poll_frame