Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create objects only if necessary #9

Closed
wants to merge 16 commits into from
Closed
60 changes: 38 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
![Logo](admin/tractive-gps.png)

# ioBroker.tractive-gps

[![NPM version](https://img.shields.io/npm/v/iobroker.tractive-gps.svg)](https://www.npmjs.com/package/iobroker.tractive-gps)
Expand All @@ -17,43 +18,51 @@ Affiliation or endorsement by them or associated affiliates! This personal proje
Has no business objectives. **[Tractive](https://tractive.com/de/)** is a trademark of **Tractive GmbH**.

### Sentry

**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.**\
For more details and for information on how to disable error reporting, see.
[Sentry Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reports are used starting with js-controller 3.0
are used.

### Description

This adapter allows you to connect to the Tractive GPS service and retrieve the location of your pets.\
The adapter creates a device for each pet and a status for each location.\
The adapter also creates a status for the tracker's battery level and many other statuses provided by the API.

### Prerequisites

To use this adapter, you must have a Tractive account and have a tracker for your pet (see
[Tractive](https://tractive.com/de/)) ( **Caution:** Monthly / Annual fee for using the Tractive service )

### Installation

The adapter is installed via the ioBroker adapter manager.\
**Caution:** The adapter requires at least Node.js >= 16 and js-controller 3.3.22 and admin >=6!
After installation you have to log in with your Tractive account and set the polling interval.\
The adapter will then fetch a token from the Tractive API and store it in the configuration. This token has an expiration time which will be renewed automatically
renewed automatically when it expires.

### Configuration

In the adapter configuration there are two setting options:
* **Login**.
1. here you can login with your Tractive account.\
2. set the polling interval.\
3. manually reissue the token.\

![instances-tractive-gps-login.png](admin%2Fimages%2Finstances-tractive-gps-login.png)
- **Login**.

* **All devices** - A list of all devices found by the adapter is displayed here. You can change the name of the device in the list.
this will then also be displayed in the objects.\
![instances-tractive-gps-allDevices-table.png](admin%2Fimages%2Finstances-tractive-gps-allDevices-table.png)
to change the name click on the pencil icon and enter the new name.
![instances-tractive-gps-allDevices-modal.png](admin%2Fimages%2Finstances-tractive-gps-allDevices-modal.png)
1. here you can login with your Tractive account.\
2. set the polling interval.\
3. manually reissue the token.\

![instances-tractive-gps-login.png](admin%2Fimages%2Finstances-tractive-gps-login.png)

- **All devices** - A list of all devices found by the adapter is displayed here. You can change the name of the device in the list.
this will then also be displayed in the objects.\
![instances-tractive-gps-allDevices-table.png](admin%2Fimages%2Finstances-tractive-gps-allDevices-table.png)
to change the name click on the pencil icon and enter the new name.
![instances-tractive-gps-allDevices-modal.png](admin%2Fimages%2Finstances-tractive-gps-allDevices-modal.png)

### Tab

In the Tab all found devices are displayed with a map and some information about the device.\
![tab-tractive-gps.png](admin%2Fimages%2Ftab-tractive-gps.png)
The image can also be replaced with the animal's own image.\
Expand All @@ -62,25 +71,32 @@ Or you can use the tab **files** to upload the file. (see image below)\
**The recommended size for the image is 1920x1080 pixels.**\
![files-tractive-gps.png](admin%2Fimages%2Ffiles-tractive-gps.png)




## Changelog

<!--
Placeholder for the next version (at the beginning of the line):
### **WORK IN PROGRESS**
-->
-->

### **WORK IN PROGRESS**
- (Scounger) bug fix: objects only if necessary
- (Scrounger) Calculate distance between ioBroker and tracker

### 0.1.2 (2023-02-24)
* (xXBJXx) Dependencies updated
* (xXBJXx) UI updated


- (xXBJXx) Dependencies updated
- (xXBJXx) UI updated

### 0.1.1 (2023-02-05)
* (xXBJXx) Dependencies updated


- (xXBJXx) Dependencies updated

### 0.1.0 (2023-02-05)
* (xXBJXx) first release


- (xXBJXx) first release

## License

MIT License

Copyright (c) 2023 xXBJXx <issi.dev.iobroker@gmail.com>
Expand All @@ -101,4 +117,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
174 changes: 88 additions & 86 deletions admin/build/index.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions admin/build/index.js.map

Large diffs are not rendered by default.

178 changes: 90 additions & 88 deletions admin/build/tab.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions admin/build/tab.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/lib/Helper.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 46 additions & 0 deletions build/lib/object_definition.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading