TheBackShed.com

Forum Index : Microcontroller and PC projects : CMM2 Manual Errata

Page 5 of 6

Author

Message

Geoffg

Guru

Joined: 06/06/2011
Location: Australia
Posts: 3165

Posted: 03:39am 09 Aug 2020

Copy link to clipboard

Print this post

Thanks guys, I will make the changes.

I have heard for and against arguments regarding merging commands and functions with most preferring it the way that it is. I guess that it depends on how your head is wired!

I don't distribute the source to the manual because I don't want hacked versions of it floating around. That would just cause havoc. I can send you the source to the manual (in Word format) for your own use. Send me an email to projects@geoffg.net.

Geoff

Geoff Graham - http://geoffg.net

Chopperp

Guru

Joined: 03/01/2018
Location: Australia
Posts: 1032

Posted: 04:51am 09 Aug 2020

Copy link to clipboard

Print this post

Geoffg said I have heard for and against arguments regarding merging commands and functions with most preferring it the way that it is. �I guess that it depends on how your head is wired!
Geoff

I've always wondered why they are separated. Thought that there must be a valid reason for it.

I would preferred them all in one list. That's how my head is wired (although some may say that my head is not wired at all)

Can get confusing at times trying to decide if something is a command or a function.

Brian

ChopperP

capsikin
Guru

Joined: 30/06/2020
Location: Australia
Posts: 341

Posted: 10:40am 22 Aug 2020

Copy link to clipboard

Print this post

Manual for 5.05.04:

