Skip to content

Refactor Windows documentation - #12013

Merged
Nir-Az merged 7 commits into
realsenseai:developmentfrom
Tamir91:refactor-windows-documentation
Sep 10, 2023
Merged

Refactor Windows documentation#12013
Nir-Az merged 7 commits into
realsenseai:developmentfrom
Tamir91:refactor-windows-documentation

Conversation

@Tamir91

@Tamir91 Tamir91 commented Jul 18, 2023

Copy link
Copy Markdown
Contributor

Tracked on [LRS-832].

1. A title was changed.
2. A Cmake screenshot was changed.
2. Block with Windows 8.1 removed.
Comment thread doc/installation_windows.md Outdated
**Note:** Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not recommend or support installation in a VM.

librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017:
librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017 / 2019:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2022 as well

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please verify the minimum cmake version , I dont think it's 3.8 today

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please verify the minimum cmake version , I dont think it's 3.8 today

I scanned entire repo and found that a lowest CMake version is 2.8.3. (third party dependency)
So I need write 2.8.3 in the guide?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which 3-rd party? seems too low.

@Tamir91 Tamir91 Jul 19, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C:\Users\tyurovs\repos\librealsense\src\gl\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.9...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\libusb\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.3)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\CMakeLists.txt (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.9...3.20.5)
C:\Users\tyurovs\repos\librealsense\tools\rosbag-inspector\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.3...3.20.5)

C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\console_bridge\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\cpp_common\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\rosbag_storage\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roscpp_serialization\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roscpp_traits\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roslz4\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\rostime\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure someone use those cmake files, I bet not.


## Windows 8.1:
When working on Windows 8.1, make sure you have [KB3075872](https://support.microsoft.com/en-us/kb/3075872) and [KB2919355](https://support.microsoft.com/en-us/kb/2919355) installed. These patches are addressing issues specific to 8.1 video drivers, that were later resolved in Windows 10.
Don't forget to check `BUILD_EXAMPLES` if you wish to use librealsense samples.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Down in the document please update according to this:
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11
The winver image needs to change too

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows 10 SDK version 1809 | 10.0.17763.0 is being validated by RS.
Lets write only this
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11

Instead of both and give this screenshot
image

Thanks

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A build number and screenshot updated.

@mengyui

mengyui commented Jul 19, 2023

Copy link
Copy Markdown
Contributor

one more thing, please check the option"Allow desktop apps to access your camera" should be turned on in Setting -> Privacy -> Camera for Windows.
the default value is on.

Comment thread doc/installation_windows.md Outdated
**Note** In case of multiple WinSDK version installed, CMake automatically selects the latest version of SDK. In some cases, however, the automatic selection may fail. Then you need to manually retarget the solution for the proper WinSDK version:
![win_retarget_platform](./img/win_retarget_platform.png)

**Note** Turn on "Allow desktop apps to access your camera" in Windows OS (Setting -> Privacy -> Camera). No newline at end of file

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the camera is not recognized by the SDK, make sure that "Allow desktop apps to access your camera" setting is set to on in Windows OS (Setting -> Privacy -> Camera)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@Tamir91

Tamir91 commented Jul 25, 2023

Copy link
Copy Markdown
Contributor Author

@Nir-Az

Nir-Az commented Jul 25, 2023

Copy link
Copy Markdown
Collaborator

The WinSDK is 10 (10.0.15063) according: https://www.intel.com/content/www/us/en/support/articles/000028594/emerging-technologies/intel-realsense-technology.html image

This was wriiten at May/2018.
We beed to gound out the current minimak WinSDK

winver png updated
issue table created
windows build number updated
Comment thread doc/installation_windows.md Outdated
**Note:** Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not recommend or support installation in a VM.

librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017:
librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017 / 2019 / 2022:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove 2015

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also we know Cmake 3.8 is not supported, we need to make sure which one is supported and list it

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also we know Cmake 3.8 is not supported, we need to make sure which one is supported and list it

According the test that we performed CMake 3.14 is minimal supported version.
Are you think we need perform other test to validate it? Maybe, install CMake 3.13 locally and build?

@Tamir91
Tamir91 requested a review from Nir-Az August 9, 2023 08:19
@Tamir91

Tamir91 commented Aug 29, 2023

Copy link
Copy Markdown
Contributor Author

Added GHA test #12118 that checks minimal CMake supporting version on Linux.

@Nir-Az
Nir-Az requested a review from maloel August 29, 2023 19:41
@Nir-Az

Nir-Az commented Aug 29, 2023

Copy link
Copy Markdown
Collaborator

@maloel can you help review + spell check?

Comment thread doc/installation_windows.md Outdated
Comment thread doc/installation_windows.md Outdated
@Tamir91
Tamir91 requested a review from maloel August 30, 2023 05:49
@maloel

maloel commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

Looks good from my side

@Nir-Az
Nir-Az merged commit de02cbb into realsenseai:development Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants