Skip to content

docs: add aw-watcher-network-rs #147

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/examples/writing-watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Reference client

Below is a example of a watcher with more in-depth comments. Mirrors the python example above.
This example will describe how to:

* create buckets
* send events by heartbeats
* insert events without heartbeats
Expand All @@ -69,5 +70,5 @@ This example will describe how to:

.. literalinclude:: client.rs

It is recommend to follow conventions and use the ``aw-watcher-<name>`` naming scheme for your watcher.
It is recommended to follow conventions and use the ``aw-watcher-<name>`` naming scheme for your watcher.
It is also recommended for watchers to accept a ``--testing`` flag and a ``--port <port>`` flag to allow users to specify the port to connect to.
1 change: 1 addition & 0 deletions src/watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Other watchers to collect all kinds of data.
- :gh:`RTnhN/aw-watcher-toggl` - A Watcher to import time entries from Toggl.
- :gh:`sameersismail/aw-watcher-netstatus` - Monitors if you're connected to a network, by :gh-user:`sameersismail`.
- :gh:`RTnhN/aw-watcher-buttons` - (WIP) A watcher for tracking external hardware buttons based on an Arduino used for working state.
- :gh:`Oxbrayo/aw-watcher-network-rs` - A watcher for tracking network activity and wifi SSIDs, connected and broadcasting by :gh-user:`Oxbrayo`

Importers
---------
Expand Down