Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

De aller fleste dataemnene som ønskes overført i sanntid over MQTT, er hentet fra ITxPT sin emnestruktur. Enkelte emner er imidlertid Ruter-spesifikke. Dokumentasjon av API-et er beskrevet i eget versjonert dokument. 

API v. 2.23

Oppdrag og plandata

Plandata for rutesatte turer og vognløp 

...

Ved endt tur skal det – uten opphold – leveres rapporteringsdata som beskriver turen.

Dette inkluderer

...

Kunde identifikator

...

Bil/Løyvenummer

...

Start adresse

...

Start posisjon (lng/lat)

...

Stopp adresse

...

Stopp posisjon (lng/lat)

...

Turtype

...

Starttidspunkt

...

Sluttidspunkt

...

Ventetid

...

Turdistanse

...

Pris

...

Kunde kost

...

Nødvendige datafelter er beskrevet i beskrivelsen av grensesnittet.

https://ruter.atlassian.net/l/c/W96Rw2fE

...

Producer: Vehicle

Definisjoner

Begrep

Kontekst

Betydning

Kjøreoppdrag (Block)

Rutesatt transport 

Bestillingstransport: heltidsinnleid

Et vognløp kan bestå av et eller flere kjøreoppdrag hvor kjøreoppdrag er en sammenhengende periode i tjeneste for Ruter som kan inneholde både tomkjøringer og avganger uten pauser imellom. Et typisk kjøreoppdrag strekker seg fra utkjøring fra depot til retur til depot/garasje men andre varianter kan finnes. 

 

Kjøreoppdrag

 

Bestillingstransport: timesinnleid            

For kjøretøy uten fast innleietid regnes hver enkelt tur som et oppdrag

Avgang

Rutesatt transport

Bestillingstransport: heltidsinnleid

Enkeltoppdrag innenfor kjøreoppdrag

Avgang:

Bestillingstransport: timesinnleid

Se Kjøreoppdrag

Ytelsesnivåer

Tjenestemottakers transporttjenestekontrakter kan inneholde økonomiske insentiver som helt eller delvis kan basere seg på ytelsene definert i denne avtalen. Det er definert tre ytelsesnivåer som kan benyttes til å regulere insentiver.

 

Absolutt

Dataemner som ved bortfall gjør det umulig å benytte andre dataemner og dermed fører til bortfall av digital kundeopplevelse.

Kritisk

Dataemner som ved bortfall forringer digital kundeopplevelse sterkt, samt Ruters mulighet til å følge opp produksjonen

Normal

Dataemner som ved bortfall forringer digital kundeopplevelse uten at det går ut over Ruters mulighet til å følge opp produksjonen.

Alle ytelsesnivåene måles pr avgang. Hvis en avgang etterfølger en tomkjøring i sitt kjøreoppdrag (block), inngår tomkjøringen i kravet til ytelsesnivå for avgangen. Altså stilles samme ytelseskrav til tomkjøringer som til ruteavganger.

Kategori

Ytelsesnivå

Dataemne

Krav

Terskel for at avgangen skal merkes med
SLA-brudd

DI

Absolutt

Pålogging og avlogging av kjøretøy

Pålogging og avlogging av kjøretøy er en svært kritisk funksjon som binder alle dataemner som  produseres av et kjøretøy til Tjenestemottakers digitale kundetjenester samt er det som muliggjør utnyttelse av de samme dataemnene til utarbeidelse av statistikk og innsikt.

/di/assignment_attempt/block/oi/current_vehicle_journey/state

/di/assignment_attempt_rejection/block

Gyldig pålogging skal være mottatt:

  • Før kjøretøyet starter et Kjøreoppdrag (block) men tidligst 30 minutter før planlagt start. Normalt ved utkjøring fra depot.

  • Så snart et kjøretøy skal overta for et annet på samme vognløp.

  • Ved avkortning av vognløp så snart et kjøretøy foretar avkortningen.

Gyldig avlogging skal være mottatt:

  • Senest 15 min. etter at kjøreoppdrag (block) er slutt. Normalt når kjøretøyet ikke skal kjøre flere turer og returnerer til depot.

  • Så snart et vognløp avbrytes før det er ferdigstilt. Gjelder også hvis et annet kjøretøy skal overta.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Kritisk

