Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MauAbata authored Mar 27, 2024
1 parent 506fbef commit 0c65637
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ stimulation accordingly. The net result: automated edging and orgasm denial.
## Web UI

Edge-o-Matic 3000 devices support a WebSocket communication channel to be used on a web UI. The current Web UI can be accessed
at [nogasm-ui.maustec.io](http://nogasm-ui.maustec.io). The source code is at [github.com/maustec/nogasm-ui](https://github.com/maustec/nogasm-ui).
at [link.maustec.io](http://link.maustec.io).
For control outside your Local Area Network, please consider a port-forwarding software such as Ngrok. You will have to permit insecure content
for that domain within Chrome to be able to connect your device while the page is loaded over HTTPS. This cannot be done automatically for you.
A remote bridge for Maus-Link compatible devices is in development and should be released Q4 2024. This will allow internet control of genuine
Maus-Tec products.

## WebSocket API

Expand Down Expand Up @@ -84,41 +86,38 @@ and is automatically generated. Here is a quick summary of config variables:
|5-15|Turn off stimulation after amount of seconds - Normal orgasm|
|16-4095|Turn off stimulation after amount of seconds - Post orgasm Torture|

Post-Orgasm and clench detector modules are community contributed features. While we will do our best to provide support
for these, we kindly request that you ask questions related to this in Discord under Firmware Development and not
Customer Support. Thank you for your understanding.

## Hardware

Hardware builds for this project can be purchased from Maus-Tec Electronics, at [maustec.io/eom](https://maustec.io/eom).

Hardware development and assembly helps keep pizza in the freezer and a roof over the head of the maintainer.
Your support helps a small business grow into something neat, and ensures future devices like this can continue
to be produced.
to be produced. Genuine hardware purchases also ensure continued maintenance and support can be provided for the project.

The User Guide for the hardware can be downloaded at [doc/Edge-o-Matic_UserGuide.docx](doc/Edge-o-Matic_UserGuide.docx).

Information for emulating the hardware, including a breadboard-friendly pinout for the ESP32, will be available once again
following a rewrite of the hardware layer of this code to align with current production units and variances in part availability.
All production units shipped are compatible with the main code branch here on GitHub.

### That RJ45 Jack

**The RJ45 Jack IS NOT ETHERNET!** That is a balanced twisted pair extension of the I2C bus on the controller, and is available
as a convenience for future development, dongles, and accessories. It carries +5V and SDA+/-, SCL+/- signals. You must use an
I2C redriver IC or compatible module to interface with this. Additionaly, this is terminated at 100ohm assuming standard CAT5.
[We recommend SparkFun's BOB-14589](https://www.digikey.com/product-detail/en/sparkfun-electronics/BOB-14589/1568-1873-ND/9351349).

|Pin|Signal|
|---|---|
|1|`SCL-`|
|2|`SCL+`|
|3|NC|
|4|`+5V`|
|5|`GND`|
|6|NC|
|7|`SDA-`|
|8|`SDA+`|
**The RJ45 Jack IS NOT ETHERNET!** This is the Maus-Bus Accessory Port, used to connect various Maus-Bus compatible devices
to build up a network of accessories and dongles to customize your play experience. Please only connect authorized Maus-Bus
accessories to this port. Unauthorized or counterfeit devices can damage your Edge-o-Matic. Do not connect it to an ethernet
jack. This is not for internet.

# Contributions

Any changes to configuration values should be linted. Run `ruby bin/config_lint.rb` to check documentation, serializers
and structs for consistency.

Thanks for readin'!



---

Maus-Bus and Maus-Link are trademarks of Maus-Tec LLC. Edge-o-Matic is a registered trademark of Maus-Tec LLC. If you are
a 3rd party hardware manufacturer looking to certify your Maus-Bus connected device for use with the Edge-o-Matic, we
encourage you to contact [email protected] and our friendly customer support robot will be glad to assist!

0 comments on commit 0c65637

Please sign in to comment.