Skip to content

Commit 8af638b

Browse files
JulianWowraJulianWowra
committed
docs: better overview of the library functions
1 parent 85bd3a7 commit 8af638b

File tree

1 file changed

+62
-86
lines changed

1 file changed

+62
-86
lines changed

‎README.md‎

Lines changed: 62 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Based on API version: `v11.3.0`
66

77
## Install
88

9-
```
9+
```bash
1010
npm install opensensemap-client
1111
```
1212

13-
```
13+
```bash
1414
pnpm install opensensemap-client
1515
```
1616

17-
```
17+
```bash
1818
yarn add opensensemap-client
1919
```
2020

@@ -50,89 +50,65 @@ start();
5050

5151
## Listed functions according to API documentation of openSenseMap
5252

53-
- **Introduction**
54-
- **Boxes**
55-
- [Get one senseBox](https://docs.opensensemap.org/#api-Boxes-getBox)
56-
- _Function:_ [`getBox()`](https://julianwowra.github.io/opensensemap-client/functions/getBox.html)
57-
- [Get all senseBoxes](https://docs.opensensemap.org/#api-Boxes-getBoxes)
58-
- _Function:_ [`getBoxes()`](https://julianwowra.github.io/opensensemap-client/functions/getBoxes.html)
59-
- [Post new senseBox](https://docs.opensensemap.org/#api-Boxes-postNewBox)
60-
- _Function:_ [`postNewBox()`](https://julianwowra.github.io/opensensemap-client/functions/postNewBox.html)
61-
- [Update a senseBox](https://docs.opensensemap.org/#api-Boxes-updateBox)
62-
- _Function:_ [`updateBox()`](https://julianwowra.github.io/opensensemap-client/functions/updateBox.html)
63-
- [Mark a senseBox and its measurements for deletion](https://docs.opensensemap.org/#api-Boxes-deleteBox)
64-
- _Function:_ [`deleteBox()`](https://julianwowra.github.io/opensensemap-client/functions/deleteBox.html)
65-
- [Get all senseBox tags](https://docs.opensensemap.org/#api-Boxes-getAllTags)
66-
- _Function:_ [`getAllTags()`](https://julianwowra.github.io/opensensemap-client/functions/getAllTags.html)
67-
- [Claim a senseBox marked for transfer](https://docs.opensensemap.org/#api-Boxes-claimBox)
68-
- _Function:_ [`claimBox()`](https://julianwowra.github.io/opensensemap-client/functions/claimBox.html)
69-
- [Download the Arduino script for your senseBox](https://docs.opensensemap.org/#api-Boxes-getSketch)
70-
- _Function:_ [`getSketch()`](https://julianwowra.github.io/opensensemap-client/functions/getSketch.html)
71-
- [Get locations of a senseBox](https://docs.opensensemap.org/#api-Boxes-getBoxLocations)
72-
- _Function:_ [`getBoxLocations()`](https://julianwowra.github.io/opensensemap-client/functions/getBoxLocations.html)
73-
- [Get transfer information for a senseBox](https://docs.opensensemap.org/#api-Boxes-getTransfer)
74-
- _Function:_ [`getTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/getTransfer.html)
75-
- [Mark a senseBox for transferring to a different user](https://docs.opensensemap.org/#api-Boxes-createTransfer)
76-
- _Function:_ [`createTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/createTransfer.html)
77-
- [Revoke transfer token and remove senseBox from transfer](https://docs.opensensemap.org/#api-Boxes-removeTransfer)
78-
- _Function:_ [`removeTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/removeTransfer.html)
79-
- [Update a transfer token](https://docs.opensensemap.org/#api-Boxes-updateTransfer)
80-
- _Function:_ [`updateTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/updateTransfer.html)
81-
- **Interpolation**
82-
- [Get a Inverse Distance Weighting Interpolation as FeatureCollection](https://docs.opensensemap.org/#api-Interpolation-calculateIdw)
83-
- _Function:_ [`calculateIdw()`](https://julianwowra.github.io/opensensemap-client/functions/calculateIdw.html)
84-
- **Measurements**
85-
- [Post new measurement](https://docs.opensensemap.org/#api-Measurements-postNewMeasurement)
86-
- _Function:_ [`postNewMeasurement()`](https://julianwowra.github.io/opensensemap-client/functions/postNewMeasurement.html)
87-
- [Get the 10000 latest measurements for a sensor](https://docs.opensensemap.org/#api-Measurements-getData)
88-
- _Function:_ [`getData()`](https://julianwowra.github.io/opensensemap-client/functions/getData.html)
89-
- [Delete measurements of a sensor](https://docs.opensensemap.org/#api-Measurements-deleteMeasurements)
90-
- _Function:_ [`deleteMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/deleteMeasurements.html)
91-
- [Get latest measurements for a grouptag as JSON](https://docs.opensensemap.org/#api-Measurements-getDataByGroupTag)
92-
- _Function:_ [`getDataByGroupTag()`](https://julianwowra.github.io/opensensemap-client/functions/getDataByGroupTag.html)
93-
- [Get latest measurements for a phenomenon as CSV](https://docs.opensensemap.org/#api-Measurements-getDataMulti)
94-
- _Function:_ [`getDataMulti()`](https://julianwowra.github.io/opensensemap-client/functions/getDataMulti.html)
95-
- [Get latest measurements of a senseBox](https://docs.opensensemap.org/#api-Measurements-getLatestMeasurements)
96-
- _Function:_ [`getLatestMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/getLatestMeasurements.html)
97-
- [Get latest measurements of a sensor](https://docs.opensensemap.org/#api-Measurements-getLatestMeasurementOfSensor)
98-
- _Function:_ [`getLatestMeasurementOfSensor()`](https://julianwowra.github.io/opensensemap-client/functions/getLatestMeasurementOfSensor.html)
99-
- [Post multiple new measurements](https://docs.opensensemap.org/#api-Measurements-postNewMeasurements)
100-
- _Function:_ [`postNewMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/postNewMeasurements.html)
101-
- **Misc**
102-
- [Get some statistics about the database](https://docs.opensensemap.org/#api-Misc-getStatistics)
103-
- _Function:_ [`getStatistics()`](https://julianwowra.github.io/opensensemap-client/functions/getStatistics.html)
104-
- [print all routes](https://docs.opensensemap.org/#api-Misc-printRoutes)
105-
- _Function:_ [`printRoutes()`](https://julianwowra.github.io/opensensemap-client/functions/printRoutes.html)
106-
- **Statistics**
107-
- [Compute basic descriptive statistics over specified time windows](https://docs.opensensemap.org/#api-Statistics-descriptive)
108-
- _Function:_ [`descriptive()`](https://julianwowra.github.io/opensensemap-client/functions/descriptive.html)
109-
- **Users**
110-
- [Register new](https://docs.opensensemap.org/#api-Users-register)
111-
- _Function:_ [`register()`](https://julianwowra.github.io/opensensemap-client/functions/register.html)
112-
- [Delete user, all of its boxes and all of its boxes measurements](https://docs.opensensemap.org/#api-Users-deleteUser)
113-
- _Function:_ [`deleteUser()`](https://julianwowra.github.io/opensensemap-client/functions/deleteUser.html)
114-
- [Get details](https://docs.opensensemap.org/#api-Users-getUser)
115-
- _Function:_ [`getUser()`](https://julianwowra.github.io/opensensemap-client/functions/getUser.html)
116-
- [Refresh Authorization](https://docs.opensensemap.org/#api-Users-refresh_auth)
117-
- _Function:_ [`refreshAuth()`](https://julianwowra.github.io/opensensemap-client/functions/refreshAuth.html)
118-
- [Sign in](https://docs.opensensemap.org/#api-Users-sign_in)
119-
- _Function:_ [`signIn()`](https://julianwowra.github.io/opensensemap-client/functions/signIn.html)
120-
- [Sign out](https://docs.opensensemap.org/#api-Users-sign_out)
121-
- _Function:_ [`signOut()`](https://julianwowra.github.io/opensensemap-client/functions/signOut.html)
122-
- [Update user details](https://docs.opensensemap.org/#api-Users-updateUser)
123-
- _Function:_ [`updateUser()`](https://julianwowra.github.io/opensensemap-client/functions/updateUser.html)
124-
- [confirm email address](https://docs.opensensemap.org/#api-Users-confirm_email)
125-
- _Function:_ [`confirmEmail()`](https://julianwowra.github.io/opensensemap-client/functions/confirmEmail.html)
126-
- [get specific box of the signed in user](https://docs.opensensemap.org/#api-Users-getUserBox)
127-
- _Function:_ [`getUserBox()`](https://julianwowra.github.io/opensensemap-client/functions/getUserBox.html)
128-
- [list all boxes and sharedBoxes of the signed in user](https://docs.opensensemap.org/#api-Users-getUserBoxes)
129-
- _Function:_ [`getUserBoxes()`](https://julianwowra.github.io/opensensemap-client/functions/getUserBoxes.html)
130-
- [request a resend of the email confirmation](https://docs.opensensemap.org/#api-Users-resend_email_confirmation)
131-
- _Function:_ [`resendEmailConfirmation()`](https://julianwowra.github.io/opensensemap-client/functions/resendEmailConfirmation.html)
132-
- [request password reset](https://docs.opensensemap.org/#api-Users-request_password_reset)
133-
- _Function:_ [`requestPasswordReset()`](https://julianwowra.github.io/opensensemap-client/functions/requestPasswordReset.html)
134-
- [reset password with passwordResetToken](https://docs.opensensemap.org/#api-Users-password_reset)
135-
- _Function:_ [`passwordReset()`](https://julianwowra.github.io/opensensemap-client/functions/passwordReset.html)
53+
## API Functions Reference
54+
55+
### Boxes
56+
57+
| Function | Description | OpenSenseMap API Documentation |
58+
| ------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------- |
59+
| [`getBox()`](https://julianwowra.github.io/opensensemap-client/functions/getBox.html) | Get one senseBox | [API Doc](https://docs.opensensemap.org/#api-Boxes-getBox) |
60+
| [`getBoxes()`](https://julianwowra.github.io/opensensemap-client/functions/getBoxes.html) | Get all senseBoxes | [API Doc](https://docs.opensensemap.org/#api-Boxes-getBoxes) |
61+
| [`postNewBox()`](https://julianwowra.github.io/opensensemap-client/functions/postNewBox.html) | Post new senseBox | [API Doc](https://docs.opensensemap.org/#api-Boxes-postNewBox) |
62+
| [`updateBox()`](https://julianwowra.github.io/opensensemap-client/functions/updateBox.html) | Update a senseBox | [API Doc](https://docs.opensensemap.org/#api-Boxes-updateBox) |
63+
| [`deleteBox()`](https://julianwowra.github.io/opensensemap-client/functions/deleteBox.html) | Mark a senseBox for deletion | [API Doc](https://docs.opensensemap.org/#api-Boxes-deleteBox) |
64+
| [`getAllTags()`](https://julianwowra.github.io/opensensemap-client/functions/getAllTags.html) | Get all senseBox tags | [API Doc](https://docs.opensensemap.org/#api-Boxes-getAllTags) |
65+
| [`claimBox()`](https://julianwowra.github.io/opensensemap-client/functions/claimBox.html) | Claim a senseBox marked for transfer | [API Doc](https://docs.opensensemap.org/#api-Boxes-claimBox) |
66+
| [`getSketch()`](https://julianwowra.github.io/opensensemap-client/functions/getSketch.html) | Download the Arduino script | [API Doc](https://docs.opensensemap.org/#api-Boxes-getSketch) |
67+
| [`getBoxLocations()`](https://julianwowra.github.io/opensensemap-client/functions/getBoxLocations.html) | Get locations of a senseBox | [API Doc](https://docs.opensensemap.org/#api-Boxes-getBoxLocations) |
68+
| [`getTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/getTransfer.html) | Get transfer information | [API Doc](https://docs.opensensemap.org/#api-Boxes-getTransfer) |
69+
| [`createTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/createTransfer.html) | Mark a senseBox for transfer | [API Doc](https://docs.opensensemap.org/#api-Boxes-createTransfer) |
70+
| [`removeTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/removeTransfer.html) | Revoke transfer token | [API Doc](https://docs.opensensemap.org/#api-Boxes-removeTransfer) |
71+
| [`updateTransfer()`](https://julianwowra.github.io/opensensemap-client/functions/updateTransfer.html) | Update a transfer token | [API Doc](https://docs.opensensemap.org/#api-Boxes-updateTransfer) |
72+
73+
### Measurements
74+
75+
| Function | Description | OpenSenseMap API Documentation |
76+
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------- |
77+
| [`postNewMeasurement()`](https://julianwowra.github.io/opensensemap-client/functions/postNewMeasurement.html) | Post new measurement | [API Doc](https://docs.opensensemap.org/#api-Measurements-postNewMeasurement) |
78+
| [`getData()`](https://julianwowra.github.io/opensensemap-client/functions/getData.html) | Get latest measurements for a sensor | [API Doc](https://docs.opensensemap.org/#api-Measurements-getData) |
79+
| [`deleteMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/deleteMeasurements.html) | Delete measurements of a sensor | [API Doc](https://docs.opensensemap.org/#api-Measurements-deleteMeasurements) |
80+
| [`getDataByGroupTag()`](https://julianwowra.github.io/opensensemap-client/functions/getDataByGroupTag.html) | Get measurements for a grouptag | [API Doc](https://docs.opensensemap.org/#api-Measurements-getDataByGroupTag) |
81+
| [`getDataMulti()`](https://julianwowra.github.io/opensensemap-client/functions/getDataMulti.html) | Get measurements for a phenomenon | [API Doc](https://docs.opensensemap.org/#api-Measurements-getDataMulti) |
82+
| [`getLatestMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/getLatestMeasurements.html) | Get latest measurements of a senseBox | [API Doc](https://docs.opensensemap.org/#api-Measurements-getLatestMeasurements) |
83+
| [`getLatestMeasurementOfSensor()`](https://julianwowra.github.io/opensensemap-client/functions/getLatestMeasurementOfSensor.html) | Get latest measurements of a sensor | [API Doc](https://docs.opensensemap.org/#api-Measurements-getLatestMeasurementOfSensor) |
84+
| [`postNewMeasurements()`](https://julianwowra.github.io/opensensemap-client/functions/postNewMeasurements.html) | Post multiple new measurements | [API Doc](https://docs.opensensemap.org/#api-Measurements-postNewMeasurements) |
85+
86+
### Users
87+
88+
| Function | Description | OpenSenseMap API Documentation |
89+
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------- |
90+
| [`register()`](https://julianwowra.github.io/opensensemap-client/functions/register.html) | Register new user | [API Doc](https://docs.opensensemap.org/#api-Users-register) |
91+
| [`deleteUser()`](https://julianwowra.github.io/opensensemap-client/functions/deleteUser.html) | Delete user and all boxes | [API Doc](https://docs.opensensemap.org/#api-Users-deleteUser) |
92+
| [`getUser()`](https://julianwowra.github.io/opensensemap-client/functions/getUser.html) | Get user details | [API Doc](https://docs.opensensemap.org/#api-Users-getUser) |
93+
| [`refreshAuth()`](https://julianwowra.github.io/opensensemap-client/functions/refreshAuth.html) | Refresh Authorization | [API Doc](https://docs.opensensemap.org/#api-Users-refresh_auth) |
94+
| [`signIn()`](https://julianwowra.github.io/opensensemap-client/functions/signIn.html) | Sign in | [API Doc](https://docs.opensensemap.org/#api-Users-sign_in) |
95+
| [`signOut()`](https://julianwowra.github.io/opensensemap-client/functions/signOut.html) | Sign out | [API Doc](https://docs.opensensemap.org/#api-Users-sign_out) |
96+
| [`updateUser()`](https://julianwowra.github.io/opensensemap-client/functions/updateUser.html) | Update user details | [API Doc](https://docs.opensensemap.org/#api-Users-updateUser) |
97+
| [`confirmEmail()`](https://julianwowra.github.io/opensensemap-client/functions/confirmEmail.html) | Confirm email address | [API Doc](https://docs.opensensemap.org/#api-Users-confirm_email) |
98+
| [`getUserBox()`](https://julianwowra.github.io/opensensemap-client/functions/getUserBox.html) | Get specific box of user | [API Doc](https://docs.opensensemap.org/#api-Users-getUserBox) |
99+
| [`getUserBoxes()`](https://julianwowra.github.io/opensensemap-client/functions/getUserBoxes.html) | List all boxes of user | [API Doc](https://docs.opensensemap.org/#api-Users-getUserBoxes) |
100+
| [`resendEmailConfirmation()`](https://julianwowra.github.io/opensensemap-client/functions/resendEmailConfirmation.html) | Resend email confirmation | [API Doc](https://docs.opensensemap.org/#api-Users-resend_email_confirmation) |
101+
| [`requestPasswordReset()`](https://julianwowra.github.io/opensensemap-client/functions/requestPasswordReset.html) | Request password reset | [API Doc](https://docs.opensensemap.org/#api-Users-request_password_reset) |
102+
| [`passwordReset()`](https://julianwowra.github.io/opensensemap-client/functions/passwordReset.html) | Reset password | [API Doc](https://docs.opensensemap.org/#api-Users-password_reset) |
103+
104+
### Other Functions
105+
106+
| Function | Description | OpenSenseMap API Documentation |
107+
| --------------------------------------------------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------ |
108+
| [`calculateIdw()`](https://julianwowra.github.io/opensensemap-client/functions/calculateIdw.html) | Get IDW Interpolation | [API Doc](https://docs.opensensemap.org/#api-Interpolation-calculateIdw) |
109+
| [`getStatistics()`](https://julianwowra.github.io/opensensemap-client/functions/getStatistics.html) | Get database statistics | [API Doc](https://docs.opensensemap.org/#api-Misc-getStatistics) |
110+
| [`printRoutes()`](https://julianwowra.github.io/opensensemap-client/functions/printRoutes.html) | Print all routes | [API Doc](https://docs.opensensemap.org/#api-Misc-printRoutes) |
111+
| [`descriptive()`](https://julianwowra.github.io/opensensemap-client/functions/descriptive.html) | Compute descriptive statistics | [API Doc](https://docs.opensensemap.org/#api-Statistics-descriptive) |
136112

137113
You can find more information in the [full documentation 📖](https://julianwowra.github.io/opensensemap-client/).
138114

0 commit comments

Comments
 (0)