Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
roleoroleo committed Jan 12, 2024
1 parent 1bd1190 commit 651806b
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,24 @@ So please, make your backup copy: https://github.com/roleoroleo/yi-hack-Allwinne
Anyway, the hack procedure will create a backup for you.

### Install Procedure
If you want to use the original Yi app, please install it and complete the pairing process before installing the hack.

Otherwise, check setep 4.

1. Check if your cam is supported in the "Supported cameras" section and note the file prefix.
2. Format an SD Card as FAT32. It's recommended to format the card in the camera using the camera's native format function. If the card is already formatted, remove all the files.
3. Download the latest release from [the Releases page](https://github.com/roleoroleo/yi-hack-Allwinner/releases) based on the file prefix.
4. Extract the contents of the archive to the root of your SD card.
5. Insert the SD Card and reboot the camera.
6. Wait for the camera to update. It will reboot a couple of times as the camera is rooted and the new firmware is applied. It can take up to an hour to update. Once the light is solid blue for at least a minute it is complete.
```
|-- Factory/
|-- newhome/
|-- home_xxx.stage
```
5. (Optional) If you want to set wifi credentials, rename the file Factory/configure_wifi.cfg.ori to Factory/configure_wifi.cfg and edit the file with your username and password.
6. Insert the SD Card and reboot the camera.
7. Wait for the camera to update. It will reboot a couple of times as the camera is rooted and the new firmware is applied. It can take up to an hour to update. Once the light is solid blue for at least a minute it is complete.
8. Check the hack opening the web interface http://IP-CAM (where IP-CAM is the IP address of the cam assigned by your router).
9. Check the FAQ if you have a problem: https://github.com/roleoroleo/yi-hack-Allwinner/wiki/FAQ


### Online Update Procedure
Expand All @@ -54,8 +66,12 @@ Anyway, the hack procedure will create a backup for you.
If you don't delete mp4 files, the upgrade procedure will take a long time.


### Manual Update Procedure
Check the wiki: https://github.com/roleoroleo/yi-hack-Allwinner-v2/wiki/Manual-firmware-upgrade


### Optional Utilities
Several [optional untilies](https://github.com/roleoroleo/yi-hack-utils) are avaiable, some supporting experimental features like text-to-speech.
Several [optional utilities](https://github.com/roleoroleo/yi-hack-utils) are avaiable, some supporting experimental features like text-to-speech.


## Contributing and Bug Reports
Expand All @@ -71,12 +87,13 @@ This custom firmware contains features replicated from the [yi-hack-MStar](https
- rtsp://IP-CAM/ch0_0.h264 (high res)
- rtsp://IP-CAM/ch0_1.h264 (low res)
- rtsp://IP-CAM/ch0_2.h264 (only audio)
- ONVIF server (with support for h264 stream, snapshot, ptz, presets and WS-Discovery) - standardized interfaces for IP cameras.
- ONVIF server (with support for stream, snapshot, ptz, presets, events and WS-Discovery) - standardized interfaces for IP cameras.
- Snapshot service - allows to get a jpg with a web request.
- http://IP-CAM/cgi-bin/snapshot.sh?res=low&watermark=yes (select resolution: low or high, and watermark: yes or no)
- http://IP-CAM/cgi-bin/snapshot.sh (default high without watermark)
- Timelapse feature
- MQTT - Motion detection and baby crying detection through mqtt protocol.
- MQTT events - Motion detection and baby crying detection through mqtt protocol.
- MQTT configuration
- Web server - web configuration interface.
- SSH server - dropbear.
- Telnet server - busybox.
Expand Down Expand Up @@ -200,5 +217,9 @@ If the camera still won't start, try the "Unbrick the cam" procedure https://git
**NOBODY BUT YOU IS RESPONSIBLE FOR ANY USE OR DAMAGE THIS SOFTWARE MAY CAUSE. THIS IS INTENDED FOR EDUCATIONAL PURPOSES ONLY. USE AT YOUR OWN RISK.**

## Donation
If you like this project, you can buy roleo a beer :)
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=JBYXDMR24FW7U&currency_code=EUR&source=url)
If you like this project, you can buy roleo a beer :)

Click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=JBYXDMR24FW7U&currency_code=EUR&source=url) or use the below QR code to donate via PayPal
<p align="center">
<img src="https://github.com/roleoroleo/yi-hack-Allwinner/assets/39277388/670a6b7d-68f8-4d8a-8381-21b6500d9fcb"/>
</p>

0 comments on commit 651806b

Please sign in to comment.