mindaptiv / foster

Grabs system and user information in a UWP/Windows 10 context.

Foster

##Abstract Grabs system and user information in a UWP (Universal Windows Platform) context.

##Goal Foster is a UWP/Windows 10/Windows Store targeted library for gathering both user and system information for the current Win RT device. In order to be compatible with all UWP devices (including Surface, IoT, desktop, Xbox, Phone), Foster only makes use of traditional Win32 calls that are supported by UWP. The final version of this library will gather as much information as it can to create a profile for the logged in user with their account name and avatar, as well as in-depth stats on the hardware and system settings for their device. This profile information will be stored in a struct that can be exported and utilized by other applications.

##Capabilities (AKA App Permissions) Used Your App's package.appxmanifest file will need the following to function properly with the methods defined in Foster.cpp

• Internet (Client)
• Removable Storage
• User Account Information

##API Contracts Used Foster makes use of the following UWP API contracts:

• Windows.Foundation.FoundationContract
• Windows.Foundation.UniversalApiContract
• Windows.UserProfile.UserProfileContract
• Windows.Devices.Portable.PortableDeviceContract

##Documentation For more detailed documentation visit www.github.com/mindaptiv/Foster/wiki

##Contact [email protected]

foster's Issues

Test Image

test

Create pointerStruct

Subtask of #40

Structure for handling pointer devices specifically.

Grab XInput Gamepads

Split from #36

Grab and store device metadata in controllerStruct(s) for any attached gamepads that support XInput.

Status Update 2/19

Status Update 3/2

Refactor test code

Refactor how debugging text is built based on new global struct from #29

Grab User Image

Retrieve user profile image (if it exists).

Status Update 2/11

Status update 3/3

Grab RAM specs

CURRENT REQUIREMENTS:
-return minimum supported RAM size for WinRT

OLD REQUIREMENTS:
-make
-model
-size in bytes as unsigned 64 bit int
-speed 32 bit float in hz
-additional L1/L3 cache information

Make controller index 0 if not controller

Minor fix to pre-existing code to prevent null/unassigned data

Fix comments in produceDeviceTypeInfo()

Status Update 2/12

Grab HID Devices

Grab information on USB controllers (where possible) and store their metadata.

Determine Necessary CPU Info

What members of this struct do we want to retain?
https://msdn.microsoft.com/en-us/library/windows/desktop/ms724958%28v=vs.85%29.aspx

Status Update 3/4

Change DST Values

Reassign value definitions to better fit with "0 is error code" convention.

Convert Variables

-Convert string/wstring to utf8
-Convert various integer types to appropriate for export

Setup wiki

Handle Empty Machine Names

Produce error checking code if returned machine name is empty utilizing "0 is error code".

Grab Color Profile for Display Devices

Split from #6
Retrieve additional color profile information for display devices.

References:
DisplayInformation Class:
https://msdn.microsoft.com/en-us/library/windows/apps/windows.graphics.display.displayinformation

Get Color Profile Method:
https://msdn.microsoft.com/en-us/library/windows/apps/windows.graphics.display.displayinformation.getcolorprofileasync

Add Error Month

Add error value for months that do not fall between 1-12.

Status Update 3/6

Change Day Values

Reassign integer definitions for days of the week to better fit with "0 is error code" convention.

Add debug struct to local test code

Create global debugStruct in test DX program to test Foster functionality with.

Status Update 3/5

Hey Jake,

1. Got my 360 Controllers set aside here to take in tomorrow to test XInput with.
2. We're now grabbing Keyboard presence in Foster.
3. Implemented structs for the various HID types we're trying to track.
4. PointerDevices did not work as expected. When enumerating even with three mice attached my Vector was only returning with one device. I wondered if I was implementing something wrong, so I downloaded MS's sample and I was getting the same results with half a dozen different mice. The types in the breakpoint I was receiving were also a little perplexing. Instead of getting a PointerDevice object I was getting a PointerDeviceServer object, which I can't find in the documentation anywhere. Additionally, the type of the device according to the debugger was POINTER_DEVICE_TYPE_MAX (-1), which a. is an invalid value, b. is only supposed to be returned when I'm coding with the desktop version of this particular class, and c. is not actually being interpreted as POINTER_DEVICE_TYPE_MAX by MS's code (the if logic always goes into the if (value == 1) case, and if I add an if (value == -1), it never goes into that case). Supppper confusing at the time, but I believe that Visual Studio has somehow loaded the Desktop version of the symbols in the debugger rather than the Windows Store versions. Despite multiple efforts, and changes, was not able to get it to detect multiple pointers. Since I'm not sure I can trust the rest of the information being returned at this point in time, I'm going to try to use MouseCapabilities instead, which detects the presence of a mouse, and properties of all the available mice pooled together in one class.

Thanks,
Josh

Create device structure

Create platform agnostic structure for handling device metadata.

Grab Keyboard

Split from #36

Grab CPU Hertz Estimate

Posix example:
size_t length;
int mib[6];
int result;

mib[0] = CTL_HW;
mib[1] = HW_CPU_FREQ;
length = Tbytes_u( result );

if( sysctl(mib, 2, &result, &length, NULL, 0 ) < 0 )
{
Log( "Err:getting cpu frequency\n" ); return;
}
Log( "CPU Frequency = %d hz\n", result );

Grab Available Device Information

Retrieve relevant data available for:
-Storage Devices
--Total size
--Free size
-USB Devices
--Controllers, etc.
-Screens
--Make
--Model
--Refresh rate
--Resolution
--Color profile
-Speakers
-Cameras (non depth-sensing)
-Microphones

Device Properties Expected:

1. Unique ID
2. Name
3. Enabled?
4. Default?
5. Icon
6. Physical Device Location

Add 6 basic inputs

Up, Down, Left, Right, Enter, Esc, or equivalent

Add code to testing project (NOT FOR repo push!)

Detect 32 vs. 64 bit OS

Will be used to provide an additional piece of data about system as well as act as a switch for returning minimum values for items like RAM size.

Status Update 2/20

Keep getter functions?

The getter functions were mostly a holdover from school-project habits, they just return the member variable of a given cylonStruct (getUsername(tory) returns the username of tory instead of calling tory.username, etc.). Since I have to refactor the way I'm building labels in DirectX to get data from the new global debugStruct (see #30), now would be a good time to remove them as that is the only place in code they are being called.

Grab CPU specs

-make as utf8
-model as utf8
-no. of cores as unsigned 64-bit int
-speed in hz as 32-bit float

Create HID Structs

Sub task of #36. Create an additional struct def for HID devices.

Cleanup refactoring leftovers

Remove some no longer necessary debug statements and variables from earlier refactoring.

Status Update 2/24

Test

test

Grab pooled mouse properties

Split from #36

Create producer for filling cylonStruct's member mice mouseStruct to replace producePointerInformation()

Handle Empty Usernames

Check length of wUsername and set to "0" if empty to better fit with "0 is error code" convention.

Create mouseStruct

Singular struct for use by a cylonStruct for holding pooled mouse properties to replace pointerStruct.

Split from #36

Status Update 2/23

2/10 Status Update

Add Error Date

Add error value for dates that do not fall between 1-31.

Create controller struct

Split from #36

Create a struct for handling data from XInput gamepads.

Set Jake up w/ Git Bash

@Simulacrum0
http://git-scm.com/downloads

Status Update 2/26

Status Update 2/27

Status Update 2/25