Posisjon

Posisjon brukes av Tjenestemottaker til å generere fremdrifts-status på turer og vognløp. Denne fremdrifts-statusen brukes til å gi kunder sanntidsinformasjon om avganger, ankomster, forsinkelser og avvik. Fremdrifts-status er også viktig for å kunne utarbeide statistikk og innsikt om avviklingen av Tjenestemottakers tjenester.

/sensors/gnss/location

  • Maksimal frekvens på posisjons-meldinger er 1/sekund

  • Gjennomsnittlig intervall mellom posisjons-meldinger skal ikke overskride 2 sekunder i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av posisjons-meldinger skal ikke overskride 2 sekunder i løpet av en avgang.

  • Intervall mellom posisjons-meldinger som overstiger 10 sekunder regnes som et brudd i posisjons-strømmen. Det tillates 3 brudd i løpet av en avgang.

  • Informasjon om satellittdekning og vertikal nøyaktighet skal alltid sendes med posisjons meldinger. Presisjonen på posisjoner skal alltid være med høyeste mulige presisjon i henhold til de rådende forhold gitt av disse parameterne.

  • Ved mangel på dekning skal det fremdeles sendes meldinger i samme intervall men merket at det ikke er dekning eller eventuelt om det benyttes projeksjon (dead-reckoning) for å gi posisjon.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Kritisk

Odometer

Odometer brukes av Tjenestemottaker som en redundant løsning for posisjon der mottaksforholdene for posisjon er vanskelige eller satellittdekning ikke er tilgjengelig.

/sensors/odometer

Oppdateringsfrekvens og trigger oppgis i dataemne

/mi/provider_clients/<client_id>/provided_topics

  • Maksimal frekvens på odometer-meldinger er 1/sekund

  • Gjennomsnittlig intervall mellom odometer-meldinger skal ikke overskride 2 sekunder i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av odometer-meldinger skal ikke overskride 2 sekunder i løpet av en avgang.

  • Intervall mellom odometer-meldinger som overstiger 10 sekunder regnes som et brudd i datastrømmen. Det tillates 3 brudd i løpet av en avgang.

  • Odometer skal ikke nullstilles eller gjøre «roll-over» i løpet av et Kjøreoppdrag (Block).

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Kritisk

Passasjertelling (APC)

Passasjertelling brukes av Tjenestemottaker for å vite fyllingsgrad av avganger i sanntid for å kunne gi bedre informasjon til reisende samt å utarbeide trafikkstatistikk for Tjenestemottakers nettverk. Passasjertelling brukes også til å validere at dørsensorer fungerer.

/sensors/apc_sensors/<sensor-id>

  • APC-melding må sendes pr. dør til Oppdragsgiver etter at dørstatus for døren har blitt endret fra “åpen” til “lukket”, og må mottas maksimalt 30 sekunder etter endring av dørstatus. Det tillates inntil 1 manglende meldinger pr. avgang.

  • Det tillates et avvik mellom av og påstigende i løpet av en avgang på 5% etter formelen

    Image Modified
  • Kvalitetsavviket måles over hele vognløpet og blir likt for alle avganger i vognløpet hvis det er flere enn 500 påstigende eller avstigende. Hvis det er færre legges foregående vognløp til kjøretøyet, ett eller flere, til beregningen inntil antallet påstigende eller avstigende overstiger 1000.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Normal

Klokke

Klokkesignalet brukes for å synkronisere tidsfremvisning på enheter som brukes til publikumsinformasjon slik som DPI skjermer.

/sensors/clock

  • Gjennomsnittlig intervall mellom klokkemeldinger skal ikke overskride 1 minutt målt av DPI-diagnose modulen ombord i kjøretøyet/fartøyet i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Normal

Kabintemperatur

Kabin temperatur brukes for å kunne gjøre en faktabasert behandling av kundeklager samt å utarbeide statistikk for overvåkning av eventuelle andre krav til klima i kjøretøyet.

