Open
Conversation
…rement_type_id on streams Introduces three migrations for the AirBeamMini2 endpoint integration: - `devices` table (mac_address, model, optional name) with unique index on mac_address - `device_id` foreign key on `sessions` (nullable) to link sessions to the sending device - `measurement_type_id` integer on `streams` with a partial unique index per session, enabling compact numeric stream identification in the AirBeamMini2 binary protocol
- Add Device model (mac_address, model, optional name) with presence/uniqueness validations - Add optional device association to Session (belongs_to :device, optional: true) - Add AirBeamMini2 entries to Sensor::CANONICAL_SENSOR_NAME_MAP - Add five new Sensor constants for canonical stream metadata: CANONICAL_MEASUREMENT_TYPE_IDS, CANONICAL_UNIT_SYMBOLS, CANONICAL_MEASUREMENT_TYPES, CANONICAL_UNIT_NAMES, CANONICAL_MEASUREMENT_SHORT_TYPES - Seed AirBeam Source record (idempotent find_or_create_by!) - Add Device factory, device and sensor model specs
…session creation
Adds the first of two new AirBeamMini2 endpoints that replace the legacy realtime session flow:
- Contract (Dry::Validation): validates uuid, title, lat/lng, airbeam info, and streams array
- Creator service: resolves timezone from coordinates, creates Device (find-or-create), creates
FixedSession with legacy Stream records and assigns measurement_type_id per stream ordinal
- Controller with token + Devise auth; renders {location, streams} JSON including measurement_type_id
- Nested routes under namespace :v3
The mobile app calls this endpoint to register a new session before configuring the AirBeam.
The response's measurement_type_id values are passed to the AirBeam to identify stream types
in the subsequent binary measurement uploads.
…ingestion endpoint
Adds the AirBeamMini2 binary measurement upload endpoint:
Binary format (little-endian):
[4B] magic "ABBA" | [2B] uint16 count | N×[4B uint32 epoch + 1B type_id + 4B float32 value] | [1B] XOR checksum
- BinaryParser: validates magic, measurement count, payload size, and XOR checksum;
returns parsed array of {epoch, measurement_type_id, value} hashes
- Ingester: resolves streams by measurement_type_id, converts UTC epoch to local wall-clock
time (compatible with legacy daily-averages SQL), bulk-upserts FixedMeasurements with
on_duplicate_key_update for resync support, updates session timestamps,
optionally triggers daily/hourly averages recalculation on sync uploads
- Controller reads raw request body (application/octet-stream), delegates to Ingester
Adds a reference table of all API endpoints used by iOS and Android mobile apps, covering fixed session management, mobile session upload, sync, threshold alerts, and account management. Replaces the outdated endpoint list previously only in doc/api.md.
Big-endian is preferred for public network protocols (network byte order). Update unpack strings in BinaryParser (a4v→a4n for header, VCe→NCg per measurement) and all test build_binary helpers to match.
- Add rswag-api, rswag-ui (always loaded) and rswag-specs (test group) to Gemfile - Mount Rswag::Api::Engine at /api-docs (serves swagger.yaml in all envs) - Mount Rswag::Ui::Engine at /api-docs only in non-production (interactive UI) - Add swagger_helper.rb and spec/swagger/v3/fixed_sessions_spec.rb documenting both AirBeamMini2 endpoints including the binary format description - Commit generated swagger/v3/swagger.yaml (regenerate with: RAILS_ENV=test PATTERN="spec/swagger/**/*_spec.rb" bundle exec rake rswag:specs:swaggerize)
hanka
force-pushed
the
feat/AirBeamMini2-fixed-session
branch
from
3f374c1 to
f3b64a2
Compare
Split the index creation out of the add_device_id migration into a dedicated migration with disable_ddl_transaction! + algorithm: :concurrently. On a large sessions table, a non-concurrent index build holds a ShareLock (blocking writes) for the full duration of the table scan. The concurrent build avoids this — it runs in the background without blocking reads or writes, at the cost of two table scans instead of one. The column add and FK constraint remain in the original migration (both are safe: ADD COLUMN is instant for nullable columns in PG 11+, and ADD FOREIGN KEY skips validation for existing NULL values).
Replaced run_test! with skip examples. The SwaggerFormatter processes example-group metadata (not individual examples), so YAML generation via the rake task is unaffected. Direct 'rspec spec/swagger/' runs now report 7 pending instead of 7 failures.
…ntract Follows the pattern of Api::MobileSessionsContract and Api::FixedSessionsContract: contract validation happens at the controller level, and the service receives pre-validated data. Naming convention: verb-prefix (Create) distinguishes it from the existing query contract Api::FixedSessionsContract (GET params). - Add app/models/api/create_fixed_session_contract.rb - Update controller to call contract before invoking Creator - Remove internal contract call from Creator (no longer its responsibility) - Delete AirBeamMini2::FixedSessions::Contract and its spec - Add spec/models/api/create_fixed_session_contract_spec.rb
- FixedSessions::Creator — shared session creation, no device-specific logic - FixedSessions::AirBeamMini2::BinaryParser — binary protocol parsing (Mini2-specific) - FixedSessions::AirBeamMini2::Ingester — binary measurement ingestion (Mini2-specific) The FixedSessions top-level namespace will grow to serve all AirBeam models using the new v3 endpoint. The AirBeamMini2 sub-namespace scopes the binary protocol services without polluting the shared layer. Use ::FixedSessions in controllers to avoid constant lookup collision with the Api::V3::FixedSessions controller namespace.
hanka
force-pushed
the
feat/AirBeamMini2-fixed-session
branch
from
d91322b to
abcb13e
Compare
hanka
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
2 new API endpoints to support new AirBeam software: