search

aforty / sabnzbd-knockstrap

An interface/theme for SABnzbd
58 stars 19 forks source link

Show disk space and other stats #10

Open aforty opened 11 years ago

aforty commented 11 years ago

Somewhere, and hidden by default, should be a nice clean way to view certain stats that are available through the SABnzbd API. Thinking there has to be a way to display these rich and visual way that provides value at a glance but details upon inspect, not a boring table with labels and text stats.

btsuhako commented 11 years ago

I've started working on this feature in a branch. The only tricky thing I'm still figuring out is how SABnzbd reports available disk space. The API returns back a number, but I don't know the size metric (KB, MB, GB, TB, etc.). Maybe it's always GB... Here's a screenshot of what I have worked up:

image

aforty commented 11 years ago

Seems like it might always be GB. The API is... not very good :)

You could try looking at the SABnzbd source, that has helped me more often than the documentation (http://wiki.sabnzbd.org/api)

I'm not crazy about it being on the bottom of the page. I always thought this would be a good candidate for a hover-activated overlay/popup/callout.

BeingTomGreen commented 11 years ago

Things like disk space I like to always be able to see :+1:

I have TBs of free space and it does still say xx,xxxGB, but it would be nice if you fixed that so it converted it.

I am fairly sure the API can return HDD info?

aforty commented 11 years ago

I think it may make sense then to be able to permanently dock the stats for those who want them. Something else I've been thinking about for down the line: making all the sections modular and being able to re-order and hide ones you don't want. The stats section could then simply be a module that can be placed on the top or the bottom.

I personally value minimal interfaces that don't show me things unless I want to see them so I would like an option to let's me see it on command (i.e. hover or click somewhere) but I can see how this is pertinent information for others and that those people would always want quick access to it.

I would write a client-side fix for the terrible API that returns pre-formatted values (xx MB, yy.yy GB, etc)

First let's figure out which values are per-formatted and which ones that aren't (diskspace1, diskspace1total, others?). Then have a global sanitation method that spits out bytes/megabytes which can then be formatted to whatever makes the most sense in a given context (using a single knockout binding handler).

Oh man you guys are dragging me back into this, getting kind of psyched to work on this again :+1:

BeingTomGreen commented 11 years ago

Being able to manage modules and their order sounds really cool!

I think they all return in the correct format up until TB?

I would love to help more but I suck at Javascript :cry:

btsuhako commented 11 years ago

Yeah, I like the idea for the user-ordered sections.

There's not a lot of documentation on the API and what each field means. What's the difference between diskspace1 and diskspace2? I have a feeling that one is the total disk storage capacity and the other is the "complete" directory.

I wired up those four stats at the bottom because they're easy and come pre-formatted from the API. If there's a feature need for displaying the disk stats, then writing a formatter sounds like the way to go!

BeingTomGreen commented 11 years ago

I though the 1,2,3 etc were different disks, but thinking about it that doesn't really make sense..