/sensors/telemetry/01000002

  • Maksimal frekvens på kabintemperaturmeldinger er 2/min

  • Gjennomsnittlig intervall mellom temperatur-meldinger skal ikke overskride 2 min i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av temperatur-meldinger skal ikke overskride 5 sekunder i løpet av en avgang.

  • Intervall mellom temperatur-meldinger som overstiger 10 minutter regnes som et brudd i datastrømmen.

  • Det tillates 2 brudd i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Normal

Utendørstemperatur

Utendørs temperatur brukes for å forbedre prognose på avgangstider og kalibrering/analyse av passasjertellinger.

/sensors/telemetry/01000009

  • Maksimal frekvens på utendørstemperatur er 2/min

  • Gjennomsnittlig intervall mellom temperatur-meldinger skal ikke overskride 2 min i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av temperatur-meldinger skal ikke overskride 5 sekunder i løpet av en avgang.

  • Intervall mellom temperatur-meldinger som overstiger 10 minutter regnes som et brudd i datastrømmen.

  • Det tillates 2 brudd i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors / PE

Normal

Dørstatus

Dørstatus brukes for å gi bedre sanntidsinformasjon, å styre trafikkprioritering samt å validere at passasjertellere fungerer.

/sensors/door

/pe/doors_individually

  • Dørstatus pr dør sendes umiddelbart ved åpning og lukking. Status skal sendes i en gitt sekvens.

  • Åpen status skal etterfølges av lukket status og lukket status skal etterfølges av åpen status.

  • Det tillates inntil 2 meldinger utenfor sekvens pr dør på kjøretøyet/fartøyet pr. avgang.

  • For alternative konfigurasjoner kan dørstatus indikere tilgjengelighet for om bord- og avstigning. F.eks. landgang på ferger.

  • Ved mottak av passasjertelling skal det være sendt en dørstatus for lukking for samme dør maksimalt 30 sekunder før. Det tillates inntil 1 manglende meldinger pr. avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

-

Stoppsignal

Stoppsignal brukes for å gi bedre passasjerinformasjon ombord samt å forbedre fremdrifts-status på turer og vognløp.

/sensors/stop_button

  • Stoppsignal sendes umiddelbart når reisende aktiverer dette hvis kjøretøyet/fartøyet har stoppsignal.

Kravet inngår ikke i ytelseskrav for incentiv ordninger men er omfattet av generelt krav til bruk av API.

Sensors

-

Vindusviskerstatus

Vindusviskerstatus brukes for å forbedre prognose på avgangstider og kalibrering/analyse av passasjertellinger.

/sensors/telemetry/01000007

  • Sendes ved hver tilstandsendring av vindusviskerfunksjon, ikke ved hver viskerbevegelse.

Kravet inngår ikke i ytelseskrav for incentiv ordninger men er omfattet av generelt krav til bruk av API.

Sensors

Normal

Akselerometer

Akselerometer brukes for å skape ny innsikt om generell kundekomfort, sikkerhet og veikvalitet.

/sensors/telemetry/01000008

  • Maksimal frekvens for akselerometer-meldinger er 1/minutt.

  • Gjennomsnittlig intervall mellom akselerometer-meldinger skal ikke overskride 2 minutter i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av akselerometer-meldinger skal ikke overskride 5 sekunder i løpet av en avgang.

  • Intervall mellom akselerometer-meldinger som overstiger 10 minutter regnes som et brudd i akselerometer -strømmen. Det tillates 2 brudd i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Normal

Energiforbruk (kWh)

Energiforbruk brukes til å samle miljø-innsikt om leveranse av rutetilbudet.

/sensors/telemetry/0100000A

  • Maksimal frekvens for energiforbruk-meldinger er 1/minutt

  • Gjennomsnittlig intervall mellom energiforbruk-meldinger skal ikke overskride 2 minutter i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av energiforbruk-meldinger skal ikke overskride 5 sekunder i løpet av en avgang.

  • Intervall mellom energiforbruk -meldinger som overstiger 10 minutter regnes som et brudd i energiforbruk -strømmen. Det tillates 2 brudd i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

Normal

Batterinivå (SOC, kun elbuss)

Batterinivå brukes for å samle operativ innsikt om bruk av el-busser i rutetilbudet.