Quote SPRITE(X, [#]n) Returns the X-coordinate of sprite n. This function is only active when the sprite is currently displayed (active). Returns 10000 otherwise.

Looks like it returns -1 for sprite numbers that are not active now, so it would be:

Quote SPRITE(X, [#]n) Returns the X-coordinate of sprite n. This function is only active when the sprite is currently displayed (active). Returns -1 otherwise.

Same for Y:

Quote
SPRITE(Y, [#]n) Returns the Y-coordinate of sprite n. This function is only active when the sprite is currently displayed (active). Returns -1 otherwise.

Also it wasn't previously specified for L, but it would be good to add:

Quote
SPRITE(L, [#]n) Returns the layer number of active sprites number n. Returns -1 if the sprite is not active.

Andrew_G
Guru

Joined: 18/10/2016
Location: Australia
Posts: 840

Posted: 07:19am 13 Sep 2020

Copy link to clipboard

Print this post

Geoff,
I hope this isn't too old a thread but I have two suggestions re the manuals for your consideration and adjudication:
1. is it possible to not use "Page" on the footers (but say "P" or "Pg" etc) so that searching on "PAGE" is more meaningful?
2. this one is harder and you may consider it too time consuming or better left until changes slow down a little more - with people now printing hard-copies of the manuals is it possible to use track changes or list the pages that need to be replaced because of minor changes? For major new releases we'd need to do a full re-print but some corrections could be hand done (like a marine chart) or loose-leaf pages replaced.

Many thanks,

Andrew

vegipete

Guru

Joined: 29/01/2013
Location: Canada
Posts: 1082

Posted: 08:23am 13 Sep 2020

Copy link to clipboard

Print this post

capsikin said Manual for 5.05.04:

Quote SPRITE(X, [#]n) Returns the X-coordinate of sprite n. This function is only active when the sprite is currently displayed (active). Returns 10000 otherwise.

Looks like it returns -1 for sprite numbers that are not active now, so it would be:

If it returns -1 when a sprite is NOT active then that might be a bug, as I believe -1 is a valid sprite coordinate.

Visit Vegipete's *Mite Library for cool programs.

matherp
Guru

Joined: 11/12/2012
Location: United Kingdom
Posts: 8592

Posted: 09:04am 13 Sep 2020

Copy link to clipboard

Print this post

The manual is correct for the sprite(x)and sprite(Y) functions. The code is wrong. Will fix in the next beta. I seem to remember changing it to -1 to be consistent but vegipete is correct that -1 is a valid value.

capsikin
Guru

Joined: 30/06/2020
Location: Australia
Posts: 341

Posted: 10:06am 13 Sep 2020

Copy link to clipboard

Print this post

matherp said The manual is correct for the sprite(x)and sprite(Y) functions. The code is wrong. Will fix in the next beta. I seem to remember changing it to -1 to be consistent but vegipete is correct that -1 is a valid value.

Okay.

It wasn't too bad how it was, as I checked SPRITE(L, [#]n) to see if the sprite is active. I think that will still work after you fix it.

Chopperp

Guru

Joined: 03/01/2018
Location: Australia
Posts: 1032

Posted: 01:26pm 13 Sep 2020

Copy link to clipboard

Print this post

Andrew_G said Geoff,
I hope this isn't too old a thread but I have two suggestions re the manuals for your consideration and adjudication:

2. this one is harder and you may consider it too time consuming or better left until changes slow down a little more - with people now printing hard-copies of the manuals is it possible to use track changes or list the pages that need to be replaced because of minor changes? For major new releases we'd need to do a full re-print but some corrections could be hand done (like a marine chart) or loose-leaf pages replaced.

Many thanks,

Andrew

A YES PLEASE vote from me on this

Brian

ChopperP

Geoffg

Guru

Joined: 06/06/2011
Location: Australia
Posts: 3165

Posted: 01:52pm 13 Sep 2020

Copy link to clipboard

Print this post

Andrew_G said 1. is it possible to not use "Page" on the footers (but say "P" or "Pg" etc) so that searching on "PAGE" is more meaningful?

Not sure on that one. You do know that the PDF is indexed? It makes it easy to locate the command that you are looking for.

Andrew_G said 2. this one is harder and you may consider it too time consuming or better left until changes slow down a little more - with people now printing hard-copies of the manuals is it possible to use track changes or list the pages that need to be replaced because of minor changes? For major new releases we'd need to do a full re-print but some corrections could be hand done (like a marine chart) or loose-leaf pages replaced.

In part this is the responsibility of the change log (ie, to alert users to changes which are also recorded in the manual). However I will have a crack at implementing change bars in the margins, at least while there is rapid change.

Geoff

Geoff Graham - http://geoffg.net

capsikin
Guru

Joined: 30/06/2020
Location: Australia
Posts: 341

Posted: 12:53am 20 Sep 2020

Copy link to clipboard

Print this post

Not an error exactly, just missing information.

The command entry for PAGE SCROLL doesn't say what direction it scrolls. It's the same as SPRITE SCROLL.

Quote 'x' pixels to the right and 'y' pixels up

I found it confusing until I checked the other command, because it's moves to a larger x but a smaller y.

Womble

Senior Member

Joined: 09/07/2020
Location: United Kingdom
Posts: 267

Posted: 01:21am 20 Sep 2020

Copy link to clipboard

Print this post

I'm not sure how fast the manual keeps up with Peters rapid fire beta updates but ...

In the download for V5.05.06b9 the manual is specified for "MMBasic Ver 5.05.05" on page 1.

Also, MODE command listing on page 73 makes no mention of MODE 11 or MODE 12

And the "release_notes" text file is "V5.05.05_release_notes.txt" but only mentions changes up to V5.05.04

I assume this is due to the "beta" nature of the download, and the rapid changes

Many Thanks Peter, Geoff and the team for all your good work.

Womble

EDIT: CMM2_Current_Bug_List.txt seems to be obsolete too
Edited 2020-09-20 11:23 by Womble

TassyJim

Guru

Joined: 07/08/2011
Location: Australia
Posts: 5911

Posted: 02:06am 20 Sep 2020

Copy link to clipboard

Print this post

readme.txt has the changes found in the beta versions.
The manual etc are only updated once the firmware goes out of beta.

Jim

VK7JH
MMedit MMBasic Help

Womble

Senior Member

Joined: 09/07/2020
Location: United Kingdom
Posts: 267

Posted: 05:16am 20 Sep 2020

Copy link to clipboard

Print this post

TassyJim said readme.txt has the changes found in the beta versions.
The manual etc are only updated once the firmware goes out of beta.

Jim

Thanks Jim, I thought that might be the case, but posted just in case

vegipete

Guru

Joined: 29/01/2013
Location: Canada
Posts: 1082

Posted: 10:11pm 27 Jan 2021

Copy link to clipboard

Print this post

A few things:
(most recent CMM2 manual as of Jan 27,2021, as far as I can tell.)

In the command

LINE INPUT #nbr,string-variable$

the pound sign (#) appears to be mandatory, not optional. Perhaps that fact could be highlighted better in the text?

Could the pages available table on the bottom of page 81 include the resolution, maybe in brackets after the mode number? Ie: 1 (800x600) 2 (640x400) etc.

Some commands/functions are missing from the bookmark list:
GUI commands, HELP, PIXEL(), CONTROLLER, DRAW3D (although no details in manual yet anyways)
The bookmarks for IMAGE ... are a bit munged too.
SPRITE(V,...) appears twice
MOUSE and OPTION MOUSE are completely absent

MATH( - simple statistics -) descriptions are misaligned

===========
There are so many awesome (new) features in CMM2Basic but the peanut upon my shoulders cannot remember them all so the manual has to be as good as possible to compensate. The manual is pretty dang good, but the peanut is worse.

Visit Vegipete's *Mite Library for cool programs.

Geoffg

Guru

Joined: 06/06/2011
Location: Australia
Posts: 3165

Posted: 12:56am 28 Jan 2021

Copy link to clipboard

Print this post

Thanks Pete, the manual is updated with each new stable release so expect these to be folded in then.
Geoff

Geoff Graham - http://geoffg.net

Turbo46

Guru

Joined: 24/12/2017
Location: Australia
Posts: 1593

Posted: 04:29am 06 Feb 2021

Copy link to clipboard

Print this post

Under CONTROLLER MOUSE ... (Page 63)

Quote CONTROLLER MOUSE CLOSE will close the Nunchuk port 'n'. If the
parameter is omitted channel 2 is closed.

Nunchuk should read Mouse.

Bill

Keep safe. Live long and prosper.

vegipete

Guru

Joined: 29/01/2013
Location: Canada
Posts: 1082

Posted: 08:14pm 22 Mar 2021

Copy link to clipboard

Print this post

Is there a complete list of recognized named colours?

Page 29 of the manual lists:
white, black, blue, green, cyan, red, magenta, yellow, brown and grey, plus NOTBLACK.

But 'orange' works also. Are there any others? Could we have 'purple' too? (Approx #99)
Edited 2021-03-23 06:17 by vegipete

Visit Vegipete's *Mite Library for cool programs.

TassyJim

Guru

Joined: 07/08/2011
Location: Australia
Posts: 5911

Posted: 08:50pm 22 Mar 2021

Copy link to clipboard

Print this post

vegipete said Is there a complete list of recognized named colours?

Page 29 of the manual lists:
white, black, blue, green, cyan, red, magenta, yellow, brown and grey, plus NOTBLACK.

But 'orange' works also. Are there any others? Could we have 'purple' too? (Approx #99)

#define BLACK RGB(0, 0, 0, 0)
#define BLUE RGB(0, 0, 255, 15)
#define GREEN RGB(0, 255, 0, 15)
#define CYAN RGB(0, 255, 255, 15)
#define RED RGB(255, 0, 0, 15)
#define MAGENTA RGB(255, 0, 192, 15)
#define YELLOW RGB(255, 255, 0, 15)
#define BROWN RGB(0xA5, 0x2a, 0x2a, 15)
#define GRAY RGB(64, 64, 64, 15)
#define LITEGRAY RGB(128, 128, 128, 15)
#define WHITE RGB(255, 255, 255, 15)
#define ORANGE RGB(0xff, 0xA5, 0, 15)
#define PINK RGB(0xFF, 0xA0, 0xAB, 15)
#define GOLD RGB(0xFF, 0xD7, 0x00, 15)
#define SALMON RGB(0xFA, 0x80, 0x72, 15)
#define BEIGE RGB(0xF5, 0xF5, 0xDC, 15)
#define NOTBLACK (VideoColour==8? RGB(0,32, 0,15): (VideoColour==12? RGB(16,16,16,15): RGB(0,4,0,15)))

Jim

VK7JH
MMedit MMBasic Help

vegipete

Guru

Joined: 29/01/2013
Location: Canada
Posts: 1082

Posted: 10:53pm 22 Mar 2021

Copy link to clipboard

Print this post

Fascinating. You've taken the table from source code, by the looks of it. But not for a CMM2?

'LITEGRAY' is unknown on my CMM2. Instead, 'LIGHTGRAY' works.
And BEIGE goes into memory as colour number 255, even though RGB(BEIGE) <> RGB(WHITE).

Short program to show colours:

' Quicky to show 8 bit mode palette colours, along with named colours.
cls
addr = MM.INFO(PAGE ADDRESS 0)
?
pixel 0,0,rgb(BLACK ) : ? "BLACK " peek(byte addr)
pixel 0,0,rgb(NOTBLACK ) : ? "NOTBLACK " peek(byte addr)
pixel 0,0,rgb(BLUE ) : ? "BLUE " peek(byte addr)
pixel 0,0,rgb(GREEN ) : ? "GREEN " peek(byte addr)
pixel 0,0,rgb(CYAN ) : ? "CYAN " peek(byte addr)
pixel 0,0,rgb(RED ) : ? "RED " peek(byte addr)
pixel 0,0,rgb(MAGENTA ) : ? "MAGENTA " peek(byte addr)
pixel 0,0,rgb(YELLOW ) : ? "YELLOW " peek(byte addr)
pixel 0,0,rgb(BROWN ) : ? "BROWN " peek(byte addr)
pixel 0,0,rgb(GRAY ) : ? "GRAY " peek(byte addr)
pixel 0,0,rgb(LIGHTGRAY) : ? "LIGHTGRAY" peek(byte addr)
pixel 0,0,rgb(WHITE ) : ? "WHITE " peek(byte addr)
pixel 0,0,rgb(ORANGE ) : ? "ORANGE " peek(byte addr)
pixel 0,0,rgb(PINK ) : ? "PINK " peek(byte addr)
pixel 0,0,rgb(GOLD ) : ? "GOLD " peek(byte addr)
pixel 0,0,rgb(SALMON ) : ? "SALMON " peek(byte addr)
pixel 0,0,rgb(BEIGE ) : ? "BEIGE " peek(byte addr)

for y = 0 to 15
for x = 0 to 15
box 120+x*40,y*35,40,35,1,,map(y*16+x)
text 122+x*40,2+y*35,str$(y*16+x)
next x
next y

Visit Vegipete's *Mite Library for cool programs.

TassyJim

Guru

Joined: 07/08/2011
Location: Australia
Posts: 5911

Posted: 11:19pm 22 Mar 2021

Copy link to clipboard

Print this post

vegipete said Fascinating. You've taken the table from source code, by the looks of it. But not for a CMM2?

Taken from CMM2 V5.06
Perhaps Peter has fixed the spelling of LITEGRAY in V5.7beta

VK7JH
MMedit MMBasic Help

Page 5 of 6

Print this page