Re: [mh] MisterHouse Docs

Hi Giles,

  Thanks for taking the initiative! The activity recently has been the push I needed to update a few things as well. I still haven’t got my tasmota device yet (was supposed to be here a week ago), but when it arrives I’ll add in support for the S31 power monitoring plug.

  I think updating the docs is overdue, and really appreciate your first cut. Might also be a good time to cull out any old information. I often still use this page to quickly find the proper parameters (http://misterhouse.sourceforge.net/mh.html), ie the fields for time_cron. I don’t know who maintains sourceforge anymore, so would be good to ensure that all that documentation is moved over to git (as you are doing), and ideally the sourceforge stuff is removed to prevent wrong information turning up for users.

To make it easier for documentation, maybe the protocols and interfaces can be combined with the ‘items and their methods’. Its always easier to sustain documentation if there is only one place to make updates. Just a thought.

  I agree speech can use an overall. I’m curious what people are using? I’m still using festival, same version from over 10 years ago. It took some finagling to get it to work on Ubuntu 18.04, I’ll see if I remember what I did. I know some people use Google, however the speech events are such a core part of MH for me that I didn’t want reliance on the cloud for that to work.  I’d be curious what people are using for speech, as working implementations might be the place to start for a speech page update.

> On Dec 31, 2020, at 6:56 AM, Giles Godart-Brown <[email protected]> wrote:
> 
> All
> 
> I'm back in Covid Lockdown again :-(
> 
> So I've started to look at the MisterHouse docs.  
> 
> Here is what I've done over the last couple of days.
> 
> I've created a new landing page at https://github.com/hollie/misterhouse/wiki/GGB-Start-Here <https://github.com/hollie/misterhouse/wiki/GGB-Start-Here>
> I've harvested, coalesced and pointed to existing pages to link off this page, creating new pages where necessary. If there is a naming conflict I've prefixed my version GGB-
> I've created a new structure with the ultimate aim of being able to navigate to what you want without relying so heavily on search, and making it easier for newbies.
> I've made a distinction between 'protocols and interfaces' which will point to instructions on how to implement each and 'items and methods' which is just hoovering up the sourceforge .pm files.
> I've only done a couple of sourceforge files so far (e.g. Generic_Item), there are lots to do I believe.
> I've added a hints and tips page so we can gather input from the community (and maybe roll these into a future release)
> I've found a couple of places where I 'ran out of talent', maybe someone can help;
> 
> The Speech engine page https://github.com/hollie/misterhouse/wiki/Speech-engines <https://github.com/hollie/misterhouse/wiki/Speech-engines> is very out of date
> A couple of windows questions-
> the Windows install looks very daunting (https://github.com/hollie/misterhouse/wiki/WindowsPerl5.12 <https://github.com/hollie/misterhouse/wiki/WindowsPerl5.12>) is it really this hard?
> When you start on windows, where do you set the mh.private.ini location? I need this for the installation screen (https://github.com/hollie/misterhouse/wiki/Installation <https://github.com/hollie/misterhouse/wiki/Installation>)
> Next steps
> Take direction from the community on what I should fix/change
> Adding the missing item definitions from sourceforge
> Clean up the protocols and interfaces to link to the existing wiki pages and create new placeholders for missing ones.
> Fix broken links
> Looking forward to input from you all
> 
> Happy New Year
> 
> Giles
> 
> p.s. 'then I ran out of talent' is a famous quote from a rally car driver after he'd crashed! - G
> 
> 
> 
> 
> 
> ________________________________________________________
> To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users
>

________________________________________________________
To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users