Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssiyad/car-red-srv
https://github.com/ssiyad/car-red-srv
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ssiyad/car-red-srv
- Owner: ssiyad
- License: mit
- Created: 2022-07-11T11:53:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T06:10:23.000Z (over 1 year ago)
- Last Synced: 2023-03-03T11:29:03.587Z (over 1 year ago)
- Language: Python
- Size: 183 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Setup
```
git clone https://github.com/ssiyad/car-red-srv car-red-srv
cd car-red-srv
pipenv install
pipenv run flask run # or
pipenv run python app.py # or
pipenv shell # then
python app.py
```
## Config
An example `.env.example` file is provided. Edit it according to your needs and save as 'env'.
This will be automatically loaded
## Endpoints
- `GET /devices/:device_id`
An API that takes device ID and returns device’s latest information in response
#### Example Response
```
{
"device_fk_id": 6888,
"latitude": 19.7290096282959,
"longitude": 76.20492553710938,
"speed": 0.0,
"sts": "2021-10-23T13:14:04.365831+00:00",
"time_stamp": "2021-10-23T04:55:53+00:00"
}
```
- `GET /devices/:device_id/movement`
An API that takes device ID and returns start location & end location for that device
#### Example Response
```
{
"end": {
"location": "(19.73518943786621, 76.18452453613281)",
"sts": "2021-10-23T13:28:05.626486+00:00",
"time_stamp": "2021-10-23T13:28:00+00:00"
},
"start": {
"location": "(19.7290096282959, 76.20492553710938)",
"sts": "2021-10-23T13:14:04.365831+00:00",
"time_stamp": "2021-10-23T04:55:53+00:00"
}
}
```
- `GET /devices/:device_id/locations`
An API that takes in device ID, start time & end time and returns all the location points
#### Query Params
```
start_date date after which entries should start # any common date format eg: 2022-07-13 19:50:12.527840
end_date date before which entries should end # any common date format eg: 2022-07-13 19:50:12.527840
```
#### Example Response
```
{
"data": [
{
"device_fk_id": 6888,
"latitude": 19.729045867919922,
"longitude": 76.2049331665039,
"speed": 4.0,
"sts": "2021-10-23T13:14:04.368900+00:00",
"time_stamp": "2021-10-23T04:55:55+00:00"
},
{
"device_fk_id": 6888,
"latitude": 19.729093551635742,
"longitude": 76.20492553710938,
"speed": 6.0,
"sts": "2021-10-23T13:12:55.558647+00:00",
"time_stamp": "2021-10-23T04:55:57+00:00"
}
],
"size": 2
}
```