diff --git a/README.md b/README.md index 5dade27..52a7448 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ ## Why this `YI-HACK-V5` firmware? -The answer is simple: missing updates, RTSP and not based on the latest stock firmware (which features improvements and new cool stuff). -Besides, there were no updates to Yi-Hack-V4, and I am really against that RTSP licensing model. I have contributed enough and will continue my work separately. +The answer is simple: missing updates, RTSP, and not based on the latest stock firmware (which features improvements and new cool stuff). +Besides, there were no updates to `yi-hack-v4`, and I am against that RTSP licensing model. I have contributed enough and will continue my work separately. I am slowly releasing beta versions, and I can see lots of downloads, testing and contributions. A big thank you to the community. @@ -32,7 +32,7 @@ This firmware will add the following features: - **NEW FEATURES** - **NEW CAMERAS SUPPORTED**: Yi Outdoor 1080p and Yi Cloud Dome 1080p. - - **RTSP server** - which will allow a RTSP stream of the video while keeping the cloud features enabled (available to all and its free). + - **RTSP server** - which will allow an RTSP stream of the video while keeping the cloud features enabled (available to all and it is free). - **MQTT** - detect motion directly from your home server! - WebServer - user-friendly stats and configurations. - SSH server - _Enabled by default._ @@ -48,17 +48,17 @@ This firmware will add the following features: - rotate - PTZ support through a web page. - Snapshot feature - - Proxychains-ng - _Disabled by default. Useful if the camera is region locked._ + - Proxychains-ng - _Disabled by default. Useful if the camera is region-locked._ - The possibility to disable all the cloud features while keeping the RTSP stream. ## Supported cameras -Currently this project supports the following cameras: +Currently, this project supports the following cameras: - Yi 1080p Home 48US - confirmed - Yi 1080p Home 20US - confirmed - Yi Home 17CN / 27US / 47US - confirmed -- Yi Dome - confirmed, but heavy performance issues with Snapshot and ONVIF is killing the CPU +- Yi Dome - confirmed, but heavy performance issues with Snapshot and ONVIF are killing the CPU - Yi 1080p Dome - confirmed; however, I have no device to test - Yi 1080p Cloud Dome - confirmed; however, I have no device to test - Yi 1080p Outdoor - confirmed; however, I have no device to test @@ -66,14 +66,14 @@ Currently this project supports the following cameras: ## Getting Started 1. Check that you have a correct Xiaomi Yi camera. (see the section above) -2. Get an microSD card, preferably of capacity 16gb or less and format it by selecting File System as FAT32. +2. Get a microSD card, preferably of capacity 16 GB or less and format it by selecting File System as FAT32. **_IMPORTANT: The microSD card must be formatted in FAT32. exFAT formatted microSD cards will not work._** -**I have not formatted any of my 32GB cards in order to load the firmware. Just copy files directly and it should work.** +**I have not formatted any of my 32GB cards to load the firmware. Just copy files directly and it should work.**
(Click) How to format microSD cards > 32GB as FAT32 in Windows 10

-For microSD cards larger than 32 GB, Windows 10 only gives you the option to format as NTFS or exFAT. You can create a small partition (e.g 4 GB) on a large microSD card (e.g. 64 GB) to get the FAT32 formatting option. +For microSD cards larger than 32 GB, Windows 10 only gives you the option to format as NTFS or exFAT. You can create a small partition (e.g. 4 GB) on a large microSD card (e.g. 64 GB) to get the FAT32 formatting option. * insert microSD card into PC card reader * open Disk Management (e.g. Win+x, k) @@ -81,7 +81,7 @@ For microSD cards larger than 32 GB, Windows 10 only gives you the option to for * right click each partition > "Delete Volume..." * repeat until there are no partitions on the card * Disk Management: create a new FAT32 partition - * right click on "Unallocated" > "New Simple Volume..." + * Right-click on "Unallocated" > "New Simple Volume..." * Welcome to the New Simple Volume Wizard: click "Next" * Specify Volume Size: 4096 > "Next" * Assign Drive Letter or Path: (Any) > "Next" @@ -101,7 +101,7 @@ Alternative way: * open cmd with admin permissions * run diskpart * type "list disk" -* find your sd card (for example Disk 7) +* find your SD card (for example Disk 7) * type "select disk 7" * if it has one partition - type "select partition 1". If more - delete all the partitions and then create one * type "format FS=FAT32 QUICK" @@ -109,7 +109,7 @@ Alternative way:

-3. Get the correct firmware files for your camera from this link: https://github.com/alienatedsec/yi-hack-v5/releases +3. Get the correct firmware files for your camera from the latest baseline release link: https://github.com/alienatedsec/yi-hack-v5/releases/tag/0.3.8 | Camera | rootfs partition | home partition | Remarks | | --- | --- | --- | --- | @@ -120,11 +120,11 @@ Alternative way: | **Yi 1080p Cloud Dome** | rootfs_y19 | home_y19 | Firmware files required for the Yi 1080p Cloud Dome camera. | | **Yi Outdoor** | rootfs_h30 | home_h30 | Firmware files required for the Yi Outdoor camera. | -4. Save both files and the `yi-hack-v5` folder on root path of microSD card. +4. Save both files (rootfs_xx and home_xx), and the `yi-hack-v5` folder on the root path of the microSD card. -**_IMPORTANT: Make sure that the filename stored on microSD card are correct and didn't get changed. e.g. The firmware filenames for the Yi 1080p Dome camera must be home_h20 and rootfs_h20._** +**_IMPORTANT: Make sure that the filenames stored on the microSD card are correct and didn't get changed. e.g. The firmware filenames for the Yi 1080p Dome camera must be home_h20 and rootfs_h20._** -5. Remove power to the camera, insert the microSD card, turn the power back ON. +5. Remove power to the camera, insert the microSD card, and turn the power back ON. 6. The yellow light will come ON and flash for roughly 30 seconds, which means the firmware is being flashed successfully. The camera will boot up. @@ -132,15 +132,15 @@ Alternative way: 8. Blue light should come ON indicating that your WiFi connection has been successful. -9. Go in the browser and access the web interface of the camera as a website. +9. Go into the browser and access the web interface of the camera as a website. Depending upon your network setup, accessing the web interface with the hostname **may not work**. In this case, the IP address of the camera has to be found. -This can be done from the App. Open it and go to the Camera Settings --> Network Info --> IP Address. +This can be done from the App. Please open the app, and go to the Camera Settings --> Network Info --> IP Address. -Access the web interface by entering the IP address of the came in a web browser. e.g. http://192.168.1.5:8080 +Access the web interface by entering the IP address of the camera in a web browser. e.g. `http://192.168.1.5:8080` -**_IMPORTANT: If you have multiple cameras. It is important to configure each camera with a unique hostname. Otherwise the web interface will only be accessible by IP address._** +**_IMPORTANT: If you have multiple cameras. It is important to configure each camera with a unique hostname. Otherwise, the web interface will only be accessible by IP address._** 10. Done! You are now successfully running yi-hack-v5! @@ -149,11 +149,11 @@ _TO DO - (It happened a few times and it's often possible to recover from it)_ ## Troubleshooting -### Wifi is connected, the camera responds to ping but I'm not able to connect to the web interface -Verify that you did not forget to upload `yi-hack-v5` folder to the SD card when uploading firmware. If you did, upload it and restart the camera. +### Wi-Fi is connected, and the camera responds to ping but I'm not able to connect to the web interface +Verify that you did not forget to upload the `yi-hack-v5` folder to the SD card when uploading firmware. If you did, upload it and restart the camera. -### Cannot complete the pairing / wifi settings lost after reboot -Make sure that you are using the correct app (Yi Home) to setup the wifi connection. For example, the "Xiaomi Home" app will also generate the correct QR code that will work with your camera for initial connection, but then after power is removed +### Cannot complete the pairing/wifi settings lost after reboot +Ensure you are using the correct app (Yi Home) to set up the wifi connection. For example, the "Xiaomi Home" app will also generate the correct QR code that will work with your camera for the initial connection, but then after power is removed the settings will be lost. ## Introducing pre-releases