derhuerst/wifi-on-ice-position-stream

estimate speed if not reported in tunnels

Open

#2 opened on Feb 25, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1 fork)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

wifi-on-ice-portal-client's journey() now exposes a field distanceToPreviousStop in meters, which changes every few seconds. This could optionally be used to estimate the ICE speed if the speed field is null.

We should make sure that:

  • We only use the estimated speed when status() reports null.
  • The estimation doesn't poll journey() too frequently, because it causes quite a bit more traffic than just status().
  • If journeys() takes very long to respond, the estimation shouldn't use it.

Contributor guide

Research direction
Inspect the journey() function to understand how distanceToPreviousStop is provided. Then implement logic to estimate speed from changes in distance over time when status() reports null for speed. Ensure polling of journey() is not too frequent and that responses are timely to avoid stale data.
Tech stack
javascript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptunderstanding of asynchronous programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70