/sensors/telemetry/01000005

  • Maksimal frekvens for energiforbruk-meldinger er 1/minutt

  • Gjennomsnittlig intervall mellom batterinivå-meldinger skal ikke overskride 2 minutter i løpet av en avgang.

  • Gjennomsnittlig forsinkelse ved mottak av batterinivå -meldinger skal ikke overskride 5 sekunder i løpet av en avgang.

  • Intervall mellom batterinivå -meldinger som overstiger 10 minutter regnes som et brudd i batterinivå-strømmen. Det tillates 2 brudd i løpet av en avgang.

Hvis et eller flere kriterier ikke er oppfylt.

Sensors

-

Ladestatus (kun elbuss)

Ladestatus brukes for å gi bedre sanntidsinformasjon samt å samle operativ innsikt om bruk av el-busser i rutetilbudet.

/sensors/telemetry/0001FF25 inkludert subid 10003, 10004 og 10005

  • Sendes ved hver tilstandsendring av ladning

Kravet inngår ikke i ytelseskrav for incentiv ordninger men er omfattet av generelt krav til bruk av API.

PE

Kritisk

Dynamisk passasjerinformasjon (DPI)

Fremvisning av korrekt informasjon til passasjerene om bord er viktig for Tjenestemottaker

Rådata

/pe/dpi/#

Diagnosedata

/pe/dpi_diag

DPI-diagnosemodulen om bord i kjøretøy/fartøy måler hvert minutt under en avgang at følgende krav er oppfylt:

  • Antall skjermer som rapporterer stemmer med antallet Operatøren har oppgitt for kjøretøyet.

  • Skjermene har seneste versjon av både DPI-applikasjonen og mediepakken

  • Reiseinformasjon vist på skjermene stemmer med reiseinformasjon publisert av Ruter til operatør

  • Skjermene er i stand til å lagre informasjon over tid, uavhengig av på-/avlogging

  • Skjermene er satt opp med riktig skjermtype ift. Oppløsningen

Når et av kravene ikke oppfylles på mer enn 2 minutter i løpet av en avgang regnes dette som et brudd.

Det tillates inntil 2 brudd på kriteriene pr. avgang.

PE

Absolutt

Salg av billetter

Salg av billetter er viktig for å gi inntektssikring for Tjenestemottaker
/pe/sales_diag

/pe/sales/#

RuterSalg-diagnosemodulen om bord i kjøretøy/fartøy måler hvert minutt under en avgang at følgende krav er oppfylt:

  • At sjåfør/operatør av billettsalget er pålogget

Når et av kravene ikke oppfylles på mer enn 2 minutter i løpet av en avgang regnes dette som et brudd.

Det tillates inntil 2 brudd på kriteriene pr. avgang.

-

Eksternt skilt

Fremvisning av korrekt informasjon til passasjerene om bord er viktig for Tjenestemottaker

Ekstern skilt-melding sendes umiddelbart når eksterne skilt endres uavhengig om det er grunnet fjernstyring eller manuell overstyring.

Kravet inngår ikke i ytelseskrav for incentiv ordninger men er omfattet av generelt krav til bruk av API.

PE

Absolutt

Oppdragsutveksling Konsentra Førerapp

Fører benytter førerapplikasjon i henhold til avtalt prosedyre.

Hvis et eller flere kriterier ikke er oppfylt.

PE

Absolutt

Oppdragsutveksling SUTI

Oppdragsbekreftelse gjelder overføring, oppdatering og avslutning av aktuelle oppdrag.

Tjenesteyter må bekrefte mottatt oppdrag gjennom SUTI-Grensesnittet 

Tjenesteyter melder tilbake tildelt bil (løyve) 

Kjøretøyet registrerer faktiske hente- og leveringstider, inkludert GPS posisjon. 

Hvis et eller flere kriterier ikke er oppfylt.

PE

Absolutt

Oppdragsrapportering Y2M

Tjenesteyter utveksler data i henhold til grensesnitt beskrevet for funksjonsnivå Y2M

Hvis et eller flere kriterier ikke er oppfylt.

 

Godkjenning av dataprodusenter

...