https://github.com/jkamsker/xsense-extractor
Tool to retreive sensor data from X-Sense
https://github.com/jkamsker/xsense-extractor
cli home-assistant home-automation sensor x-sense xsense
Last synced: 7 months ago
JSON representation
Tool to retreive sensor data from X-Sense
- Host: GitHub
- URL: https://github.com/jkamsker/xsense-extractor
- Owner: JKamsker
- License: mit
- Created: 2024-03-21T22:06:37.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T08:09:11.000Z (about 2 years ago)
- Last Synced: 2025-03-05T14:48:03.842Z (over 1 year ago)
- Topics: cli, home-assistant, home-automation, sensor, x-sense, xsense
- Language: C#
- Homepage:
- Size: 76.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# XSenseExtractor
`XSenseExtractor` is a .NET Tool to extract data from [XSense](https://de.x-sense.com/products/x-sense-wlan-hygrometer-thermometer-innen-1er-pack-erfordert-basisstation-sbs50) sensors.
It provides a command-line interface to interact with XSense, allowing you to retrieve data from the sensors and display it in human and machine-readable formats.
## Installation and Usage
`XSenseExtractor` can be easily installed and updated as a .NET Global Tool, allowing you to run it from anywhere on your system. Below are the instructions for installation, updating, and basic usage.
### Prerequisites
- .NET 8: Make sure you have the .NET 8 installed on your machine. You can download it from [the official .NET website](https://dot.net/download).
### Installing XSenseExtractor
To install `XSenseExtractor` as a global tool, open your terminal and run the following command:
```shell
dotnet tool install --global XSense-Extractor
```
This command will download and install the latest version of `XSenseExtractor`, making it globally available from the command line.
### Updating XSenseExtractor
If you already have `XSenseExtractor` installed and want to update it to the latest version, use the following command:
```shell
dotnet tool update XSense-Extractor -g
```
This will check for the latest version of the tool and update it accordingly.
## Usage
### Login
Authenticate a user with a username and password.
```shell
xsense login --username --password
```
### List Stations
Display all stations and their devices.
```shell
xsense stations
```
### Monitor Live Data
Monitor real-time data from a specific station.
```shell
xsense monitor --stationId [--houseId ]
```
### Retrieve Historical Data
Get historical data for a station or device within a date range.
```shell
xsense history --stationId [--houseId ] [--deviceId ] --from --to
```
##
Made with ♥ in Austria 